Merge branch 'main' into next-main-2024-12-04

Author: pichlermarc

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -5,38 +5,61 @@ body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to fill out this bug report!
-        Please make sure to fill out the entire form below,
-        providing as much context as you can in order to help us
-        triage and track down your bug as quickly as possible.
+        > [!IMPORTANT]
+        > **Please read all parts of this form carefully.** By following the instructions carefully, you ensure that we
+        > can get started fixing your bug, instead of being stuck at trying to reproduce your issue. Please provide
+        > all requested information, even if you think it does not apply to your problem.
+        >
+        >  **If you use a third-party package that re-distributes OpenTelemetry, open the bug ticket with that third party unless you can provide steps to reproduce this with pure OpenTelemetry.**
+        >  Digging into third-party distributions of OpenTelemetry is not in scope for this project.
 
-        Before filing a bug, please be sure you have searched through
-        [existing bugs](https://github.com/open-telemetry/opentelemetry-js/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug)
-        to see if your bug is already addressed.
-
-        If your bug is related to an instrumentation or plugin in [opentelemetry-js-contrib](https://github.com/open-telemetry/opentelemetry-js-contrib)
-        please be sure to file it there.
+        Before filing a bug, please be sure you have searched through [existing open bugs](https://github.com/open-telemetry/opentelemetry-js/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug)
+        to see if this bug has already been filed.
+  - type: markdown
+    attributes:
+      value: |
+        ## Bug Reproduction
   - type: textarea
     attributes:
       label: What happened?
-      description: Please provide as much detail as you reasonably can.
+      description: |
+        > [!IMPORTANT]
+        > **Please provide as much detail as you reasonably can.**
+        > We all know the complexities of developing with JavaScript/TypeScript. **Be specific** about your setup and **DO NOT** assume that the person handling your bug report knows how to use your specific combination of tooling. Always provide build instructions and config files.
       value: |
         ## Steps to Reproduce
-
+          <!--
+            The most effective way to solve a bug is to provide a link to a reproducer repository. It is extremely difficult to exactly reproduce problems
+            and doing so can take multiple hours for us. You know your tooling and setup and we know OpenTelemetry JavaScript internals.
+            Let's help each other! :)
+         -->
         ## Expected Result
 
         ## Actual Result
 
         ## Additional Details
+         <!--
+           Anything you can think of that will help us reproduce and understand your problem:
+              - details about the behavior of the bug
+              - code to reproduce, if not provided via a repository above (including setting up any frameworks you may be using, we likely don't use the same tech-stack that you're using on the daily)
+              - which tooling you use and how you're using it
+              - config files for your tooling (typescript, bundlers, ...)
+              - how you run your code (example: `node -r otel.js ./index.js`).
+              - which module type you are you using (`module` or `commonjs`)
+         -->
+
 
     validations:
       required: true
   - type: textarea
     attributes:
       label: OpenTelemetry Setup Code
-      description: Please provide the code you use to set up OpenTelemetry
+      description: |
+        Please provide the code you use to set up OpenTelemetry.
+        If you use `@opentelemetry/auto-instrumentations-node/register`, please state so here.
+        You may omit this step if you have provided a reproducer repository.
       placeholder: | # This comes from our README.md
-        // tracing.js
+        // otel.js
 
         'use strict'
 
@@ -75,13 +98,15 @@ body:
   - type: textarea
     attributes:
       label: package.json
-      description: If possible, please provide your full package.json. If not, please provide at least your list of dependencies and their versions, especially OpenTelemetry versions.
+      description: |
+        Please provide your the full package.json needed to reproduce the issue.
+        You may omit this step if you provided a reproducer repository.
       render: "JSON"
       placeholder: |
         {
           "name": "my-app",
           "scripts": {
-            "start": "node -r tracing.js app.js"
+            "start": "node -r otel.js app.js"
           },
           "dependencies": {
             "@opentelemetry/api": "^1.3.0",
@@ -95,3 +120,20 @@ body:
       description: |
         Please copy and paste any relevant log output.
       render: shell
+  - type: markdown
+    attributes:
+      value: |
+        ## System Details
+        System Details help us when we cannot reproduce your problem with the information provided above. Sometimes bugs only surface on specific platforms and runtime versions.
+  - type: textarea
+    attributes:
+      label: Operating System and Version
+      placeholder: Ubuntu 24.04, Windows 11 Build 26100.2033, macOS 15.0.1
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Runtime and Version
+      placeholder: Node.js v20.12.1, Node.js v18.18.2, Firefox 130, Chrome 132, ...
+    validations:
+      required: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,7 +7,7 @@ Before creating a pull request, please make sure:
 - You have read the guide for contributing
   - See https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md
 - You signed all your commits (otherwise we won't be able to merge the PR)
-  - See https://github.com/open-telemetry/community/blob/master/CONTRIBUTING.md#sign-the-cla
+  - See https://github.com/open-telemetry/community/blob/main/guides/contributor#sign-the-cla
 - You added unit tests for the new functionality
 - You mention in the PR description which issue it is addressing, e.g. "Fixes #xxx". This will auto-close
   the issue that your PR fixes (if such)

.github/workflows/unit-test.yml

@@ -40,7 +40,7 @@ jobs:
       - name: Unit tests
         run: npm run test
       - name: Report Coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
@@ -96,7 +96,7 @@ jobs:
       - name: Unit tests
         run: npm run test:browser
       - name: Report Coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
@@ -124,7 +124,7 @@ jobs:
       - name: Unit tests
         run: npm run test:webworker
       - name: Report Coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:

CHANGELOG.md

@@ -13,6 +13,24 @@ For semantic convention package changes, see the [semconv CHANGELOG](packages/se
 
 ### :rocket: (Enhancement)
 
+### :bug: (Bug Fix)
+
+* fix(sdk-trace-base): do not load OTEL_ env vars on module load, but when needed [#5224](https://github.com/open-telemetry/opentelemetry-js/pull/5224)
+
+### :books: (Refine Doc)
+
+### :house: (Internal)
+
+## 1.29.0
+
+### :boom: Breaking Change
+
+* feat(sdk-metrics): Add support for aggregation cardinality limit with a default limit of 2000. This limit can be customized via views [#5182](https://github.com/open-telemetry/opentelemetry-js/pull/5128)
+
+## 1.28.0
+
+### :rocket: (Enhancement)
+
 * feat(sdk-metrics, sdk-trace): add `mergeResourceWithDefaults` flag, which allows opting-out of resources getting merged with the default resource [#4617](https://github.com/open-telemetry/opentelemetry-js/pull/4617)
   * default: `true` (no change in behavior)
   * note: `false` will become the default behavior in the next major version in order to comply with [specification requirements](https://github.com/open-telemetry/opentelemetry-specification/blob/f3511a5ccda376dfd1de76dfa086fc9b35b54757/specification/resource/sdk.md?plain=1#L31-L36)
@@ -22,10 +40,9 @@ For semantic convention package changes, see the [semconv CHANGELOG](packages/se
 ### :bug: (Bug Fix)
 
 * fix(sdk-metrics): await exports in `PeriodicExportingMetricReader` when async resource attributes have not yet settled [#5119](https://github.com/open-telemetry/opentelemetry-js/pull/5119/) @pichlermarc
-
-### :books: (Refine Doc)
-
-### :house: (Internal)
+* fix(sdk-trace): performance.now() may return the same value for consecutive calls [#5150](https://github.com/open-telemetry/opentelemetry-js/pull/5150) @dyladan
+* fix(sdk-trace-base): pass BatchSpanProcessor#forceFlush() errors on visibilitychange/pagehide to globalErrorHandler [#5143](https://github.com/open-telemetry/opentelemetry-js/pull/5143) @pichlermarc
+  * fixes a bug where switching browser tabs with a failing exporter would cause an unhandled error
 
 ## 1.27.0
 

CONTRIBUTING.md

@@ -79,7 +79,7 @@ Reporting bugs is an important contribution. Please make sure to include:
 ### Before you start
 
 Please read project contribution
-[guide](https://github.com/open-telemetry/community/blob/master/CONTRIBUTING.md)
+[guide](https://github.com/open-telemetry/community/blob/main/guides/contributor)
 for general practices for OpenTelemetry project.
 
 #### Conventional commit
@@ -145,7 +145,7 @@ git merge upstream/main
 
 Remember to always work in a branch of your local copy, as you might otherwise have to contend with conflicts in main.
 
-Please also see [GitHub workflow](https://github.com/open-telemetry/community/blob/master/CONTRIBUTING.md#github-workflow) section of general project contributing guide.
+Please also see [GitHub workflow](https://github.com/open-telemetry/community/blob/main/guides/contributor/processes.md#github-workflow) section of general project contributing guide.
 
 ## Development
 

api/package.json

@@ -77,7 +77,7 @@
     "access": "public"
   },
   "devDependencies": {
-    "@types/mocha": "10.0.8",
+    "@types/mocha": "10.0.10",
     "@types/node": "18.6.5",
     "@types/sinon": "17.0.3",
     "@types/webpack": "5.28.5",
@@ -94,13 +94,13 @@
     "karma-webpack": "5.0.1",
     "lerna": "6.6.2",
     "memfs": "3.5.3",
-    "mocha": "10.7.3",
+    "mocha": "10.8.2",
     "nyc": "15.1.0",
     "sinon": "15.1.2",
     "ts-loader": "9.5.1",
     "typescript": "4.4.4",
     "unionfs": "4.5.4",
-    "webpack": "5.94.0"
+    "webpack": "5.96.1"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/api",
   "sideEffects": false

api/src/platform/browser/globalThis.ts

@@ -30,9 +30,9 @@ export const _globalThis: typeof globalThis =
   typeof globalThis === 'object'
     ? globalThis
     : typeof self === 'object'
-    ? self
-    : typeof window === 'object'
-    ? window
-    : typeof global === 'object'
-    ? global
-    : ({} as typeof globalThis);
+      ? self
+      : typeof window === 'object'
+        ? window
+        : typeof global === 'object'
+          ? global
+          : ({} as typeof globalThis);

examples/esm-http-ts/package.json

@@ -1,7 +1,7 @@
 {
   "name": "esm-http-ts",
   "private": true,
-  "version": "0.54.2",
+  "version": "0.56.0",
   "description": "Example of HTTP integration with OpenTelemetry using ESM and TypeScript",
   "main": "build/index.js",
   "type": "module",
@@ -32,12 +32,12 @@
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/examples/",
   "dependencies": {
     "@opentelemetry/api": "1.9.0",
-    "@opentelemetry/exporter-trace-otlp-proto": "0.54.2",
-    "@opentelemetry/instrumentation": "0.54.2",
-    "@opentelemetry/instrumentation-http": "0.54.2",
-    "@opentelemetry/resources": "1.27.0",
-    "@opentelemetry/sdk-trace-base": "1.27.0",
-    "@opentelemetry/sdk-trace-node": "1.27.0",
-    "@opentelemetry/semantic-conventions": "1.27.0"
+    "@opentelemetry/exporter-trace-otlp-proto": "0.56.0",
+    "@opentelemetry/instrumentation": "0.56.0",
+    "@opentelemetry/instrumentation-http": "0.56.0",
+    "@opentelemetry/resources": "1.29.0",
+    "@opentelemetry/sdk-trace-base": "1.29.0",
+    "@opentelemetry/sdk-trace-node": "1.29.0",
+    "@opentelemetry/semantic-conventions": "1.28.0"
   }
 }

examples/http/package.json

@@ -1,7 +1,7 @@
 {
   "name": "http-example",
   "private": true,
-  "version": "0.54.2",
+  "version": "0.56.0",
   "description": "Example of HTTP integration with OpenTelemetry",
   "main": "index.js",
   "scripts": {
@@ -30,14 +30,14 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.3.0",
-    "@opentelemetry/exporter-jaeger": "1.27.0",
-    "@opentelemetry/exporter-zipkin": "1.27.0",
-    "@opentelemetry/instrumentation": "0.54.2",
-    "@opentelemetry/instrumentation-http": "0.54.2",
-    "@opentelemetry/resources": "1.27.0",
-    "@opentelemetry/sdk-trace-base": "1.27.0",
-    "@opentelemetry/sdk-trace-node": "1.27.0",
-    "@opentelemetry/semantic-conventions": "1.27.0"
+    "@opentelemetry/exporter-jaeger": "1.29.0",
+    "@opentelemetry/exporter-zipkin": "1.29.0",
+    "@opentelemetry/instrumentation": "0.56.0",
+    "@opentelemetry/instrumentation-http": "0.56.0",
+    "@opentelemetry/resources": "1.29.0",
+    "@opentelemetry/sdk-trace-base": "1.29.0",
+    "@opentelemetry/sdk-trace-node": "1.29.0",
+    "@opentelemetry/semantic-conventions": "1.28.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/examples/http",
   "devDependencies": {

examples/https/package.json

@@ -1,7 +1,7 @@
 {
   "name": "https-example",
   "private": true,
-  "version": "0.54.2",
+  "version": "0.56.0",
   "description": "Example of HTTPs integration with OpenTelemetry",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
@@ -34,14 +34,14 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.3.0",
-    "@opentelemetry/exporter-jaeger": "1.27.0",
-    "@opentelemetry/exporter-zipkin": "1.27.0",
-    "@opentelemetry/instrumentation": "0.54.2",
-    "@opentelemetry/instrumentation-http": "0.54.2",
-    "@opentelemetry/resources": "1.27.0",
-    "@opentelemetry/sdk-trace-base": "1.27.0",
-    "@opentelemetry/sdk-trace-node": "1.27.0",
-    "@opentelemetry/semantic-conventions": "1.27.0"
+    "@opentelemetry/exporter-jaeger": "1.29.0",
+    "@opentelemetry/exporter-zipkin": "1.29.0",
+    "@opentelemetry/instrumentation": "0.56.0",
+    "@opentelemetry/instrumentation-http": "0.56.0",
+    "@opentelemetry/resources": "1.29.0",
+    "@opentelemetry/sdk-trace-base": "1.29.0",
+    "@opentelemetry/sdk-trace-node": "1.29.0",
+    "@opentelemetry/semantic-conventions": "1.28.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/examples/https",
   "devDependencies": {