@opentelemetry/api - npm Package Compare versions

Comparing version 0.13.0 to 0.14.0

build/src/api/propagation.d.ts

@@ -19,15 +19,15 @@ import { Context } from '@opentelemetry/context-base';
      *
+     * @param context Context carrying tracing data to inject
      * @param carrier carrier to inject context into
      * @param setter Function used to set values on the carrier
-     * @param context Context carrying tracing data to inject. Defaults to the currently active context.
      */
-    inject<Carrier>(carrier: Carrier, setter?: TextMapSetter<Carrier>, context?: Context): void;
+    inject<Carrier>(context: Context, carrier: Carrier, setter?: TextMapSetter<Carrier>): void;
     /**
      * Extract context from a carrier
      *
+     * @param context Context which the newly created context will inherit from
      * @param carrier Carrier to extract context from
      * @param getter Function used to extract keys from a carrier
-     * @param context Context which the newly created context will inherit from. Defaults to the currently active context.
      */
-    extract<Carrier>(carrier: Carrier, getter?: TextMapGetter<Carrier>, context?: Context): Context;
+    extract<Carrier>(context: Context, carrier: Carrier, getter?: TextMapGetter<Carrier>): Context;
     /** Remove the global propagator */
@@ -34,0 +34,0 @@ disable(): void;

build/src/api/propagation.js

@@ -21,5 +21,3 @@ "use strict";
 var TextMapPropagator_1 = require("../context/propagation/TextMapPropagator");
-var context_1 = require("./context");
 var global_utils_1 = require("./global-utils");
-var contextApi = context_1.ContextAPI.getInstance();
 /**
@@ -53,9 +51,8 @@ * Singleton object which represents the entry point to the OpenTelemetry Propagation API
      *
+     * @param context Context carrying tracing data to inject
      * @param carrier carrier to inject context into
      * @param setter Function used to set values on the carrier
-     * @param context Context carrying tracing data to inject. Defaults to the currently active context.
      */
