feat(trace): add optional schema url to TracerProvider.getTracer (#129)

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

Author: legendecas

src/trace/NoopTracerProvider.ts

@@ -16,6 +16,7 @@
 
 import { NoopTracer } from './NoopTracer';
 import { Tracer } from './tracer';
+import { TracerOptions } from './tracer_options';
 import { TracerProvider } from './tracer_provider';
 
 /**
@@ -25,7 +26,11 @@ import { TracerProvider } from './tracer_provider';
  * All operations are no-op.
  */
 export class NoopTracerProvider implements TracerProvider {
-  getTracer(_name?: string, _version?: string): Tracer {
+  getTracer(
+    _name?: string,
+    _version?: string,
+    _options?: TracerOptions
+  ): Tracer {
     return new NoopTracer();
   }
 }

src/trace/ProxyTracer.ts

@@ -19,6 +19,7 @@ import { NoopTracer } from './NoopTracer';
 import { Span } from './span';
 import { SpanOptions } from './SpanOptions';
 import { Tracer } from './tracer';
+import { TracerOptions } from './tracer_options';
 
 const NOOP_TRACER = new NoopTracer();
 
@@ -32,7 +33,8 @@ export class ProxyTracer implements Tracer {
   constructor(
     private _provider: TracerDelegator,
     public readonly name: string,
-    public readonly version?: string
+    public readonly version?: string,
+    public readonly options?: TracerOptions
   ) {}
 
   startSpan(name: string, options?: SpanOptions, context?: Context): Span {
@@ -58,7 +60,7 @@ export class ProxyTracer implements Tracer {
       return this._delegate;
     }
 
-    const tracer = this._provider.getDelegateTracer(this.name, this.version);
+    const tracer = this._provider.getDelegateTracer(this.name, this.version, this.options);
 
     if (!tracer) {
       return NOOP_TRACER;
@@ -70,5 +72,5 @@ export class ProxyTracer implements Tracer {
 }
 
 export interface TracerDelegator {
-  getDelegateTracer(name: string, version?: string): Tracer | undefined;
+  getDelegateTracer(name: string, version?: string, options?: TracerOptions): Tracer | undefined;
 }

src/trace/ProxyTracerProvider.ts

@@ -18,6 +18,7 @@ import { Tracer } from './tracer';
 import { TracerProvider } from './tracer_provider';
 import { ProxyTracer } from './ProxyTracer';
 import { NoopTracerProvider } from './NoopTracerProvider';
+import { TracerOptions } from './tracer_options';
 
 const NOOP_TRACER_PROVIDER = new NoopTracerProvider();
 
@@ -35,10 +36,10 @@ export class ProxyTracerProvider implements TracerProvider {
   /**
    * Get a {@link ProxyTracer}
    */
-  getTracer(name: string, version?: string): Tracer {
+  getTracer(name: string, version?: string, options?: TracerOptions): Tracer {
     return (
-      this.getDelegateTracer(name, version) ??
-      new ProxyTracer(this, name, version)
+      this.getDelegateTracer(name, version, options) ??
+      new ProxyTracer(this, name, version, options)
     );
   }
 
@@ -53,7 +54,11 @@ export class ProxyTracerProvider implements TracerProvider {
     this._delegate = delegate;
   }
 
-  getDelegateTracer(name: string, version?: string): Tracer | undefined {
-    return this._delegate?.getTracer(name, version);
+  getDelegateTracer(
+    name: string,
+    version?: string,
+    options?: TracerOptions
+  ): Tracer | undefined {
+    return this._delegate?.getTracer(name, version, options);
   }
 }

src/trace/tracer_options.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * An interface describes additional metadata of a tracer.
+ */
+export interface TracerOptions {
+  /**
+   * The schemaUrl of the tracer or instrumentation library
+   */
+  schemaUrl?: string;
+}

src/trace/tracer_provider.ts

@@ -15,6 +15,7 @@
  */
 
 import { Tracer } from './tracer';
+import { TracerOptions } from './tracer_options';
 
 /**
  * A registry for creating named {@link Tracer}s.
@@ -29,7 +30,8 @@ export interface TracerProvider {
    *
    * @param name The name of the tracer or instrumentation library.
    * @param version The version of the tracer or instrumentation library.
+   * @param options The options of the tracer or instrumentation library.
    * @returns Tracer A Tracer with the given name and version
    */
-  getTracer(name: string, version?: string): Tracer;
+  getTracer(name: string, version?: string, options?: TracerOptions): Tracer;
 }

test/noop-implementations/noop-tracer-provider.test.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as assert from 'assert';
+import { NoopTracer } from '../../src/trace/NoopTracer';
+import { NoopTracerProvider } from '../../src/trace/NoopTracerProvider';
+
+describe('NoopTracerProvider', () => {
+  it('should not crash', () => {
+    const tracerProvider = new NoopTracerProvider();
+
+    assert.ok(tracerProvider.getTracer('tracer-name') instanceof NoopTracer);
+    assert.ok(tracerProvider.getTracer('tracer-name', 'v1') instanceof NoopTracer);
+    assert.ok(tracerProvider.getTracer('tracer-name', 'v1', {
+      schemaUrl: 'https://opentelemetry.io/schemas/1.7.0'
+    }) instanceof NoopTracer);
+  });
+});

test/proxy-implementations/proxy-tracer.test.ts

@@ -81,7 +81,25 @@ describe('ProxyTracer', () => {
 
       sandbox.assert.calledOnce(getTracerStub);
       assert.strictEqual(getTracerStub.firstCall.returnValue, tracer);
-      assert.deepEqual(getTracerStub.firstCall.args, ['test', 'v0']);
+      assert.deepStrictEqual(getTracerStub.firstCall.args, [
+        'test',
+        'v0',
+        undefined,
+      ]);
+    });
+
+    it('should return tracers directly from the delegate with schema url', () => {
+      const tracer = provider.getTracer('test', 'v0', {
+        schemaUrl: 'https://opentelemetry.io/schemas/1.7.0',
+      });
+
+      sandbox.assert.calledOnce(getTracerStub);
+      assert.strictEqual(getTracerStub.firstCall.returnValue, tracer);
+      assert.deepStrictEqual(getTracerStub.firstCall.args, [
+        'test',
+        'v0',
+        { schemaUrl: 'https://opentelemetry.io/schemas/1.7.0' },
+      ]);
     });
   });