Merge branch 'main' into feat/add-transformer-entrypoints

Author: pichlermarc

.github/workflows/ossf-scorecard.yml

@@ -42,6 +42,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
+        uses: github/codeql-action/upload-sarif@28deaeda66b76a05916b6923827895f2b14ab387 # v3.28.16
         with:
           sarif_file: results.sarif

.github/workflows/unit-test.yml

@@ -18,6 +18,7 @@ jobs:
           - "20"
           - "22"
           - "23"
+          - "24"
     runs-on: ubuntu-latest
     env:
       NPM_CONFIG_UNSAFE_PERM: true
@@ -45,7 +46,8 @@ jobs:
         if: ${{
           matrix.node_version == '20' ||
           matrix.node_version == '22' ||
-          matrix.node_version == '23'
+          matrix.node_version == '23' ||
+          matrix.node_version == '24'
           }}
 
       - name: Bootstrap
@@ -55,13 +57,13 @@ jobs:
         run: npm run compile
 
       - run: npm test
-        if: ${{ matrix.node_version != '23' }}
-      # Node.js 23 type stripping conflicts with mocha usage of ts-node.
+        if: ${{ matrix.node_version != '23' && matrix.node_version != '24' }}
+      # Node.js >= 23 type stripping conflicts with mocha usage of ts-node.
       # See https://github.com/open-telemetry/opentelemetry-js/issues/5415
       - run: npm test
         env:
           NODE_OPTIONS: '--no-experimental-strip-types'
-        if: ${{ matrix.node_version == '23' }}
+        if: ${{ matrix.node_version == '23' || matrix.node_version == '24' }}
 
       - name: Report Coverage
         uses: codecov/codecov-action@v5

CHANGELOG.md