-    PropagationAPI.prototype.inject = function (carrier, setter, context) {
+    PropagationAPI.prototype.inject = function (context, carrier, setter) {
         if (setter === void 0) { setter = TextMapPropagator_1.defaultTextMapSetter; }
-        if (context === void 0) { context = contextApi.active(); }
         return this._getGlobalPropagator().inject(context, carrier, setter);
@@ -66,9 +63,8 @@ };
      *
+     * @param context Context which the newly created context will inherit from
      * @param carrier Carrier to extract context from
      * @param getter Function used to extract keys from a carrier
-     * @param context Context which the newly created context will inherit from. Defaults to the currently active context.
      */
-    PropagationAPI.prototype.extract = function (carrier, getter, context) {
+    PropagationAPI.prototype.extract = function (context, carrier, getter) {
         if (getter === void 0) { getter = TextMapPropagator_1.defaultTextMapGetter; }
-        if (context === void 0) { context = contextApi.active(); }
         return this._getGlobalPropagator().extract(context, carrier, getter);
@@ -75,0 +71,0 @@ };

build/src/context/context.d.ts

@@ -1,3 +0,3 @@
-import { Span, SpanContext } from '../';
 import { Context } from '@opentelemetry/context-base';
+import { Baggage, Span, SpanContext } from '../';
 /**
@@ -53,2 +53,12 @@ * Return the active span if one exists
 export declare function isInstrumentationSuppressed(context: Context): boolean;
+/**
+ * @param {Context} Context that manage all context values
+ * @returns {Baggage} Extracted baggage from the context
+ */
+export declare function getBaggage(context: Context): Baggage | undefined;
+/**
+ * @param {Context} Context that manage all context values
+ * @param {Baggage} baggage that will be set in the actual context
+ */
+export declare function setBaggage(context: Context, baggage: Baggage): Context;
 //# sourceMappingURL=context.d.ts.map

build/src/context/context.js

@@ -18,5 +18,5 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isInstrumentationSuppressed = exports.unsuppressInstrumentation = exports.suppressInstrumentation = exports.getParentSpanContext = exports.setExtractedSpanContext = exports.setActiveSpan = exports.getActiveSpan = void 0;
+exports.setBaggage = exports.getBaggage = exports.isInstrumentationSuppressed = exports.unsuppressInstrumentation = exports.suppressInstrumentation = exports.getParentSpanContext = exports.setExtractedSpanContext = exports.setActiveSpan = exports.getActiveSpan = void 0;
+var context_base_1 = require("@opentelemetry/context-base");
 var __1 = require("../");
-var context_base_1 = require("@opentelemetry/context-base");
 /**
@@ -32,2 +32,6 @@ * Active span key
 /**
+ * Baggage key
+ */
+var BAGGAGE_KEY = context_base_1.createContextKey('OpenTelemetry Baggage Key');
+/**
  * Return the active span if one exists
@@ -104,2 +108,18 @@ *
 exports.isInstrumentationSuppressed = isInstrumentationSuppressed;
+/**
+ * @param {Context} Context that manage all context values
+ * @returns {Baggage} Extracted baggage from the context
+ */
+function getBaggage(context) {
+    return context.getValue(BAGGAGE_KEY) || undefined;
+}
+exports.getBaggage = getBaggage;
+/**
+ * @param {Context} Context that manage all context values
+ * @param {Baggage} baggage that will be set in the actual context
+ */
+function setBaggage(context, baggage) {
+    return context.setValue(BAGGAGE_KEY, baggage);
+}
+exports.setBaggage = setBaggage;
 //# sourceMappingURL=context.js.map

build/src/index.d.ts

@@ -7,4 +7,4 @@ export * from './common/Exception';
 export * from './context/propagation/NoopTextMapPropagator';
-export * from './correlation_context/CorrelationContext';
-export * from './correlation_context/EntryValue';
+export * from './baggage/Baggage';
+export * from './baggage/EntryValue';
 export * from './metrics/BatchObserverResult';
@@ -21,3 +21,2 @@ export * from './metrics/BoundInstrument';
 export * from './trace/Event';
-export * from './trace/instrumentation/Plugin';
 export * from './trace/link_context';
@@ -24,0 +23,0 @@ export * from './trace/link';

build/src/index.js

@@ -35,4 +35,4 @@ "use strict";
 __exportStar(require("./context/propagation/NoopTextMapPropagator"), exports);
-__exportStar(require("./correlation_context/CorrelationContext"), exports);
-__exportStar(require("./correlation_context/EntryValue"), exports);
+__exportStar(require("./baggage/Baggage"), exports);
+__exportStar(require("./baggage/EntryValue"), exports);
 __exportStar(require("./metrics/BatchObserverResult"), exports);
@@ -49,3 +49,2 @@ __exportStar(require("./metrics/BoundInstrument"), exports);
 __exportStar(require("./trace/Event"), exports);
-__exportStar(require("./trace/instrumentation/Plugin"), exports);
 __exportStar(require("./trace/link_context"), exports);
@@ -52,0 +51,0 @@ __exportStar(require("./trace/link"), exports);

build/src/metrics/Meter.d.ts

 import { BatchObserverResult } from './BatchObserverResult';
-import { MetricOptions, Counter, ValueRecorder, ValueObserver, BatchObserver, BatchMetricOptions, UpDownCounter, SumObserver, UpDownSumObserver } from './Metric';
+import { MetricOptions, Counter, ValueRecorder, ValueObserver, BatchObserverOptions, UpDownCounter, SumObserver, UpDownSumObserver } from './Metric';
 import { ObserverResult } from './ObserverResult';
@@ -66,10 +66,9 @@ /**
     /**
-     * Creates a new `BatchObserver` metric, can be used to update many metrics
+     * Creates a new `BatchObserver`, can be used to update many metrics
      * at the same time and when operations needs to be async
-     * @param name the name of the metric.
      * @param callback the batch observer callback
-     * @param [options] the metric batch options.
+     * @param [options] the batch observer options.
      */
-    createBatchObserver(name: string, callback: (batchObserverResult: BatchObserverResult) => void, options?: BatchMetricOptions): BatchObserver;
+    createBatchObserver(callback: (batchObserverResult: BatchObserverResult) => void, options?: BatchObserverOptions): void;
 }
 //# sourceMappingURL=Meter.d.ts.map

build/src/metrics/Metric.d.ts

@@ -40,3 +40,3 @@ import { BoundBaseObserver, BoundCounter, BoundValueRecorder } from './BoundInstrument';
 }
