feat(core)!: remove deprecated InstrumentationLibrary (#5308)

CHANGELOG.md

@@ -26,6 +26,14 @@ For semantic convention package changes, see the [semconv CHANGELOG](packages/se
 * refactor(sdk-trace-base)!: remove `new Span` constructor in favor of `Tracer.startSpan` API [#5048](https://github.com/open-telemetry/opentelemetry-js/pull/5048) @david-luna
 * refactor(sdk-trace-base)!: remove `BasicTracerProvider.addSpanProcessor` API in favor of constructor options. [#5134](https://github.com/open-telemetry/opentelemetry-js/pull/5134) @david-luna
 * refactor(sdk-trace-base)!: make `resource` property private in `BasicTracerProvider` and remove `getActiveSpanProcessor` API. [#5192](https://github.com/open-telemetry/opentelemetry-js/pull/5192) @david-luna
+* feat(core)!: remove deprecated type `InstrumentationLibrary` [#5308](https://github.com/open-telemetry/opentelemetry-js/pull/5308) @pichlermarc
+  * (user-facing): please use equivalent type `InstrumentationScope` instead
+* feat(sdk-trace-base)!: replace usages fo `InstrumentationLibrary` with `InstrumentationScope` [#5308](https://github.com/open-telemetry/opentelemetry-js/pull/5308) @pichlermarc
+  * (user-facing) rename `Tracer.instrumentationLibrary` -> `Tracer.instrumentationScope`
+  * (user-facing) rename `ReadableSpan.instrumentationLibrary` -> `ReadableSpan.instrumentationScope`
+    * also renames the property in implementations of `ReadableSpan`
+* feat(exporter-jaeger): use `ReadableSpan.instrumentationScope` over `ReadableSpan.instrumentationLibrary` [#5308](https://github.com/open-telemetry/opentelemetry-js/pull/5308) @pichlermarc
+* feat(exporter-zipkin): use `ReadableSpan.instrumentationScope` over `ReadableSpan.instrumentationLibrary` [#5308](https://github.com/open-telemetry/opentelemetry-js/pull/5308) @pichlermarc
 * chore!: update typescript to version `5.0.4` [#5145](https://github.com/open-telemetry/opentelemetry-js/pull/5145) @david-luna
   * (user-facing) dropped support for `typescript@<5.0.4`
   * (user-facing) all packages published from this repository will from now on drop support for old versions of `typescript` in minor releases. We will only drop support for versions that are older than 2 years.

experimental/packages/otlp-transformer/src/trace/internal.ts

@@ -114,22 +114,22 @@ export function createExportTraceServiceRequest(
 function createResourceMap(readableSpans: ReadableSpan[]) {
   const resourceMap: Map<IResource, Map<string, ReadableSpan[]>> = new Map();
   for (const record of readableSpans) {
-    let ilmMap = resourceMap.get(record.resource);
+    let ilsMap = resourceMap.get(record.resource);
 
-    if (!ilmMap) {
-      ilmMap = new Map();
-      resourceMap.set(record.resource, ilmMap);
+    if (!ilsMap) {
+      ilsMap = new Map();
+      resourceMap.set(record.resource, ilsMap);
     }
 
     // TODO this is duplicated in basic tracer. Consolidate on a common helper in core
-    const instrumentationLibraryKey = `${record.instrumentationLibrary.name}@${
-      record.instrumentationLibrary.version || ''
-    }:${record.instrumentationLibrary.schemaUrl || ''}`;
-    let records = ilmMap.get(instrumentationLibraryKey);
+    const instrumentationScopeKey = `${record.instrumentationScope.name}@${
+      record.instrumentationScope.version || ''
+    }:${record.instrumentationScope.schemaUrl || ''}`;
+    let records = ilsMap.get(instrumentationScopeKey);
 
     if (!records) {
       records = [];
-      ilmMap.set(instrumentationLibraryKey, records);
+      ilsMap.set(instrumentationScopeKey, records);
     }
 
     records.push(record);
@@ -160,11 +160,9 @@ function spanRecordsToResourceSpans(
         );
 
         scopeResourceSpans.push({
-          scope: createInstrumentationScope(
-            scopeSpans[0].instrumentationLibrary
-          ),
+          scope: createInstrumentationScope(scopeSpans[0].instrumentationScope),
           spans: spans,
-          schemaUrl: scopeSpans[0].instrumentationLibrary.schemaUrl,
+          schemaUrl: scopeSpans[0].instrumentationScope.schemaUrl,
         });
       }
       ilmEntry = ilmIterator.next();

experimental/packages/otlp-transformer/test/trace.test.ts

@@ -256,7 +256,7 @@ describe('Trace', () => {
           },
         },
       ],
-      instrumentationLibrary: {
+      instrumentationScope: {
         name: 'myLib',
         version: '0.1.0',
         schemaUrl: 'http://url.to.schema',

packages/opentelemetry-core/src/common/types.ts

@@ -39,18 +39,6 @@ export interface ShimWrapped extends Function {
   __original: Function;
 }
 
-/**
- * An instrumentation library consists of the name and optional version
- * used to obtain a tracer or meter from a provider. This metadata is made
- * available on ReadableSpan and MetricRecord for use by the export pipeline.
- * @deprecated Use {@link InstrumentationScope} instead.
- */
-export interface InstrumentationLibrary {
-  readonly name: string;
-  readonly version?: string;
-  readonly schemaUrl?: string;
-}
-
 /**
  * An instrumentation scope consists of the name and optional version
  * used to obtain a tracer or meter from a provider. This metadata is made

packages/opentelemetry-core/src/index.ts

@@ -42,7 +42,6 @@ export {
 } from './common/time';
 export {
   ErrorHandler,
-  InstrumentationLibrary,
   InstrumentationScope,
   ShimWrapped,
   TimeOriginLegacy,

packages/opentelemetry-exporter-jaeger/src/transform.ts

@@ -75,14 +75,14 @@ export function spanToThrift(span: ReadableSpan): ThriftSpan {
     })
   );
 
-  if (span.instrumentationLibrary) {
+  if (span.instrumentationScope) {
     tags.push({
       key: 'otel.library.name',
-      value: toTagValue(span.instrumentationLibrary.name),
+      value: toTagValue(span.instrumentationScope.name),
     });
     tags.push({
       key: 'otel.library.version',
-      value: toTagValue(span.instrumentationLibrary.version),
+      value: toTagValue(span.instrumentationScope.version),
     });
   }
 

packages/opentelemetry-exporter-jaeger/test/jaeger.test.ts

@@ -49,7 +49,7 @@ describe('JaegerExporter', () => {
     resource: new Resource({
       [SEMRESATTRS_SERVICE_NAME]: 'opentelemetry',
     }),
-    instrumentationLibrary: {
+    instrumentationScope: {
       name: 'default',
       version: '0.0.1',
     },

packages/opentelemetry-exporter-jaeger/test/transform.test.ts

@@ -78,7 +78,7 @@ describe('transform', () => {
           version: 1,
           cost: 112.12,
         }),
-        instrumentationLibrary: {
+        instrumentationScope: {
           name: 'default',
           version: '0.0.1',
         },
@@ -178,7 +178,7 @@ describe('transform', () => {
         events: [],
         duration: [32, 800000000],
         resource: Resource.empty(),
-        instrumentationLibrary: {
+        instrumentationScope: {
           name: 'default',
           version: '0.0.1',
         },
@@ -248,7 +248,7 @@ describe('transform', () => {
         events: [],
         duration: [32, 800000000],
         resource: Resource.empty(),
-        instrumentationLibrary: {
+        instrumentationScope: {
           name: 'default',
           version: '0.0.1',
         },
@@ -296,7 +296,7 @@ describe('transform', () => {
         events: [],
         duration: [32, 800000000],
         resource: Resource.empty(),
-        instrumentationLibrary: {
+        instrumentationScope: {
           name: 'default',
           version: '0.0.1',
         },
@@ -361,7 +361,7 @@ describe('transform', () => {
           version: 1,
           cost: 112.12,
         }),
-        instrumentationLibrary: {
+        instrumentationScope: {
           name: 'default',
           version: '0.0.1',
         },

packages/opentelemetry-exporter-zipkin/test/helper.ts

@@ -44,7 +44,7 @@ export const mockedReadableSpan: ReadableSpan = {
     version: 1,
     cost: 112.12,
   }),
-  instrumentationLibrary: { name: 'default', version: '0.0.1' },
+  instrumentationScope: { name: 'default', version: '0.0.1' },
   droppedAttributesCount: 0,
   droppedEventsCount: 0,
   droppedLinksCount: 0,

packages/opentelemetry-exporter-zipkin/test/node/zipkin.test.ts

@@ -55,7 +55,7 @@ function getReadableSpan() {
     links: [],
     events: [],
     resource: Resource.empty(),
-    instrumentationLibrary: { name: 'default', version: '0.0.1' },
+    instrumentationScope: { name: 'default', version: '0.0.1' },
     droppedAttributesCount: 0,
     droppedEventsCount: 0,
     droppedLinksCount: 0,
@@ -166,7 +166,7 @@ describe('Zipkin Exporter - node', () => {
           },
         ],
         resource: Resource.empty(),
-        instrumentationLibrary: { name: 'default', version: '0.0.1' },
+        instrumentationScope: { name: 'default', version: '0.0.1' },
         droppedAttributesCount: 0,
         droppedEventsCount: 0,
         droppedLinksCount: 0,
@@ -192,7 +192,7 @@ describe('Zipkin Exporter - node', () => {
         links: [],
         events: [],
         resource: Resource.empty(),
-        instrumentationLibrary: { name: 'default', version: '0.0.1' },
+        instrumentationScope: { name: 'default', version: '0.0.1' },
         droppedAttributesCount: 0,
         droppedEventsCount: 0,
         droppedLinksCount: 0,
@@ -387,7 +387,7 @@ describe('Zipkin Exporter - node', () => {
       resource: new Resource({
         [SEMRESATTRS_SERVICE_NAME]: resource_service_name,
       }),
-      instrumentationLibrary: { name: 'default', version: '0.0.1' },
+      instrumentationScope: { name: 'default', version: '0.0.1' },
       droppedAttributesCount: 0,
       droppedEventsCount: 0,
       droppedLinksCount: 0,
@@ -413,7 +413,7 @@ describe('Zipkin Exporter - node', () => {
       resource: new Resource({
         [SEMRESATTRS_SERVICE_NAME]: resource_service_name_prime,
       }),
-      instrumentationLibrary: { name: 'default', version: '0.0.1' },
+      instrumentationScope: { name: 'default', version: '0.0.1' },
       droppedAttributesCount: 0,
       droppedEventsCount: 0,
       droppedLinksCount: 0,
@@ -481,7 +481,7 @@ describe('Zipkin Exporter - node', () => {
         },
       ],
       resource: Resource.empty(),
-      instrumentationLibrary: { name: 'default', version: '0.0.1' },
+      instrumentationScope: { name: 'default', version: '0.0.1' },
       droppedAttributesCount: 0,
       droppedEventsCount: 0,
       droppedLinksCount: 0,
@@ -507,7 +507,7 @@ describe('Zipkin Exporter - node', () => {
       links: [],
       events: [],
       resource: Resource.empty(),
-      instrumentationLibrary: { name: 'default', version: '0.0.1' },
+      instrumentationScope: { name: 'default', version: '0.0.1' },
       droppedAttributesCount: 0,
       droppedEventsCount: 0,
       droppedLinksCount: 0,

packages/opentelemetry-sdk-trace-base/src/Span.ts

@@ -35,7 +35,7 @@ import {
   getTimeOrigin,
   hrTime,
   hrTimeDuration,
-  InstrumentationLibrary,
+  InstrumentationScope,
   isAttributeValue,
   isTimeInput,
   isTimeInputHrTime,
@@ -62,7 +62,7 @@ export type Span = APISpan & ReadableSpan;
 
 interface SpanOptions {
   resource: IResource;
-  scope: InstrumentationLibrary;
+  scope: InstrumentationScope;
   context: Context;
   spanContext: SpanContext;
   name: string;
@@ -89,7 +89,7 @@ export class SpanImpl implements Span {
   readonly events: TimedEvent[] = [];
   readonly startTime: HrTime;
   readonly resource: IResource;
-  readonly instrumentationLibrary: InstrumentationLibrary;
+  readonly instrumentationScope: InstrumentationScope;
 
   private _droppedAttributesCount = 0;
   private _droppedEventsCount: number = 0;
@@ -132,7 +132,7 @@ export class SpanImpl implements Span {
     this.links = opts.links || [];
     this.startTime = this._getTime(opts.startTime ?? now);
     this.resource = opts.resource;
-    this.instrumentationLibrary = opts.scope;
+    this.instrumentationScope = opts.scope;
 
     if (opts.attributes != null) {
       this.setAttributes(opts.attributes);

packages/opentelemetry-sdk-trace-base/src/Tracer.ts

@@ -16,7 +16,7 @@
 
 import * as api from '@opentelemetry/api';
 import {
-  InstrumentationLibrary,
+  InstrumentationScope,
   sanitizeAttributes,
   isTracingSuppressed,
 } from '@opentelemetry/core';
@@ -37,7 +37,7 @@ export class Tracer implements api.Tracer {
   private readonly _generalLimits: GeneralLimits;
   private readonly _spanLimits: SpanLimits;
   private readonly _idGenerator: IdGenerator;
-  readonly instrumentationLibrary: InstrumentationLibrary;
+  readonly instrumentationScope: InstrumentationScope;
 
   private readonly _resource: IResource;
   private readonly _spanProcessor: SpanProcessor;
@@ -46,7 +46,7 @@ export class Tracer implements api.Tracer {
    * Constructs a new Tracer instance.
    */
   constructor(
-    instrumentationLibrary: InstrumentationLibrary,
+    instrumentationScope: InstrumentationScope,
     config: TracerConfig,
     resource: IResource,
     spanProcessor: SpanProcessor
@@ -58,7 +58,7 @@ export class Tracer implements api.Tracer {
     this._idGenerator = config.idGenerator || new RandomIdGenerator();
     this._resource = resource;
     this._spanProcessor = spanProcessor;
-    this.instrumentationLibrary = instrumentationLibrary;
+    this.instrumentationScope = instrumentationScope;
   }
 
   /**
@@ -143,7 +143,7 @@ export class Tracer implements api.Tracer {
 
     const span = new SpanImpl({
       resource: this._resource,
-      scope: this.instrumentationLibrary,
+      scope: this.instrumentationScope,
       context,
       spanContext,
       name,

packages/opentelemetry-sdk-trace-base/src/export/ConsoleSpanExporter.ts

@@ -67,7 +67,7 @@ export class ConsoleSpanExporter implements SpanExporter {
       resource: {
         attributes: span.resource.attributes,
       },
-      instrumentationScope: span.instrumentationLibrary,
+      instrumentationScope: span.instrumentationScope,
       traceId: span.spanContext().traceId,
       parentId: span.parentSpanId,
       traceState: span.spanContext().traceState?.serialize(),

packages/opentelemetry-sdk-trace-base/src/export/ReadableSpan.ts

@@ -23,7 +23,7 @@ import {
   SpanContext,
 } from '@opentelemetry/api';
 import { IResource } from '@opentelemetry/resources';
-import { InstrumentationLibrary } from '@opentelemetry/core';
+import { InstrumentationScope } from '@opentelemetry/core';
 import { TimedEvent } from '../TimedEvent';
 
 export interface ReadableSpan {
@@ -40,7 +40,7 @@ export interface ReadableSpan {
   readonly duration: HrTime;
   readonly ended: boolean;
   readonly resource: IResource;
-  readonly instrumentationLibrary: InstrumentationLibrary;
+  readonly instrumentationScope: InstrumentationScope;
   readonly droppedAttributesCount: number;
   readonly droppedEventsCount: number;
   readonly droppedLinksCount: number;