Merge branch 'main' into import-default-iitm

.github/repository-settings.md

@@ -10,22 +10,22 @@ No changes
 
 ## Collaborators and Teams
 
-* There is currently no `javascript-triagers` role
-* `javascript-maintainers` has `Admin` permission
+- There is currently no `javascript-triagers` role
+- `javascript-maintainers` has `Admin` permission
 
 ## Branches
 
 ## Branch protection rules
 
 ### `main`
 
-* Uncheck "Restrict who can push to matching branches"
-* Check "Require merge queue"
-  * Build concurrency: 5
-  * Minimum pull requests to merge: 1 or after 5 minutes
-  * Maximum pull requests to merge: 5
-  * Check "Only merge non-failing pull requests"
-  * Status check timeout: 60 minutes
+- Uncheck "Restrict who can push to matching branches"
+- Check "Require merge queue"
+  - Build concurrency: 5
+  - Minimum pull requests to merge: 1 or after 5 minutes
+  - Maximum pull requests to merge: 5
+  - Check "Only merge non-failing pull requests"
+  - Status check timeout: 60 minutes
 
 ### `dependabot/**/**`
 
@@ -36,10 +36,10 @@ Our dependencies are managed by a bot which creates PRs from a fork.
 
 This is a special branch which we use to publish the automatically generated docs.
 It is exempt from most protections.
- 
-* "Allow force pushes from everyone" (requires write permission)
+
+- "Allow force pushes from everyone" (requires write permission)
 
 ## Pages
 
-* Source: Deploy from a branch
-* Branch: `gh-pages` `/ (root)`
+- Source: Deploy from a branch
+- Branch: `gh-pages` `/ (root)`

.github/workflows/lint.yml

@@ -21,29 +21,14 @@ jobs:
             package-lock.json
           node-version: '20'
 
-      - name: Lint changelog file
-        uses: avto-dev/markdown-lint@v1
-        with:
-          # Commenting due to
-          # https://github.com/avto-dev/markdown-lint/blob/aab9be9823fcd706f6da3e6ad6c64874c23fbd4c/lint/rules/changelog.js#L51-L71
-          # TODO: adhere to, or overwrite above rule and uncomment rules
-          # rules: "/lint/rules/changelog.js"
-          config: "/lint/config/changelog.yml"
-          args: "./CHANGELOG.md"
-
-      - name: Lint markdown files
-        uses: avto-dev/markdown-lint@v1
-        with:
-          args: "./**/*.md"
-          ignore: './CHANGELOG.md ./experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/protos ./experimental/packages/opentelemetry-exporter-metrics-otlp-proto/protos ./packages/exporter-trace-otlp-grpc/protos ./packages/exporter-trace-otlp-proto/protos'
-
       - name: Bootstrap
         run: npm ci
 
       - name: Lint
         run: |
           npm run lint
           npm run lint:examples
+          npm run lint:markdown
 
       - name: Lint doc files
         run: |

.gitignore

@@ -91,3 +91,6 @@ package.json.lerna_backup
 
 # non-aggregated benchmark results
 .benchmark-results.txt
+
+# release notes for release creation
+.tmp/

.markdownlint-cli2.jsonc

@@ -0,0 +1,15 @@
+// https://github.com/DavidAnson/markdownlint-cli2#markdownlint-cli2jsonc
+{
+  "config": {
+    // https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases
+    "MD013": false,
+    "MD024": false,
+    "MD033": false,
+    "MD041": false,
+    "MD026": false,
+    "MD004": { "style": "dash" } // ul-style
+  },
+  "gitignore": true,
+  "noBanner": true,
+  "noProgress": true
+}

CHANGELOG.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD004 -->
 # CHANGELOG
 
 All notable changes to this project will be documented in this file.
