Merge branch 'main' into bsp-eager-export

open-telemetry · Sep 27, 2023 · 68247b3 · 68247b3
2 parents 8ff333e + 2499708
commit 68247b3
Show file tree

Hide file tree

Showing 184 changed files with 4,159 additions and 1,245 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,13 +20,18 @@ jobs:
       NPM_CONFIG_UNSAFE_PERM: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node_version }}
 
       - run: npm install -g npm@latest
+        if: ${{ matrix.node_version == '18' || matrix.node_version == '20' }}
+
+      # [email protected] drops support for Node.js v14 and v16
+      - run: npm install -g npm@"<10.0.0"
+        if: ${{ matrix.node_version == '14' || matrix.node_version == '16' }}
 
       - name: restore lerna
         id: cache
@@ -41,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
@@ -66,11 +75,11 @@ jobs:
       NPM_CONFIG_UNSAFE_PERM: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
 
       - run: npm install -g npm@latest
 
@@ -98,14 +107,16 @@ jobs:
           npm run compile
 
       - name: Unit tests
+        env:
+         NODE_OPTIONS: --openssl-legacy-provider
         run: npm run test
   browser-tests:
     runs-on: ubuntu-latest
     env:
       NPM_CONFIG_UNSAFE_PERM: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v3
         with:
@@ -143,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
@@ -185,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:
@@ -201,4 +212,9 @@ jobs:
 
       - name: Test
         working-directory: ./api
-        run: npm test
+        # running test:eol as node 8 is not supported anymore by the version of nyc we use, as we don't report coverage
+        # for this step we leave it out.
+        # Details: nyc requires istanbul-lib-report, which silently dropped support for Node.js v8 when going from
+        # 3.0.0 to 3.0.1 by requiring make-dir@^4.0.0 to fix https://github.com/advisories/GHSA-c2qf-rxjj-qqgw.
+        # make-dir does not support Node.js v8 anymore.
+        run: npm run test:eol
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
@@ -13,10 +13,46 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 ### :bug: (Bug Fix)
 