@@ -20,17 +20,20 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 * fix(resource): do not trigger `Accessing resource attributes before async attributes settled` warning when detecting resources [#5546](https://github.com/open-telemetry/opentelemetry-js/pull/5546) @dyladan
   * verbose logging of detected resource removed
 * fix(resource): use dynamic import over require to improve ESM compliance [#5298](https://github.com/open-telemetry/opentelemetry-js/pull/5298) @xiaoxiangmoe
-* fix(sdk-metrics): improve PeriodicExportingMetricReader() constructor input validation [#5621](https://github.com/open-telemetry/opentelemetry-js/pull/5621) @cjihrig
 
 ### :books: Documentation
 
 * refactor(metrics): Updated metrics samples to no longer treat `sdk.start()` as async [#5617](https://github.com/open-telemetry/opentelemetry-js/pull/5617) @JacksonWeber
 
 ### :house: Internal
 
+* refactor(sdk-trace-base): update semconv usage to ATTR_ exports [#5669](https://github.com/open-telemetry/opentelemetry-js/pull/5669) @trentm
+* refactor(sdk-trace-web): update semconv usage to ATTR_ exports [#5672](https://github.com/open-telemetry/opentelemetry-js/pull/5672) @trentm
+* refactor(resources): update semconv usage to ATTR_ exports [#5666](https://github.com/open-telemetry/opentelemetry-js/pull/5666) @trentm
 * test(sdk-metrics): fix multiple problematic assertRejects() calls [#5611](https://github.com/open-telemetry/opentelemetry-js/pull/5611) @cjihrig
 * refactor: replace assertRejects() with assert.rejects() [#5614](https://github.com/open-telemetry/opentelemetry-js/pull/5614) @cjihrig
 * refactor(core): migrate from deprecated semconv constants [#5575](https://github.com/open-telemetry/opentelemetry-js/pull/5575) @alumni55748
+* refactor(opentelemetry-core): simplify `parseKeyPairsIntoRecord()` [#5610](https://github.com/open-telemetry/opentelemetry-js/pull/5610) @cjihrig
 
 ## 2.0.0
 

README.md

@@ -256,7 +256,7 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
 
 Members of this team have triager permissions for opentelemetry-js.git and opentelemetry-js-contrib.git.
 
-- (none currently)
+- [Jackson Weber](https://github.com/JacksonWeber), Microsoft
 
 *Find more about the triager role in the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#triager).*
 

api/package.json

@@ -96,7 +96,7 @@
     "ts-loader": "9.5.2",
     "typescript": "5.0.4",
     "unionfs": "4.5.4",
-    "webpack": "5.96.1"
+    "webpack": "5.99.7"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/api",
   "sideEffects": false

doc/frequently-asked-questions.md

@@ -0,0 +1,28 @@
+# Frequently Asked Questions
+
+This FAQ has bits of advice and workarounds for common problems.
+
+## I'm using Jest and get import errors when I run my test suite
+
+Test suite failures of the form:
+
+``` text
+Cannot find module @opentelemetry/foo/bar from @opentelemetry/...
+```
+
+but package `@opentelemetry/foo` is installed may occur with Jest < v29.4.
+This is because older versions of `jest-resolve` cannot find the nested module
+imports used by some OpenTelemetry packages since version 0.56 and higher.
+See [#5618](https://github.com/open-telemetry/opentelemetry-js/issues/5618)
+
+Either upgrade to a newer version of Jest to resolve the issue, or use this
+workaround for older versions of Jest by adding a `moduleNameMapper` rule.
+Add this line to your `jest.config.js`:
+
+``` javascript
+module.exports = {
+  moduleNameMapper: {
+    '^@opentelemetry/([^/]+)/(.+)$': '<rootDir>/node_modules/@opentelemetry/$1/build/src/index-$2',
+  }
+}
+```

doc/metrics.md

@@ -293,10 +293,10 @@ can be used to information about the record measurement itself.
 
 ```typescript
 async function myTask() {
-  const httpServerDuration = meter.createHistogram("http.server.duration", {
-    description: 'A http server duration',
-    unit: 'milliseconds',
-    valueType: ValueType.INT
+  const httpServerDuration = meter.createHistogram("my.http.server.request.duration", {
+    description: 'HTTP server request duration',
+    unit: 's',
+    valueType: ValueType.DOUBLE
   });
   const startTime = new Date().getTime()
   try {
@@ -305,12 +305,12 @@ async function myTask() {
   } catch (err) {
   } finally {
     const endTime = new Date().getTime()
-    const executionTime = endTime - startTime
+    const executionTime = (endTime - startTime) / 1000
 
     httpServerDuration.record(executionTime, {
-      [SemanticAttributes.HTTP_METHOD]: 'POST',
-      [SemanticAttributes.HTTP_STATUS_CODE]: '200',
-      [SemanticAttributes.HTTP_SCHEME]: 'https',
+      [ATTR_HTTP_REQUEST_METHOD]: 'POST',
+      [ATTR_HTTP_RESPONSE_STATUS_CODE]: '200',
+      [ATTR_URL_SCHEME]: 'https',
     })
   }
 }
@@ -416,17 +416,17 @@ const meterProvider = new MeterProvider({
 });
 
 // Create histogram metric
-const httpServerDuration = meter.createHistogram("http.server.duration", {
-  description: 'A http server duration',
-  unit: 'milliseconds',
-  valueType: ValueType.INT
+const httpServerDuration = meter.createHistogram('my.http.server.request.duration', {
+  description: 'HTTP server request duration',
+  unit: 's',
+  valueType: ValueType.DOUBLE
 });
 
 // Record measurement for histogram
 httpServerDuration.record(50, {
-  [SemanticAttributes.HTTP_METHOD]: 'POST',
-  [SemanticAttributes.HTTP_STATUS_CODE]: '200',
-  [SemanticAttributes.HTTP_SCHEME]: 'https',
+  [ATTR_HTTP_REQUEST_METHOD]: 'POST',
+  [ATTR_HTTP_RESPONSE_STATUS_CODE]: '200',
+  [ATTR_URL_SCHEME]: 'https',
 });
 ```
 

doc/tracing.md

@@ -79,20 +79,31 @@ server.on("GET", "/user/:id", onGet);
 Using span relationships, attributes, kind, and the related [semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/trace.md), 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 { trace, context, SpanKind, SpanStatusCode } from '@opentelemetry/api';
+import {
+  ATTR_HTTP_REQUEST_METHOD,
+  ATTR_URL_PATH,
+  ATTR_URL_SCHEME,
+  ATTR_HTTP_RESPONSE_STATUS_CODE,
+  ATTR_NETWORK_PEER_ADDRESS,
+  ATTR_DB_SYSTEM_NAME,
+  ATTR_DB_NAMESPACE,
+  ATTR_DB_OPERATION_NAME,
+  ATTR_DB_QUERY_TEXT,
+} from '@opentelemetry/semantic-conventions';
 
 async function onGet(request, response) {
   // HTTP semantic conventions determine the span name and attributes for this span
-  const span = tracer.startSpan(`GET /user/:id`, {
+  const span = tracer.startSpan('GET /user/:id', {
     // attributes can be added when the span is started
     attributes: {
       // Attributes from the HTTP trace semantic conventions
-      // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md
-      [SemanticAttributes.HTTP_METHOD]: "GET",
-      [SemanticAttributes.HTTP_FLAVOR]: "1.1",
-      [SemanticAttributes.HTTP_URL]: request.url,
-      [SemanticAttributes.NET_PEER_IP]: "192.0.2.5",
+      // https://opentelemetry.io/docs/specs/semconv/http/http-spans/#http-server-span
+      [ATTR_HTTP_REQUEST_METHOD]: 'POST',
+      [ATTR_URL_PATH]: request.url,
+      [ATTR_URL_SCHEME]: 'https',
+      [ATTR_HTTP_RESPONSE_STATUS_CODE]: '200',
+      [ATTR_NETWORK_PEER_ADDRESS]: '192.0.2.5',
     },
     // This span represents a remote incoming synchronous request
     kind: SpanKind.SERVER
@@ -142,26 +153,16 @@ async function getUser(userId) {
   const span = tracer.startSpan("SELECT ShopDb.Users", {
     attributes: {
       // Attributes from the database trace semantic conventions
-      // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md
-      [SemanticAttributes.DB_SYSTEM]: "mysql",
-      [SemanticAttributes.DB_CONNECTION_STRING]: "Server=shopdb.example.com;Database=ShopDb;Uid=billing_user;TableCache=true;UseCompression=True;MinimumPoolSize=10;MaximumPoolSize=50;",
-      [SemanticAttributes.DB_USER]: "app_user",
-      [SemanticAttributes.NET_PEER_NAME]: "shopdb.example.com",
-      [SemanticAttributes.NET_PEER_IP]: "192.0.2.12",
-      [SemanticAttributes.NET_PEER_PORT]: 3306,
-      [SemanticAttributes.NET_TRANSPORT]: NetTransportValues.IP_TCP,
-      [SemanticAttributes.DB_NAME]: "ShopDb",
-      [SemanticAttributes.DB_STATEMENT]: `Select * from Users WHERE user_id = ${userId}`,
-      [SemanticAttributes.DB_OPERATION]: "SELECT",
-      [SemanticAttributes.DB_SQL_TABLE]: "Users",
+      // https://opentelemetry.io/docs/specs/semconv/database/database-spans/#span-definition
+      [ATTR_DB_SYSTEM_NAME]: "mysql",
+      [ATTR_DB_NAMESPACE]: "ShopDb",
+      [ATTR_DB_OPERATION_NAME]: "SELECT",
+      [ATTR_DB_QUERY_TEXT]: `SELECT * from Users WHERE id = ?`,
     },
     kind: SpanKind.CLIENT,
   });
   const user = await db.select("Users", { id: userId });
 
-  span.setStatus({
-      code: SpanStatusCode.OK,
-  });
   span.end();
   return user;
 }

experimental/CHANGELOG.md

@@ -8,20 +8,34 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 
 ### :boom: Breaking Changes
 
-* feat(instrumentation-http)!: Remove legacy http span attributes and metrics [#5552](https://github.com/open-telemetry/opentelemetry-js/pull/5552) @svetlanabrennan
-
 ### :rocket: Features
 
+* feat(instrumentation-xml-http-request): support migration to stable HTTP semconv, v1.23.1  [#5662](https://github.com/open-telemetry/opentelemetry-js/pull/5662) @trentm
+  * Configure the instrumentation with `semconvStabilityOptIn: 'http'` to use the new, stable semconv v1.23.1 semantics or `'http/dup'` for both old (v1.7.0) and stable semantics. When `semconvStabilityOptIn` is not specified (or does not contain these values), it uses the old semconv v1.7.0. I.e. the default behavior is unchanged.
+* feat(instrumentation-fetch): support migration to stable HTTP semconv, v1.23.1  [#5651](https://github.com/open-telemetry/opentelemetry-js/pull/5651) @trentm
+  * Configure the instrumentation with `semconvStabilityOptIn: 'http'` to use the new, stable semconv v1.23.1 semantics or `'http/dup'` for both old (v1.7.0) and stable semantics. When `semconvStabilityOptIn` is not specified (or does not contain these values), it uses the old semconv v1.7.0. I.e. the default behavior is unchanged.
+* feat(instrumentation): New `semconvStabilityFromStr()` utility for semconv stability migration in instrumentations. [#5684](https://github.com/open-telemetry/opentelemetry-js/pull/5684) @trentm
+  * See [the utility comment](https://github.com/trentm/opentelemetry-js/blob/main/experimental/packages/opentelemetry-instrumentation/src/semconvStability.ts).
+* feat(instrumentation-grpc): support migration to stable HTTP semconv [#5653](https://github.com/open-telemetry/opentelemetry-js/pull/5653) @JamieDanielson
+* feat(instrumentation-http): capture synthetic source type on requests [#5488](https://github.com/open-telemetry/opentelemetry-js/pull/5488) @JacksonWeber
+
 ### :bug: Bug Fixes
 
-fix(otlp-transformer): do not throw when deserializing empty JSON response [#5551](https://github.com/open-telemetry/opentelemetry-js/pull/5551) @pichlermarc
+* fix(otlp-transformer): do not throw when deserializing empty JSON response [#5551](https://github.com/open-telemetry/opentelemetry-js/pull/5551) @pichlermarc
+* fix(instrumentation-http): report stable client metrics response code [#9586](https://github.com/open-telemetry/opentelemetry-js/pull/9586) @jtescher
+* fix(sdk-node): instantiate baggage processor when env var is set [#5634](https://github.com/open-telemetry/opentelemetry-js/pull/5634) @pichlermarc
 
 ### :books: Documentation
 
 ### :house: Internal
 
+* refactor(instrumentation-http): Remove legacy http span attributes and metrics [#5552](https://github.com/open-telemetry/opentelemetry-js/pull/5552) @svetlanabrennan
+* refactor(instrumentation-http): Add back support for http semconv [#5665](https://github.com/open-telemetry/opentelemetry-js/pull/5665) @JamieDanielson
+  * Note: We initially removed support for legacy http attributes and metrics, but then added back for an additional 6 months to ensure all instrumentations could be updated and kept consistent. There should be no net new change in this instrumentation related to these semantic conventions. See [#5646](https://github.com/open-telemetry/opentelemetry-js/issues/5646) for details.
+* refactor(sdk-node): update semconv usage to `ATTR_` exports [#5668](https://github.com/open-telemetry/opentelemetry-js/pull/5668) @trentm
 * chore(sdk-node): Refactored using `get*FromEnv` utility function instead of `process.env` for NodeSDK's resource detector setup. [#5582](https://github.com/open-telemetry/opentelemetry-js/pull/5582) @beeme1mr
 * chore(sdk-node): Refactored using `get*FromEnv` utility function instead of `process.env` for NodeSDK's logging setup. [#5563](https://github.com/open-telemetry/opentelemetry-js/issues/5563) @weyert
+* test: test Node.js 24 in CI [#5661](https://github.com/open-telemetry/opentelemetry-js/pull/5661) @cjihrig
 
 ## 0.200.0
 

experimental/packages/api-events/package.json

@@ -80,7 +80,7 @@
     "nyc": "17.1.0",
     "ts-loader": "9.5.2",
     "typescript": "5.0.4",
-    "webpack": "5.96.1"
+    "webpack": "5.99.7"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/api-events",
   "sideEffects": false