feat: instrumentation description in base class constructor

open-telemetry · May 17, 2024 · a91f419 · a91f419
1 parent d58aa3b
commit a91f419
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 8 deletions.
diff --git a/experimental/packages/opentelemetry-instrumentation-fetch/src/fetch.ts b/experimental/packages/opentelemetry-instrumentation-fetch/src/fetch.ts
@@ -26,7 +26,7 @@ import * as web from '@opentelemetry/sdk-trace-web';
 import { AttributeNames } from './enums/AttributeNames';
 import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
 import { FetchError, FetchResponse, SpanData } from './types';
-import { VERSION } from './version';
+import { PACKAGE_DESCRIPTION, VERSION } from './version';
 import { _globalThis } from '@opentelemetry/core';
 
 // how long to wait for observer to collect information about resources
@@ -80,7 +80,7 @@ export class FetchInstrumentation extends InstrumentationBase<FetchInstrumentati
   private _tasksCount = 0;
 
   constructor(config: FetchInstrumentationConfig = {}) {
-    super('@opentelemetry/instrumentation-fetch', VERSION, config);
+    super('@opentelemetry/instrumentation-fetch', VERSION, config, {description: PACKAGE_DESCRIPTION});
   }
 
   init(): void {}

diff --git a/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts b/experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts
@@ -85,13 +85,13 @@ import {
   _methodIsIgnored,
 } from './utils';
 import { AttributeValues } from './enums/AttributeValues';
-import { VERSION } from './version';
+import { PACKAGE_DESCRIPTION, VERSION } from './version';
 
 export class GrpcInstrumentation extends InstrumentationBase<GrpcInstrumentationConfig> {
   private _metadataCapture: metadataCaptureType;
 
   constructor(config: GrpcInstrumentationConfig = {}) {
-    super('@opentelemetry/instrumentation-grpc', VERSION, config);
+    super('@opentelemetry/instrumentation-grpc', VERSION, config, { description: PACKAGE_DESCRIPTION });
     this._metadataCapture = this._createMetadataCapture();
   }
 

diff --git a/experimental/packages/opentelemetry-instrumentation-http/src/http.ts b/experimental/packages/opentelemetry-instrumentation-http/src/http.ts
@@ -49,7 +49,7 @@ import {
   Https,
 } from './types';
 import * as utils from './utils';
-import { VERSION } from './version';
+import { PACKAGE_DESCRIPTION, VERSION } from './version';
 import {
   InstrumentationBase,
   InstrumentationNodeModuleDefinition,
@@ -70,7 +70,7 @@ export class HttpInstrumentation extends InstrumentationBase<HttpInstrumentation
   private _httpClientDurationHistogram!: Histogram;
 
   constructor(config: HttpInstrumentationConfig = {}) {
-    super('@opentelemetry/instrumentation-http', VERSION, config);
+    super('@opentelemetry/instrumentation-http', VERSION, config, { description: PACKAGE_DESCRIPTION});
     this._headerCapture = this._createHeaderCapture();
   }
 

diff --git a/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts b/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts
@@ -37,7 +37,7 @@ import {
   SendFunction,
   XhrMem,
 } from './types';
-import { VERSION } from './version';
+import { PACKAGE_DESCRIPTION, VERSION } from './version';
 import { AttributeNames } from './enums/AttributeNames';
 
 // how long to wait for observer to collect information about resources
@@ -91,7 +91,7 @@ export class XMLHttpRequestInstrumentation extends InstrumentationBase<XMLHttpRe
   private _usedResources = new WeakSet<PerformanceResourceTiming>();
 
   constructor(config: XMLHttpRequestInstrumentationConfig = {}) {
-    super('@opentelemetry/instrumentation-xml-http-request', VERSION, config);
+    super('@opentelemetry/instrumentation-xml-http-request', VERSION, config, { description: PACKAGE_DESCRIPTION});
   }
 
   init() {}

diff --git a/scripts/version-update.js b/scripts/version-update.js
@@ -41,6 +41,7 @@ const content = `/*
 
 // this is autogenerated file, see scripts/version-update.js
 export const VERSION = '${pjson.version}';
+export const PACKAGE_DESCRIPTION = '${pjson.description}';
 `;
 
 const fileUrl = path.join(appRoot, "src", "version.ts")