Merge branch 'main' into benchmark-test

open-telemetry · Sep 19, 2023 · 0006802 · 0006802
2 parents fe5309f + cbc5c52
commit 0006802
Show file tree

Hide file tree

Showing 112 changed files with 1,738 additions and 598 deletions.
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -15,7 +15,7 @@ jobs:
     if: ${{ !contains(github.event.pull_request.labels.*.name, 'dependencies') && !contains(github.event.pull_request.labels.*.name, 'Skip Changelog')}}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Check for CHANGELOG changes
         run: |

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -2,25 +2,17 @@ name: "CodeQL Analysis"
 
 on:
   workflow_dispatch:
-  schedule:
-    #        ┌───────────── minute (0 - 59)
-    #        │  ┌───────────── hour (0 - 23)
-    #        │  │ ┌───────────── day of the month (1 - 31)
-    #        │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
-    #        │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
-    #        │  │ │ │ │
-    #        │  │ │ │ │
-    #        │  │ │ │ │
-    #        *  * * * *
-    - cron: '30 1 * * *'
+  push:
+    branches: [ main ]
+  pull_request:
 
 jobs:
   CodeQL-Build:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -16,7 +16,7 @@ jobs:
         with:
           node-version: '16'
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Lint changelog file
         uses: avto-dev/markdown-lint@v1

diff --git a/.github/workflows/peer-api.yml b/.github/workflows/peer-api.yml
@@ -14,7 +14,7 @@ jobs:
       image: node:20
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install lerna
         run: npm install -g lerna

diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
@@ -20,7 +20,7 @@ jobs:
       NPM_CONFIG_UNSAFE_PERM: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:
@@ -46,6 +46,10 @@ jobs:
             experimental/packages/*/package-lock.json
           key: node-tests-${{ runner.os }}-${{ matrix.node_version }}-${{ hashFiles('package.json', 'packages/*/package.json', 'experimental/packages/*/package.json') }}-04292022
 
+      # temporary fix for https://github.com/nrwl/nx/issues/19022
+      - run: npm install --save-dev [email protected] @nx/[email protected]
+        if: ${{ matrix.node_version == '14' }}
+
       - name: Bootstrap
         run: |
           npm install --ignore-scripts
@@ -71,7 +75,7 @@ jobs:
       NPM_CONFIG_UNSAFE_PERM: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:
@@ -112,7 +116,7 @@ jobs:
       NPM_CONFIG_UNSAFE_PERM: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:
@@ -150,7 +154,7 @@ jobs:
       NPM_CONFIG_UNSAFE_PERM: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v4.0.0
       - uses: actions/setup-node@v3
         with:
           node-version: 16
@@ -192,7 +196,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:

diff --git a/.github/workflows/w3c-integration-test.yml b/.github/workflows/w3c-integration-test.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,22 +11,38 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 ### :rocket: (Enhancement)
 
-* feat(api): add attributes argument to recordException API [#4071](https://github.com/open-telemetry/opentelemetry-js/pull/4071)
+### :bug: (Bug Fix)
+
+### :books: (Refine Doc)
+
+### :house: (Internal)
+
+* test: added a performance benchmark test for span creation [#4105](https://github.com/open-telemetry/opentelemetry-js/pull/4105)
+
+## 1.17.0
+
+### :bug: (Bug Fix)
+
+* Revert "feat(api): add attributes argument to recordException API [#4071](https://github.com/open-telemetry/opentelemetry-js/pull/4071)"
+  * This feature was an unintentional breaking change introduced with API 1.5.0
+  * This PR updates all SDK packages to allow API 1.6.0, where this change has been reverted.
+
+## 1.16.0
+
+### :rocket: (Enhancement)
+
 * feat(sdk-metrics): implement MetricProducer specification [#4007](https://github.com/open-telemetry/opentelemetry-js/pull/4007)
 * feat: update PeriodicExportingMetricReader and PrometheusExporter to accept optional metric producers [#4077](https://github.com/open-telemetry/opentelemetry-js/pull/4077) @aabmass
 
 ### :bug: (Bug Fix)
 
 * fix(exporter-zipkin): rounding duration to the nearest int to be compliant with zipkin protocol [#4064](https://github.com/open-telemetry/opentelemetry-js/pull/4064) @n0cloud
+* fix(sdk-metrics): metric names should be case-insensitive
 
 ### :books: (Refine Doc)
 
 * docs(guidelines): add dependencies guidelines [#4040](https://github.com/open-telemetry/opentelemetry-js/pull/4040)
 
-### :house: (Internal)
-
-* test: added a performance benchmark test for span creation [#4105](https://github.com/open-telemetry/opentelemetry-js/pull/4105)
-
 ## 1.15.2
 
 ### :bug: (Bug Fix)

diff --git a/README.md b/README.md
@@ -141,19 +141,27 @@ There may also be API packages for experimental signals in the experimental dire
 All stable packages are released with the same version, and all experimental packages are released with the same version.
 The below table describes which versions of each set of packages are expected to work together.
 
-| API   | Stable Packages | Experimental Packages |
-| ----- | --------------- | --------------------- |
-| 1.3.x | 1.9.x           | 0.35.x                |
-| 1.3.x | 1.8.x           | 0.34.x                |
-| 1.2.x | 1.7.x           | 0.33.x                |
-| 1.2.x | 1.6.x           | 0.32.x                |
-| 1.1.x | 1.5.x           | 0.31.x                |
-| 1.1.x | 1.4.x           | 0.30.x                |
-| 1.1.x | 1.3.x           | 0.29.x                |
-| 1.1.x | 1.2.x           | 0.29.x                |
-| 1.1.x | 1.1.x           | 0.28.x                |
-| 1.0.x | 1.0.x           | 0.27.x                |
-| 1.0.x | 1.0.x           | 0.26.x                |
+| Stable Packages                                                 | Experimental Packages |
+|-----------------------------------------------------------------|-----------------------|
+| 1.17.x                                                          | 0.43.x                |
+| 1.16.x                                                          | 0.42.x                |
+| 1.15.x                                                          | 0.41.x                |
+| 1.14.x                                                          | 0.40.x                |
+| 1.13.x                                                          | 0.39.x                |
+| 1.12.x                                                          | 0.38.x                |
+| 1.11.x                                                          | 0.37.x                |
+| 1.10.x                                                          | 0.36.x                |
+| 1.9.x                                                           | 0.35.x                |
+| 1.8.x (this and later versions require API >=1.3.0 for metrics) | 0.34.x                |
+| 1.7.x                                                           | 0.33.x                |
+| 1.6.x                                                           | 0.32.x                |
+| 1.5.x                                                           | 0.31.x                |
+| 1.4.x                                                           | 0.30.x                |
+| 1.3.x                                                           | 0.29.x                |
+| 1.2.x                                                           | 0.29.x                |
+| 1.1.x                                                           | 0.28.x                |
+| 1.0.x                                                           | 0.27.x                |
+| 1.0.x (this and later versions require API >=1.0.0 for traces)  | 0.26.x                |
 
 ## Versioning
 

diff --git a/api/CHANGELOG.md b/api/CHANGELOG.md
@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## 1.6.0
+
+### :bug: (Bug Fix)
+
+* Revert "feat(api): add attributes argument to recordException API [#4071](https://github.com/open-telemetry/opentelemetry-js/pull/4071)"
+  * This feature was an unintentional breaking change introduced with 1.5.0
+
+## 1.5.0
+
 ### :rocket: (Enhancement)
 
 * feat(api): add attributes argument to recordException API [#4071](https://github.com/open-telemetry/opentelemetry-js/pull/4071)

diff --git a/api/package.json b/api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@opentelemetry/api",
-  "version": "1.4.1",
+  "version": "1.6.0",
   "description": "Public API for OpenTelemetry",
   "main": "build/src/index.js",
   "module": "build/esm/index.js",

diff --git a/api/src/trace/NonRecordingSpan.ts b/api/src/trace/NonRecordingSpan.ts
@@ -71,9 +71,5 @@ export class NonRecordingSpan implements Span {
   }
 
   // By default does nothing
-  recordException(
-    _exception: Exception,
-    _attributesOrStartTime?: SpanAttributes | TimeInput,
-    _time?: TimeInput
-  ): void {}
+  recordException(_exception: Exception, _time?: TimeInput): void {}
 }
diff --git a/api/src/trace/span.ts b/api/src/trace/span.ts
@@ -126,17 +126,4 @@ export interface Span {
    *     use the current time.
    */
   recordException(exception: Exception, time?: TimeInput): void;
-
-  /**
-   * Sets exception as a span event
-   * @param exception the exception the only accepted values are string or Error
-   * @param [attributes] the attributes that will be added to the error event.
-   * @param [time] the time to set as Span's event time. If not provided,
-   *     use the current time.
-   */
-  recordException(
-    exception: Exception,
-    attributes?: SpanAttributes,
-    time?: TimeInput
-  ): void;
 }