@@ -12,7 +13,14 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 ### :rocket: (Enhancement)
 
 * feat: support node 22 [#4666](https://github.com/open-telemetry/opentelemetry-js/pull/4666) @dyladan
-* feat(sdk-trace-node): support `xray` Propagator via `OTEL_PROPAGATORS` environment variable [#4602](https://github.com/open-telemetry/opentelemetry-js/pull/4602) @anuraags
+
+### :bug: (Bug Fix)
+
+### :books: (Refine Doc)
+
+### :house: (Internal)
+
+## 1.24.1
 
 ### :bug: (Bug Fix)
 
@@ -22,10 +30,6 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
   * fixes a circular import warning which would appear in rollup when bundling `@opentelemetry/resources`
 * fix(exporter-metrics-otlp-grpc): add explicit otlp-exporter-base dependency to exporter-metrics-otlp-grpc [#4678](https://github.com/open-telemetry/opentelemetry-js/pull/4678) @AkselAllas
 
-### :books: (Refine Doc)
-
-### :house: (Internal)
-
 ## 1.24.0
 
 ### :rocket: (Enhancement)
@@ -1913,7 +1917,7 @@ No changes
 * `opentelemetry-api`, `opentelemetry-exporter-prometheus`, `opentelemetry-metrics`
   * [#1137](https://github.com/open-telemetry/opentelemetry-js/pull/1137) Batch observer ([@obecny](https://github.com/obecny))
 * `opentelemetry-exporter-collector`
-  * [#1256](https://github.com/open-telemetry/opentelemetry-js/pull/1256) feat: [Collector Metric Exporter][1/x] Rename CollectorExporter to CollectorTraceExporter  ([@davidwitten](https://github.com/davidwitten))
+  * [#1256](https://github.com/open-telemetry/opentelemetry-js/pull/1256) feat: Collector Metric Exporter [1/x] Rename CollectorExporter to CollectorTraceExporter  ([@davidwitten](https://github.com/davidwitten))
 
 ### :rocket: (Enhancement)
 

CONTRIBUTING.md

@@ -247,6 +247,13 @@ cd packages/opentelemetry-module-name
 npm run lint:fix
 ```
 
+Similarly, Markdown files (such as README.md files) can be linted:
+
+```sh
+npm run lint:markdown
+npm run lint:markdown:fix # can automatically fix some Markdown rules
+```
+
 ### Generating docs
 
 We use [typedoc](https://www.npmjs.com/package/typedoc) to generate the api documentation.

README.md

@@ -105,7 +105,7 @@ The above example will emit auto-instrumented telemetry about your Node.js appli
 
 ## Library Author
 
-If you are a library author looking to build OpenTelemetry into your library, please see [the documentation][docs]. As a library author, it is important that you only depend on properties and methods published on the public API. If you use any properties or methods from the SDK that are not officially a part of the public API, your library may break if an [Application Owner](#application-owner) uses a different SDK implementation.
+If you are a library author looking to build OpenTelemetry into your library, please see [the documentation][docs]. As a library author, it is important that you only depend on properties and methods published on the public API. If you use any properties or methods from the SDK that are not officially a part of the public API, your library may break if an application owner uses a different SDK implementation.
 
 ## Supported Runtimes
 
@@ -205,7 +205,7 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
 
 #### Maintainers ([@open-telemetry/javascript-maintainers](https://github.com/orgs/open-telemetry/teams/javascript-maintainers))
 
-- [Amir Blum](https://github.com/blumamir), Keyval
+- [Amir Blum](https://github.com/blumamir), Odigos
 - [Chengzhong Wu](https://github.com/legendecas), Bloomberg
 - [Daniel Dyla](https://github.com/dyladan), Dynatrace
 - [Marc Pichler](https://github.com/pichlermarc), Dynatrace
@@ -252,7 +252,7 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
 #### Thanks to all the people who already contributed
 
 <a href="https://github.com/open-telemetry/opentelemetry-js/graphs/contributors">
-  <img src="https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-js" />
+  <img alt="Repo contributors" src="https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-js" />
 </a>
 
 ## Packages
@@ -349,6 +349,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [otel-web]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-web
 [otel-api]: https://github.com/open-telemetry/opentelemetry-js/tree/main/api
 [otel-core]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-core
-[otel-propagator-b3]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-propagator-b3
 
 [spec-versioning]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md

api/CHANGELOG.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD004 -->
 # CHANGELOG
 
 All notable changes to this project will be documented in this file.
@@ -97,13 +98,13 @@ All notable changes to this project will be documented in this file.
 
 * export tracer options ([#154](https://www.github.com/open-telemetry/opentelemetry-js-api/issues/154)) ([b125324](https://www.github.com/open-telemetry/opentelemetry-js-api/commit/b125324438fb2f24eb80c7c6673afc8cfc99575e))
 
-### [1.0.4](https://www.github.com/open-telemetry/opentelemetry-js-api/compare/v1.0.3...v1.0.4) (2021-12-18)
+## [1.0.4](https://www.github.com/open-telemetry/opentelemetry-js-api/compare/v1.0.3...v1.0.4) (2021-12-18)
 
 ### Bug Fixes
 
 * align globalThis fallbacks with otel-core ([#126](https://www.github.com/open-telemetry/opentelemetry-js-api/issues/126)) ([3507de7](https://www.github.com/open-telemetry/opentelemetry-js-api/commit/3507de7c3b95396696657c021953b0b24a63a029))
 
-### [1.0.3](https://www.github.com/open-telemetry/opentelemetry-js-api/compare/v1.0.2...v1.0.3) (2021-08-30)
+## [1.0.3](https://www.github.com/open-telemetry/opentelemetry-js-api/compare/v1.0.2...v1.0.3) (2021-08-30)
 
 ### Bug Fixes
 

api/README.md

@@ -112,6 +112,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
 [license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/api/LICENSE
-[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
 [docs-tracing]: https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/tracing.md
 [docs-sdk-registration]: https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/sdk-registration.md

api/package.json

@@ -82,14 +82,14 @@
   "devDependencies": {
     "@types/mocha": "10.0.6",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.20",
+    "@types/sinon": "17.0.3",
     "@types/webpack": "5.28.5",
     "@types/webpack-env": "1.16.3",
     "babel-plugin-istanbul": "6.1.1",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
     "dpdm": "3.13.1",
-    "karma": "6.4.2",
+    "karma": "6.4.3",
     "karma-chrome-launcher": "3.1.0",
     "karma-coverage": "2.2.1",
     "karma-mocha": "2.0.1",
@@ -101,10 +101,10 @@
     "mocha": "10.2.0",
     "nyc": "15.1.0",
     "sinon": "15.1.2",
-    "ts-loader": "8.4.0",
+    "ts-loader": "9.5.1",
     "ts-mocha": "10.0.0",
     "typescript": "4.4.4",
-    "unionfs": "4.5.1",
+    "unionfs": "4.5.4",
     "webpack": "5.89.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/api",

doc/contributing/dependencies.md

@@ -25,7 +25,7 @@ An exception is granted for dependencies on `@opentelemetry/api`, which, if used
 
 Packages categorized as third-party and listed under the `"dependencies"` section (e.g., @grpc/grpc-js, @grpc/proto-loader, shimmer, etc.) should remain unpinned and utilize the caret (`^`) symbol. This approach offers several advantages:
 
-* Our users could get bug fixes of those 3rd-party packages easily, without waiting for us to update our library.
-* In cases where multiple packages have dependencies on different versions of the same package, npm will opt for the most recent version, saving space and preventing potential disruptions.
+- Our users could get bug fixes of those 3rd-party packages easily, without waiting for us to update our library.
+- In cases where multiple packages have dependencies on different versions of the same package, npm will opt for the most recent version, saving space and preventing potential disruptions.
 
 It's important to acknowledge that this approach does expose users to potential breaking changes arising from either human error or libraries that do not strictly follow to semver conventions. This trade-off is an inherent aspect of this approach.

doc/sdk-registration.md

@@ -23,6 +23,7 @@ api.propagation.setGlobalPropagator(httpTraceContextPropagator);
 api.context.setGlobalContextManager(asyncHooksContextManager);
 ```
 
+[opentelemetry-js]: https://github.com/open-telemetry/opentelemetry-js
 [trace-api-docs]: https://open-telemetry.github.io/opentelemetry-js/classes/_opentelemetry_api.TraceAPI.html
 [propagation-api-docs]: https://open-telemetry.github.io/opentelemetry-js/classes/_opentelemetry_api.PropagationAPI.html
 [context-api-docs]: https://open-telemetry.github.io/opentelemetry-js/classes/_opentelemetry_api.ContextAPI.html

doc/upgrade-guide.md

@@ -107,7 +107,7 @@ Collector exporter packages and types are renamed:
 
 - All plugins have been removed in favor of instrumentations.
 
-- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header encoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [README][otel-propagator-b3] for full details and usage.
+- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header encoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [README](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-propagator-b3/README.md) for full details and usage.
 
 - Sampling configuration via environment variable has changed. If you were using `OTEL_SAMPLING_PROBABILITY` then you should replace it with `OTEL_TRACES_SAMPLER=parentbased_traceidratio` and `OTEL_TRACES_SAMPLER_ARG=<number>` where `<number>` is a number in the [0..1] range, e.g. "0.25". Default is 1.0 if unset.
 

examples/basic-tracer-node/README.md

@@ -24,13 +24,13 @@ npm start
 
 Open the Jaeger UI in your browser [http://localhost:16686](http://localhost:16686)
 
-<p align="center"><img src="images/jaeger-ui-list.png?raw=true"/></p>
+<p align="center"><img alt="Jaeger UI showing list of traces" src="images/jaeger-ui-list.png?raw=true"/></p>
 
 Select `basic-service` under *Service Name* and click on *Find Traces*.
 
 Click on the trace to view its details.
 
-<p align="center"><img src="./images/jaeger-ui-detail.png?raw=true"/></p>
+<p align="center"><img alt="Jaeger UI showing a trace" src="./images/jaeger-ui-detail.png?raw=true"/></p>
 
 ## Useful links
 

examples/esm-http-ts/package.json

@@ -1,13 +1,14 @@
 {
   "name": "esm-http-ts",
   "private": true,
-  "version": "0.51.0",
+  "version": "0.51.1",
   "description": "Example of HTTP integration with OpenTelemetry using ESM and TypeScript",
   "main": "build/index.js",
   "type": "module",
   "scripts": {
     "build": "tsc --build",
-    "start": "node --experimental-loader=@opentelemetry/instrumentation/hook.mjs ./build/index.js"
+    "start": "node --experimental-loader=@opentelemetry/instrumentation/hook.mjs ./build/index.js",
+    "align-api-deps": "node ../../scripts/align-api-deps.js"
   },
   "repository": {
     "type": "git",
@@ -31,12 +32,12 @@
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/examples/",
   "dependencies": {
     "@opentelemetry/api": "1.8.0",
-    "@opentelemetry/exporter-trace-otlp-proto": "0.51.0",
-    "@opentelemetry/instrumentation": "0.51.0",
-    "@opentelemetry/instrumentation-http": "0.51.0",
-    "@opentelemetry/resources": "1.24.0",
-    "@opentelemetry/sdk-trace-base": "1.24.0",
-    "@opentelemetry/sdk-trace-node": "1.24.0",
-    "@opentelemetry/semantic-conventions": "1.24.0"
+    "@opentelemetry/exporter-trace-otlp-proto": "0.51.1",
+    "@opentelemetry/instrumentation": "0.51.1",
+    "@opentelemetry/instrumentation-http": "0.51.1",
+    "@opentelemetry/resources": "1.24.1",
+    "@opentelemetry/sdk-trace-base": "1.24.1",
+    "@opentelemetry/sdk-trace-node": "1.24.1",
+    "@opentelemetry/semantic-conventions": "1.24.1"
   }
 }

examples/grpc-js/README.md

@@ -36,7 +36,7 @@ Setup [Jaeger Tracing](https://www.jaegertracing.io/docs/latest/getting-started/
 `zipkin:server` script should output the `traceid` in the terminal (e.g `traceid: 4815c3d576d930189725f1f1d1bdfcc6`).
 Go to Zipkin with your browser <http://localhost:9411/zipkin/traces/(your-trace-id)> (e.g <http://localhost:9411/zipkin/traces/4815c3d576d930189725f1f1d1bdfcc6)>
 
-<p align="center"><img src="./images/zipkin.png"/></p>
+<p align="center"><img alt="Zipkin UI showing a trace" src="./images/zipkin.png"/></p>
 
 ### Jaeger
 
@@ -59,7 +59,7 @@ Go to Zipkin with your browser <http://localhost:9411/zipkin/traces/(your-trace-
 `jaeger:server` script should output the `traceid` in the terminal (e.g `traceid: 4815c3d576d930189725f1f1d1bdfcc6`).
 Go to Jaeger with your browser <http://localhost:50051/trace/(your-trace-id)> (e.g <http://localhost:50051/trace/4815c3d576d930189725f1f1d1bdfcc6)>
 
-<p align="center"><img src="./images/jaeger.png"/></p>
+<p align="center"><img alt="Jaeger UI showing a trace" src="./images/jaeger.png"/></p>
 
 ## Useful links
 

examples/http/README.md

@@ -46,7 +46,7 @@ Setup [Jaeger Tracing](https://www.jaegertracing.io/docs/latest/getting-started/
 `zipkin:server` script should output the `traceid` in the terminal (e.g `traceid: 4815c3d576d930189725f1f1d1bdfcc6`).
 Go to Zipkin with your browser <http://localhost:9411/zipkin/traces/(your-trace-id)> (e.g <http://localhost:9411/zipkin/traces/4815c3d576d930189725f1f1d1bdfcc6>)
 
-<p align="center"><img src="./images/zipkin-ui.png?raw=true"/></p>
+<p align="center"><img alt="Zipkin UI showing a trace" src="./images/zipkin-ui.png?raw=true"/></p>
 
 ### Jaeger
 
@@ -69,7 +69,7 @@ Go to Zipkin with your browser <http://localhost:9411/zipkin/traces/(your-trace-
 `jaeger:server` script should output the `traceid` in the terminal (e.g `traceid: 4815c3d576d930189725f1f1d1bdfcc6`).
 Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e.g <http://localhost:16686/trace/4815c3d576d930189725f1f1d1bdfcc6>)
 
-<p align="center"><img src="images/jaeger-ui.png?raw=true"/></p>
+<p align="center"><img alt="Jaeger UI showing a trace"  src="images/jaeger-ui.png?raw=true"/></p>
 
 ## Useful links