-export interface BatchMetricOptions extends MetricOptions {
+export interface BatchObserverOptions {
     /**
@@ -46,2 +46,6 @@ * Indicates how long the batch metric should wait to update before cancel
     maxTimeoutUpdateMS?: number;
+    /**
+     * User provided logger.
+     */
+    logger?: Logger;
 }
@@ -128,4 +132,2 @@ /** The Type of value. It describes how the data is reported. */
 export declare type SumObserver = BaseObserver;
-/** Base interface for the Batch Observer metrics. */
-export declare type BatchObserver = Metric;
 /**
@@ -132,0 +134,0 @@ * key-value pairs passed by the user.

build/src/metrics/NoopMeter.d.ts

 import { BatchObserverResult } from './BatchObserverResult';
 import { Meter } from './Meter';
-import { MetricOptions, UnboundMetric, Labels, Counter, ValueRecorder, ValueObserver, BatchObserver, UpDownCounter, BaseObserver, UpDownSumObserver } from './Metric';
+import { MetricOptions, UnboundMetric, Labels, Counter, ValueRecorder, ValueObserver, UpDownCounter, BaseObserver, UpDownSumObserver } from './Metric';
 import { BoundValueRecorder, BoundCounter, BoundBaseObserver } from './BoundInstrument';
-import { CorrelationContext } from '../correlation_context/CorrelationContext';
+import { Baggage } from '../baggage/Baggage';
 import { SpanContext } from '../trace/span_context';
@@ -58,3 +58,3 @@ import { ObserverResult } from './ObserverResult';
      */
-    createBatchObserver(_name: string, _callback: (batchObserverResult: BatchObserverResult) => void): BatchObserver;
+    createBatchObserver(_callback: (batchObserverResult: BatchObserverResult) => void): NoopBatchObserver;
 }
@@ -94,3 +94,3 @@ export declare class NoopMetric<T> implements UnboundMetric<T> {
 }