+* fix(sdk-metrics): allow instrument names to contain '/' [#4155](https://github.com/open-telemetry/opentelemetry-js/pull/4155)
+
 ### :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)
+
+## 1.15.2
+
+### :bug: (Bug Fix)
+
+* fix(core): stop rounding to nearest int in hrTimeTo*seconds() functions [#4014](https://github.com/open-telemetry/opentelemetry-js/pull/4014/) @aabmass
+* fix(sdk-metrics): ignore invalid metric values [#3988](https://github.com/open-telemetry/opentelemetry-js/pull/3988) @legendecas
+* fix(core): add baggage support for values containing an equals sign [#3975](https://github.com/open-telemetry/opentelemetry-js/pull/3975) @krosenk729
+
 ## 1.15.1
 
 ### :bug: (Bug Fix)

diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@
 
 ## About this project
 
-This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a framework for collecting traces and metrics from applications.
+This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a framework for collecting traces, metrics, and logs from applications.
 
 ## Quick Start
 
@@ -109,24 +109,29 @@ If you are a library author looking to build OpenTelemetry into your library, pl
 
 ## Supported Runtimes
 
-| Platform Version    | Supported                                       |
-| ------------------- | ----------------------------------------------- |
-| Node.JS `v18`       | ✅                                               |
-| Node.JS `v16`       | ✅                                               |
-| Node.JS `v14`       | ✅                                               |
-| Older Node Versions | See [Node Support](#node-support)               |
-| Web Browsers        | ✅ See [Browser Support](#browser-support) below |
+| Platform Version    | Supported                                     |
+|---------------------|-----------------------------------------------|
+| Node.JS `v18`       | :heavy_check_mark:                            |
+| Node.JS `v16`       | :heavy_check_mark:                            |
+| Node.JS `v14`       | :heavy_check_mark:                            |
+| Older Node Versions | See [Node Support](#node-support)             |
+| Web Browsers        | See [Browser Support](#browser-support) below |
 
 ### Node Support
 
 Only Node.js Active or Maintenance LTS versions are supported.
 Previous versions of node *may* work, but they are not tested by OpenTelemetry and they are not guaranteed to work.
-Please note that versions of Node.JS v8 prior to `v8.12.0` will NOT work, because OpenTelemetry Node depends on the `perf_hooks` module introduced in `v8.5.0` and `performance.timeOrigin` that is set correctly starting in `v8.12.0`.
+Note that versions of Node.JS v8 prior to `v8.12.0` will NOT work, because OpenTelemetry Node depends on the
+`perf_hooks` module introduced in `v8.5.0` and `performance.timeOrigin` that is set correctly starting in `v8.12.0`.
 
 ### Browser Support
 
-Automated browser tests are run in the latest version of Headless Chrome.
-There is currently no list of officially supported browsers, but OpenTelemetry is developed using standard web technologies with wide support and should work in currently supported versions of major browsers.
+> [!IMPORTANT]
+> Client instrumentation for the browser is **experimental** and mostly **unspecified**. If you are interested in
+> helping out, get in touch with the [Client Instrumentation SIG][client-instrumentation-sig].
+
+There is currently no list of officially supported browsers. OpenTelemetry is developed using standard web
+technologies and aims to work in currently supported versions of major browsers.
 
 ## Package Version Compatibility
 
@@ -136,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
 
@@ -177,7 +190,7 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
 
 #### Maintainers ([@open-telemetry/js-maintainers](https://github.com/orgs/open-telemetry/teams/javascript-maintainers))
 
-- [Amir Blum](https://github.com/blumamir), Aspecto
+- [Amir Blum](https://github.com/blumamir), Keyval
 - [Chengzhong Wu](https://github.com/legendecas), Alibaba
 - [Daniel Dyla](https://github.com/dyladan), Dynatrace
 - [Marc Pichler](https://github.com/pichlermarc), Dynatrace
@@ -190,13 +203,10 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
 - [Haddas Bronfman](https://github.com/haddasbronfman), Cisco
 - [Hector Hernandez](https://github.com/hectorhdzg), Microsoft
 - [Jamie Danielson](https://github.com/JamieDanielson), Honeycomb
-- [John Bley](https://github.com/johnbley), Splunk
-- [Mark Wolff](https://github.com/markwolff), Microsoft
 - [Martin Kuba](https://github.com/martinkuba), Lightstep
 - [Matthew Wear](https://github.com/mwear), LightStep
 - [Naseem K. Ullah](https://github.com/naseemkullah), Transit
 - [Neville Wylie](https://github.com/MSNev), Microsoft
-- [Olivier Albertini](https://github.com/OlivierAlbertini), Ville de Montréal
 - [Purvi Kanal](https://github.com/pkanal), Honeycomb
 - [Svetlana Brennan](https://github.com/svetlanabrennan), New Relic
 
@@ -211,6 +221,9 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
 - [Valentin Marchaud](https://github.com/vmarchaud), Maintainer
 - [Brandon Gonzalez](https://github.com/bg451), LightStep, Approver
 - [Roch Devost](https://github.com/rochdev), DataDog, Approver
+- [John Bley](https://github.com/johnbley), Splunk, Approver
+- [Mark Wolff](https://github.com/markwolff), Microsoft, Approver
+- [Olivier Albertini](https://github.com/OlivierAlbertini), Ville de Montréal, Approver
 
 *Find more about the emeritus role in [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#emeritus-maintainerapprovertriager).*
 
@@ -552,6 +565,8 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [up-for-grabs-issues]: https://github.com/open-telemetry/OpenTelemetry-js/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs
 [good-first-issues]: https://github.com/open-telemetry/OpenTelemetry-js/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
 
+[client-instrumentation-sig]: https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit
+
 [docs]: https://open-telemetry.github.io/opentelemetry-js
 [compliance-matrix]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md
 [CONTRIBUTING]: https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md

diff --git a/api/CHANGELOG.md b/api/CHANGELOG.md
@@ -4,6 +4,19 @@ 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)
+
 ## 1.4.1
 
 ### :bug: (Bug Fix)

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",
@@ -25,6 +25,7 @@
     "lint": "eslint . --ext .ts",
     "test:browser": "karma start --single-run",
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
+    "test:eol": "ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
     "test:webworker": "karma start karma.worker.js --single-run",
     "cycle-check": "dpdm --exit-code circular:1 src/index.ts",
     "version": "node ../scripts/version-update.js",
@@ -62,7 +63,7 @@
   "devDependencies": {
     "@types/mocha": "10.0.1",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.15",
+    "@types/sinon": "10.0.16",
     "@types/webpack": "4.41.33",
     "@types/webpack-env": "1.16.3",
     "codecov": "3.8.3",
@@ -76,7 +77,7 @@
     "karma-mocha-webworker": "1.3.0",
     "karma-spec-reporter": "0.0.36",
     "karma-webpack": "4.0.2",
-    "lerna": "7.1.3",
+    "lerna": "7.1.5",
     "memfs": "3.5.3",
     "mocha": "10.2.0",
     "nyc": "15.1.0",