diff --git a/doc/tracing.md b/doc/tracing.md
@@ -79,7 +79,7 @@ server.on("GET", "/user/:id", onGet);
 Using span relationships, attributes, kind, and the related [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions), we can more accurately describe the span in a way our tracing backend will more easily understand. The following example uses these mechanisms, which are described below.
 
 ```typescript
-import { NetTransportValues SemanticAttributes } from '@opentelemetry/semantic-conventions';
+import { NetTransportValues, SemanticAttributes } from '@opentelemetry/semantic-conventions';
 import { trace, context, SpanKind, SpanStatusCode } from '@opentelemetry/api';
 
 async function onGet(request, response) {

diff --git a/examples/esm-http-ts/package.json b/examples/esm-http-ts/package.json
@@ -1,7 +1,7 @@
 {
   "name": "esm-http-ts",
   "private": true,
-  "version": "0.41.2",
+  "version": "0.43.0",
   "description": "Example of HTTP integration with OpenTelemetry using ESM and TypeScript",
   "main": "build/index.js",
   "type": "module",
@@ -30,13 +30,13 @@
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/examples/",
   "dependencies": {
-    "@opentelemetry/api": "1.4.1",
-    "@opentelemetry/exporter-trace-otlp-proto": "0.41.2",
-    "@opentelemetry/instrumentation": "0.41.2",
-    "@opentelemetry/instrumentation-http": "0.41.2",
-    "@opentelemetry/resources": "1.15.2",
-    "@opentelemetry/sdk-trace-base": "1.15.2",
-    "@opentelemetry/sdk-trace-node": "1.15.2",
-    "@opentelemetry/semantic-conventions": "1.15.2"
+    "@opentelemetry/api": "1.6.0",
+    "@opentelemetry/exporter-trace-otlp-proto": "0.43.0",
+    "@opentelemetry/instrumentation": "0.43.0",
+    "@opentelemetry/instrumentation-http": "0.43.0",
+    "@opentelemetry/resources": "1.17.0",
+    "@opentelemetry/sdk-trace-base": "1.17.0",
+    "@opentelemetry/sdk-trace-node": "1.17.0",
+    "@opentelemetry/semantic-conventions": "1.17.0"
   }
 }
diff --git a/examples/http/package.json b/examples/http/package.json
@@ -1,7 +1,7 @@
 {
   "name": "http-example",
   "private": true,
-  "version": "0.41.2",
+  "version": "0.43.0",
   "description": "Example of HTTP integration with OpenTelemetry",
   "main": "index.js",
   "scripts": {
@@ -29,14 +29,14 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.3.0",
-    "@opentelemetry/exporter-jaeger": "1.15.2",
-    "@opentelemetry/exporter-zipkin": "1.15.2",
-    "@opentelemetry/instrumentation": "0.41.2",
-    "@opentelemetry/instrumentation-http": "0.41.2",
-    "@opentelemetry/resources": "1.15.2",
-    "@opentelemetry/sdk-trace-base": "1.15.2",
-    "@opentelemetry/sdk-trace-node": "1.15.2",
-    "@opentelemetry/semantic-conventions": "1.15.2"
+    "@opentelemetry/exporter-jaeger": "1.17.0",
+    "@opentelemetry/exporter-zipkin": "1.17.0",
+    "@opentelemetry/instrumentation": "0.43.0",
+    "@opentelemetry/instrumentation-http": "0.43.0",
+    "@opentelemetry/resources": "1.17.0",
+    "@opentelemetry/sdk-trace-base": "1.17.0",
+    "@opentelemetry/sdk-trace-node": "1.17.0",
+    "@opentelemetry/semantic-conventions": "1.17.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/examples/http",
   "devDependencies": {

diff --git a/examples/https/package.json b/examples/https/package.json
@@ -1,7 +1,7 @@
 {
   "name": "https-example",
   "private": true,
-  "version": "0.41.2",
+  "version": "0.43.0",
   "description": "Example of HTTPs integration with OpenTelemetry",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
@@ -33,14 +33,14 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.0.0",
-    "@opentelemetry/exporter-jaeger": "1.15.2",
-    "@opentelemetry/exporter-zipkin": "1.15.2",
-    "@opentelemetry/instrumentation": "0.41.2",
-    "@opentelemetry/instrumentation-http": "0.41.2",
-    "@opentelemetry/resources": "1.15.2",
-    "@opentelemetry/sdk-trace-base": "1.15.2",
-    "@opentelemetry/sdk-trace-node": "1.15.2",
-    "@opentelemetry/semantic-conventions": "1.15.2"
+    "@opentelemetry/exporter-jaeger": "1.17.0",
+    "@opentelemetry/exporter-zipkin": "1.17.0",
+    "@opentelemetry/instrumentation": "0.43.0",
+    "@opentelemetry/instrumentation-http": "0.43.0",
+    "@opentelemetry/resources": "1.17.0",
+    "@opentelemetry/sdk-trace-base": "1.17.0",
+    "@opentelemetry/sdk-trace-node": "1.17.0",
+    "@opentelemetry/semantic-conventions": "1.17.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/examples/https",
   "devDependencies": {