refactor(instr-router): use exported strings for attributes (#2099)

Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com>
open-telemetry · Apr 17, 2024 · 34796e2 · 34796e2
1 parent fae3010
commit 34796e2
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 5 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/plugins/node/opentelemetry-instrumentation-router/README.md b/plugins/node/opentelemetry-instrumentation-router/README.md
@@ -40,6 +40,16 @@ registerInstrumentations({
 
 See [examples/router](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/router) for a short example.
 
+## Semantic Conventions
+
+This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
+
+Attributes collected:
+
+| Attribute    | Short Description                  |
+| ------------ | ---------------------------------- |
+| `http.route` | The matched route (path template). |
+
 ## Useful links
 
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>

diff --git a/plugins/node/opentelemetry-instrumentation-router/package.json b/plugins/node/opentelemetry-instrumentation-router/package.json
@@ -57,7 +57,7 @@
   },
   "dependencies": {
     "@opentelemetry/instrumentation": "^0.50.0",
-    "@opentelemetry/semantic-conventions": "^1.0.0"
+    "@opentelemetry/semantic-conventions": "^1.22.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-router#readme"
 }
diff --git a/plugins/node/opentelemetry-instrumentation-router/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-router/src/instrumentation.ts
@@ -22,7 +22,7 @@ import {
   InstrumentationNodeModuleFile,
   isWrapped,
 } from '@opentelemetry/instrumentation';
-import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
+import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 
 import * as http from 'http';
 import type * as Router from 'router';
@@ -182,7 +182,7 @@ export default class RouterInstrumentation extends InstrumentationBase<any> {
       [AttributeNames.NAME]: fnName,
       [AttributeNames.VERSION]: this._moduleVersion,
       [AttributeNames.TYPE]: type,
-      [SemanticAttributes.HTTP_ROUTE]: route,
+      [SEMATTRS_HTTP_ROUTE]: route,
     };
 
     const parent = api.context.active();