-export declare class NoopBatchObserverMetric extends NoopMetric<void> implements BatchObserver {
+export declare class NoopBatchObserver {
 }
@@ -101,3 +101,3 @@ export declare class NoopBoundCounter implements BoundCounter {
 export declare class NoopBoundValueRecorder implements BoundValueRecorder {
-    record(_value: number, _correlationContext?: CorrelationContext, _spanContext?: SpanContext): void;
+    record(_value: number, _baggage?: Baggage, _spanContext?: SpanContext): void;
 }
@@ -116,3 +116,3 @@ export declare class NoopBoundBaseObserver implements BoundBaseObserver {
 export declare const NOOP_SUM_OBSERVER_METRIC: NoopBaseObserverMetric;
-export declare const NOOP_BATCH_OBSERVER_METRIC: NoopBatchObserverMetric;
+export declare const NOOP_BATCH_OBSERVER: NoopBatchObserver;
 //# sourceMappingURL=NoopMeter.d.ts.map

build/src/metrics/NoopMeter.js

@@ -31,3 +31,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NOOP_BATCH_OBSERVER_METRIC = exports.NOOP_SUM_OBSERVER_METRIC = exports.NOOP_UP_DOWN_SUM_OBSERVER_METRIC = exports.NOOP_VALUE_OBSERVER_METRIC = exports.NOOP_BOUND_BASE_OBSERVER = exports.NOOP_VALUE_RECORDER_METRIC = exports.NOOP_BOUND_VALUE_RECORDER = exports.NOOP_COUNTER_METRIC = exports.NOOP_BOUND_COUNTER = exports.NOOP_METER = exports.NoopBoundBaseObserver = exports.NoopBoundValueRecorder = exports.NoopBoundCounter = exports.NoopBatchObserverMetric = exports.NoopBaseObserverMetric = exports.NoopValueRecorderMetric = exports.NoopCounterMetric = exports.NoopMetric = exports.NoopMeter = void 0;
+exports.NOOP_BATCH_OBSERVER = exports.NOOP_SUM_OBSERVER_METRIC = exports.NOOP_UP_DOWN_SUM_OBSERVER_METRIC = exports.NOOP_VALUE_OBSERVER_METRIC = exports.NOOP_BOUND_BASE_OBSERVER = exports.NOOP_VALUE_RECORDER_METRIC = exports.NOOP_BOUND_VALUE_RECORDER = exports.NOOP_COUNTER_METRIC = exports.NOOP_BOUND_COUNTER = exports.NOOP_METER = exports.NoopBoundBaseObserver = exports.NoopBoundValueRecorder = exports.NoopBoundCounter = exports.NoopBatchObserver = exports.NoopBaseObserverMetric = exports.NoopValueRecorderMetric = exports.NoopCounterMetric = exports.NoopMetric = exports.NoopMeter = void 0;
 /**
@@ -96,4 +96,4 @@ * NoopMeter is a noop implementation of the {@link Meter} interface. It reuses
      */
-    NoopMeter.prototype.createBatchObserver = function (_name, _callback) {
-        return exports.NOOP_BATCH_OBSERVER_METRIC;
+    NoopMeter.prototype.createBatchObserver = function (_callback) {
+        return exports.NOOP_BATCH_OBSERVER;
     };
@@ -169,10 +169,8 @@ return NoopMeter;
 exports.NoopBaseObserverMetric = NoopBaseObserverMetric;
-var NoopBatchObserverMetric = /** @class */ (function (_super) {
-    __extends(NoopBatchObserverMetric, _super);
-    function NoopBatchObserverMetric() {
-        return _super !== null && _super.apply(this, arguments) || this;
+var NoopBatchObserver = /** @class */ (function () {
+    function NoopBatchObserver() {
     }
-    return NoopBatchObserverMetric;
-}(NoopMetric));
-exports.NoopBatchObserverMetric = NoopBatchObserverMetric;
+    return NoopBatchObserver;
+}());
+exports.NoopBatchObserver = NoopBatchObserver;
 var NoopBoundCounter = /** @class */ (function () {
@@ -190,3 +188,3 @@ function NoopBoundCounter() {
     }
-    NoopBoundValueRecorder.prototype.record = function (_value, _correlationContext, _spanContext) {
+    NoopBoundValueRecorder.prototype.record = function (_value, _baggage, _spanContext) {
         return;
@@ -213,3 +211,3 @@ };
 exports.NOOP_SUM_OBSERVER_METRIC = new NoopBaseObserverMetric(exports.NOOP_BOUND_BASE_OBSERVER);
-exports.NOOP_BATCH_OBSERVER_METRIC = new NoopBatchObserverMetric();
+exports.NOOP_BATCH_OBSERVER = new NoopBatchObserver();
 //# sourceMappingURL=NoopMeter.js.map

build/src/trace/span_context.d.ts

 import { TraceState } from './trace_state';
 /**
  * A SpanContext represents the portion of a {@link Span} which must be
- * serialized and propagated along side of a {@link CorrelationContext}.
+ * serialized and propagated along side of a {@link Baggage}.
  */
@@ -6,0 +6,0 @@ export interface SpanContext {

build/src/version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "0.13.0";
+export declare const VERSION = "0.14.0";
 //# sourceMappingURL=version.d.ts.map

build/src/version.js

@@ -20,3 +20,3 @@ "use strict";
 // this is autogenerated file, see scripts/version-update.js
-exports.VERSION = '0.13.0';
+exports.VERSION = '0.14.0';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "@opentelemetry/api",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "Public API for OpenTelemetry",
@@ -55,7 +55,7 @@ "main": "build/src/index.js",
   "dependencies": {
-    "@opentelemetry/context-base": "^0.13.0"
+    "@opentelemetry/context-base": "^0.14.0"
   },
   "devDependencies": {
-    "@types/mocha": "8.0.4",
-    "@types/node": "14.14.10",
+    "@types/mocha": "8.2.0",
+    "@types/node": "14.14.12",
     "@types/sinon": "9.0.9",
@@ -72,7 +72,7 @@ "@types/webpack-env": "1.16.0",
     "karma-webpack": "4.0.2",
-    "linkinator": "2.4.0",
+    "linkinator": "2.8.0",
     "mocha": "7.2.0",
     "nyc": "15.1.0",
-    "sinon": "9.2.1",
-    "ts-loader": "8.0.11",
+    "sinon": "9.2.2",
+    "ts-loader": "8.0.12",
     "ts-mocha": "8.0.0",
@@ -83,3 +83,3 @@ "typedoc": "0.19.2",
   },
-  "gitHead": "86cbd6798f9318c5920f9d9055f289a1c3f26500"
+  "gitHead": "27a8d4530c56257c191468b073669909bf8892a1"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

185200

decreased by-1.83%

Number of package files

159

decreased by-1.85%

Lines of code

3353

decreased by-1.87%

Dependency changes

• + Added@opentelemetry/context-base@0.14.0(transitive)

• - Removed@opentelemetry/context-base@0.13.0(transitive)

• Updated@opentelemetry/context-base@^0.14.0