Merge remote-tracking branch 'origin/master' into renovate/all-minor-patch

Author: dyladan

CONTRIBUTING.md

@@ -187,13 +187,15 @@ After adding the package, run `npm install` from the root of the project. This w
 - No “changes requested” reviews.
 - No unresolved conversations.
 - 3 approvals, including the approvals of at least 2 maintainers
-  - A pull request opened by an approver may be merged with only 2 reviews.
+  - A pull request opened by an approver may be merged with only the 2 maintainer reviews.
   - Small (simple typo, URL, update docs, or grammatical fix) or high-priority changes may be merged more quickly or with fewer reviewers at the discretion of the maintainers. This is typically indicated with the express label.
 - For plugins, exporters, and propagators approval of the original code module author is preferred but not required.
 - New or changed functionality is tested by unit tests.
 - New or changed functionality is documented.
 - Substantial changes should not be merged within 24 hours of opening in order to allow reviewers from all time zones to have a chance to review.
 
+If all of the above requirements are met and there are no unresolved discussions, a pull request may be merged by either a maintainer or an approver.
+
 ### Generating API documentation
 
 - `npm run docs` to generate API documentation. Generates the documentation in `packages/opentelemetry-api/docs/out`

README.md

@@ -134,6 +134,7 @@ Approvers ([@open-telemetry/js-approvers](https://github.com/orgs/open-telemetry
 - [Matthew Wear](https://github.com/mwear), LightStep
 - [Naseem K. Ullah](https://github.com/naseemkullah), Transit
 - [Chengzhong Wu](https://github.com/legendecas), Alibaba
+- [Gerhard Stöbich](https://github.com/Flarna), Dynatrace
 
 *Find more about the approver role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver).*
 

packages/opentelemetry-api/src/api/propagation.ts

@@ -96,6 +96,13 @@ export class PropagationAPI {
     return this._getGlobalPropagator().extract(context, carrier, getter);
   }
 
+  /**
+   * Return a list of all fields which may be used by the propagator.
+   */
+  public fields(): string[] {
+    return this._getGlobalPropagator().fields();
+  }
+
   /** Remove the global propagator */
   public disable() {
     delete _global[GLOBAL_PROPAGATION_API_KEY];

packages/opentelemetry-api/src/context/propagation/TextMapPropagator.ts

@@ -67,9 +67,6 @@ export interface TextMapPropagator<Carrier = any> {
 
   /**
    * Return a list of all fields which may be used by the propagator.
-   *
-   * This list should be used to clear fields before calling inject if a carrier is
-   * used more than once.
    */
   fields(): string[];
 }

packages/opentelemetry-api/src/trace/ProxyTracer.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import { Context } from '@opentelemetry/context-base';
 import { Span, SpanOptions, Tracer } from '..';
 import { NOOP_TRACER } from './NoopTracer';
 import { ProxyTracerProvider } from './ProxyTracerProvider';
@@ -31,8 +32,8 @@ export class ProxyTracer implements Tracer {
     public readonly version?: string
   ) {}
 
-  startSpan(name: string, options?: SpanOptions): Span {
-    return this._getTracer().startSpan(name, options);
+  startSpan(name: string, options?: SpanOptions, context?: Context): Span {
+    return this._getTracer().startSpan(name, options, context);
   }
 
   /**

packages/opentelemetry-api/src/trace/SpanOptions.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import { TimeInput } from '../common/Time';
 import { Attributes } from './attributes';
 import { Link } from './link';
 import { SpanKind } from './span_kind';
@@ -35,7 +36,7 @@ export interface SpanOptions {
   links?: Link[];
 
   /** A manually specified start time for the created `Span` object. */
-  startTime?: number;
+  startTime?: TimeInput;
 
   /** The new span should be a root span. (Ignore parent from context). */
   root?: boolean;

packages/opentelemetry-api/test/api/api.test.ts

@@ -150,6 +150,13 @@ describe('API', () => {
         assert.strictEqual(data.carrier, carrier);
         assert.strictEqual(data.getter, getter);
       });
+
+      it('fields', () => {
+        api.propagation.setGlobalPropagator(new TestTextMapPropagation());
+
+        const fields = api.propagation.fields();
+        assert.deepStrictEqual(fields, ['TestField']);
+      });
     });
   });
 });

packages/opentelemetry-api/test/proxy-implementations/proxy-tracer.test.ts

@@ -26,15 +26,22 @@ import {
   Tracer,
   Span,
   NoopTracer,
+  ROOT_CONTEXT,
+  SpanOptions,
 } from '../../src';
 
 describe('ProxyTracer', () => {
   let provider: ProxyTracerProvider;
+  const sandbox = sinon.createSandbox();
 
   beforeEach(() => {
     provider = new ProxyTracerProvider();
   });
 
+  afterEach(() => {
+    sandbox.restore();
+  });
+
   describe('when no delegate is set', () => {
     it('should return proxy tracers', () => {
       const tracer = provider.getTracer('test');
@@ -61,7 +68,6 @@ describe('ProxyTracer', () => {
 
   describe('when delegate is set before getTracer', () => {
     let delegate: TracerProvider;
-    const sandbox = sinon.createSandbox();
     let getTracerStub: sinon.SinonStub;
 
     beforeEach(() => {
@@ -72,10 +78,6 @@ describe('ProxyTracer', () => {
       provider.setDelegate(delegate);
     });
 
-    afterEach(() => {
-      sandbox.restore();
-    });
-
     it('should return tracers directly from the delegate', () => {
       const tracer = provider.getTracer('test', 'v0');
 
@@ -114,5 +116,25 @@ describe('ProxyTracer', () => {
 
       assert.strictEqual(span, delegateSpan);
     });
+
+    it('should pass original arguments to DelegateTracer#startSpan', () => {
+      const startSpanStub = sandbox.stub(delegateTracer, 'startSpan');
+
+      const name = 'name1';
+      const options: SpanOptions = {};
+      const ctx = ROOT_CONTEXT.setValue(Symbol('test'), 1);
+      tracer.startSpan(name, options, ctx);
+
+      // Assert the proxy tracer has the full API of the NoopTracer
+      assert.strictEqual(
+        NoopTracer.prototype.startSpan.length,
+        ProxyTracer.prototype.startSpan.length
+      );
+      assert.deepStrictEqual(Object.getOwnPropertyNames(NoopTracer.prototype), [
+        'constructor',
+        'startSpan',
+      ]);
+      sandbox.assert.calledOnceWithExactly(startSpanStub, name, options, ctx);
+    });
   });
 });

packages/opentelemetry-core/src/platform/browser/environment.ts

@@ -17,15 +17,15 @@
 import {
   DEFAULT_ENVIRONMENT,
   ENVIRONMENT,
-  ENVIRONMENT_MAP,
+  RAW_ENVIRONMENT,
   parseEnvironment,
 } from '../../utils/environment';
 
 /**
  * Gets the environment variables
  */
 export function getEnv(): Required<ENVIRONMENT> {
-  const _window = window as typeof window & ENVIRONMENT_MAP;
+  const _window = window as typeof window & RAW_ENVIRONMENT;
   const globalEnv = parseEnvironment(_window);
   return Object.assign({}, DEFAULT_ENVIRONMENT, globalEnv);
 }

packages/opentelemetry-core/src/platform/node/environment.ts

@@ -14,17 +14,24 @@
  * limitations under the License.
  */
 
+import * as os from 'os';
 import {
   DEFAULT_ENVIRONMENT,
   ENVIRONMENT,
-  ENVIRONMENT_MAP,
+  RAW_ENVIRONMENT,
   parseEnvironment,
 } from '../../utils/environment';
 
 /**
  * Gets the environment variables
  */
 export function getEnv(): Required<ENVIRONMENT> {
-  const processEnv = parseEnvironment(process.env as ENVIRONMENT_MAP);
-  return Object.assign({}, DEFAULT_ENVIRONMENT, processEnv);
+  const processEnv = parseEnvironment(process.env as RAW_ENVIRONMENT);
+  return Object.assign(
+    {
+      HOSTNAME: os.hostname(),
+    },
+    DEFAULT_ENVIRONMENT,
+    processEnv
+  );
 }