@opentelemetry/api 1.5.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/esm/index.d.ts +1 -1
- package/build/esm/index.js.map +1 -1
- package/build/esm/metrics/Metric.d.ts +16 -0
- package/build/esm/metrics/Metric.js.map +1 -1
- package/build/esm/trace/NonRecordingSpan.d.ts +1 -1
- package/build/esm/trace/NonRecordingSpan.js +1 -1
- package/build/esm/trace/NonRecordingSpan.js.map +1 -1
- package/build/esm/trace/span.d.ts +0 -8
- package/build/esm/trace/span.js.map +1 -1
- package/build/esm/version.d.ts +1 -1
- package/build/esm/version.js +1 -1
- package/build/esm/version.js.map +1 -1
- package/build/esnext/api/context.d.ts +41 -0
- package/build/esnext/api/context.js +77 -0
- package/build/esnext/api/context.js.map +1 -0
- package/build/esnext/api/diag.d.ts +30 -0
- package/build/esnext/api/diag.js +89 -0
- package/build/esnext/api/diag.js.map +1 -0
- package/build/esnext/api/metrics.d.ts +28 -0
- package/build/esnext/api/metrics.js +57 -0
- package/build/esnext/api/metrics.js.map +1 -0
- package/build/esnext/api/propagation.d.ts +49 -0
- package/build/esnext/api/propagation.js +85 -0
- package/build/esnext/api/propagation.js.map +1 -0
- package/build/esnext/api/trace.d.ts +40 -0
- package/build/esnext/api/trace.js +75 -0
- package/build/esnext/api/trace.js.map +1 -0
- package/build/esnext/baggage/context-helpers.d.ts +29 -0
- package/build/esnext/baggage/context-helpers.js +56 -0
- package/build/esnext/baggage/context-helpers.js.map +1 -0
- package/build/esnext/baggage/internal/baggage-impl.d.ts +12 -0
- package/build/esnext/baggage/internal/baggage-impl.js +51 -0
- package/build/esnext/baggage/internal/baggage-impl.js.map +1 -0
- package/build/esnext/baggage/internal/symbol.d.ts +5 -0
- package/build/esnext/baggage/internal/symbol.js +20 -0
- package/build/esnext/baggage/internal/symbol.js.map +1 -0
- package/build/esnext/baggage/types.d.ts +60 -0
- package/build/esnext/baggage/types.js +17 -0
- package/build/esnext/baggage/types.js.map +1 -0
- package/build/esnext/baggage/utils.d.ts +15 -0
- package/build/esnext/baggage/utils.js +46 -0
- package/build/esnext/baggage/utils.js.map +1 -0
- package/build/esnext/common/Attributes.d.ts +15 -0
- package/build/esnext/common/Attributes.js +17 -0
- package/build/esnext/common/Attributes.js.map +1 -0
- package/build/esnext/common/Exception.d.ts +26 -0
- package/build/esnext/common/Exception.js +17 -0
- package/build/esnext/common/Exception.js.map +1 -0
- package/build/esnext/common/Time.d.ts +20 -0
- package/build/esnext/common/Time.js +2 -0
- package/build/esnext/common/Time.js.map +1 -0
- package/build/esnext/context/NoopContextManager.d.ts +9 -0
- package/build/esnext/context/NoopContextManager.js +34 -0
- package/build/esnext/context/NoopContextManager.js.map +1 -0
- package/build/esnext/context/context.d.ts +6 -0
- package/build/esnext/context/context.js +51 -0
- package/build/esnext/context/context.js.map +1 -0
- package/build/esnext/context/types.d.ts +52 -0
- package/build/esnext/context/types.js +17 -0
- package/build/esnext/context/types.js.map +1 -0
- package/build/esnext/context-api.d.ts +4 -0
- package/build/esnext/context-api.js +21 -0
- package/build/esnext/context-api.js.map +1 -0
- package/build/esnext/diag/ComponentLogger.d.ts +20 -0
- package/build/esnext/diag/ComponentLogger.js +55 -0
- package/build/esnext/diag/ComponentLogger.js.map +1 -0
- package/build/esnext/diag/consoleLogger.d.ts +38 -0
- package/build/esnext/diag/consoleLogger.js +53 -0
- package/build/esnext/diag/consoleLogger.js.map +1 -0
- package/build/esnext/diag/internal/logLevelLogger.d.ts +3 -0
- package/build/esnext/diag/internal/logLevelLogger.js +41 -0
- package/build/esnext/diag/internal/logLevelLogger.js.map +1 -0
- package/build/esnext/diag/internal/noopLogger.d.ts +8 -0
- package/build/esnext/diag/internal/noopLogger.js +31 -0
- package/build/esnext/diag/internal/noopLogger.js.map +1 -0
- package/build/esnext/diag/types.d.ts +100 -0
- package/build/esnext/diag/types.js +41 -0
- package/build/esnext/diag/types.js.map +1 -0
- package/build/esnext/diag-api.d.ts +9 -0
- package/build/esnext/diag-api.js +26 -0
- package/build/esnext/diag-api.js.map +1 -0
- package/build/esnext/index.d.ts +54 -0
- package/build/esnext/index.js +53 -0
- package/build/esnext/index.js.map +1 -0
- package/build/esnext/internal/global-utils.d.ts +18 -0
- package/build/esnext/internal/global-utils.js +58 -0
- package/build/esnext/internal/global-utils.js.map +1 -0
- package/build/esnext/internal/semver.d.ts +34 -0
- package/build/esnext/internal/semver.js +118 -0
- package/build/esnext/internal/semver.js.map +1 -0
- package/build/esnext/metrics/Meter.d.ts +104 -0
- package/build/esnext/metrics/Meter.js +17 -0
- package/build/esnext/metrics/Meter.js.map +1 -0
- package/build/esnext/metrics/MeterProvider.d.ts +17 -0
- package/build/esnext/metrics/MeterProvider.js +17 -0
- package/build/esnext/metrics/MeterProvider.js.map +1 -0
- package/build/esnext/metrics/Metric.d.ts +109 -0
- package/build/esnext/metrics/Metric.js +22 -0
- package/build/esnext/metrics/Metric.js.map +1 -0
- package/build/esnext/metrics/NoopMeter.d.ts +74 -0
- package/build/esnext/metrics/NoopMeter.js +103 -0
- package/build/esnext/metrics/NoopMeter.js.map +1 -0
- package/build/esnext/metrics/NoopMeterProvider.d.ts +11 -0
- package/build/esnext/metrics/NoopMeterProvider.js +27 -0
- package/build/esnext/metrics/NoopMeterProvider.js.map +1 -0
- package/build/esnext/metrics/ObservableResult.d.ts +31 -0
- package/build/esnext/metrics/ObservableResult.js +17 -0
- package/build/esnext/metrics/ObservableResult.js.map +1 -0
- package/build/esnext/metrics-api.d.ts +4 -0
- package/build/esnext/metrics-api.js +21 -0
- package/build/esnext/metrics-api.js.map +1 -0
- package/build/esnext/platform/browser/globalThis.d.ts +10 -0
- package/build/esnext/platform/browser/globalThis.js +35 -0
- package/build/esnext/platform/browser/globalThis.js.map +1 -0
- package/build/esnext/platform/browser/index.d.ts +2 -0
- package/build/esnext/platform/browser/index.js +17 -0
- package/build/esnext/platform/browser/index.js.map +1 -0
- package/build/esnext/platform/index.d.ts +2 -0
- package/build/esnext/platform/index.js +17 -0
- package/build/esnext/platform/index.js.map +1 -0
- package/build/esnext/platform/node/globalThis.d.ts +3 -0
- package/build/esnext/platform/node/globalThis.js +19 -0
- package/build/esnext/platform/node/globalThis.js.map +1 -0
- package/build/esnext/platform/node/index.d.ts +2 -0
- package/build/esnext/platform/node/index.js +17 -0
- package/build/esnext/platform/node/index.js.map +1 -0
- package/build/esnext/propagation/NoopTextMapPropagator.d.ts +13 -0
- package/build/esnext/propagation/NoopTextMapPropagator.js +30 -0
- package/build/esnext/propagation/NoopTextMapPropagator.js.map +1 -0
- package/build/esnext/propagation/TextMapPropagator.d.ts +84 -0
- package/build/esnext/propagation/TextMapPropagator.js +38 -0
- package/build/esnext/propagation/TextMapPropagator.js.map +1 -0
- package/build/esnext/propagation-api.d.ts +4 -0
- package/build/esnext/propagation-api.js +21 -0
- package/build/esnext/propagation-api.js.map +1 -0
- package/build/esnext/trace/NonRecordingSpan.d.ts +25 -0
- package/build/esnext/trace/NonRecordingSpan.js +59 -0
- package/build/esnext/trace/NonRecordingSpan.js.map +1 -0
- package/build/esnext/trace/NoopTracer.d.ts +14 -0
- package/build/esnext/trace/NoopTracer.js +71 -0
- package/build/esnext/trace/NoopTracer.js.map +1 -0
- package/build/esnext/trace/NoopTracerProvider.d.ts +13 -0
- package/build/esnext/trace/NoopTracerProvider.js +28 -0
- package/build/esnext/trace/NoopTracerProvider.js.map +1 -0
- package/build/esnext/trace/ProxyTracer.d.ts +27 -0
- package/build/esnext/trace/ProxyTracer.js +51 -0
- package/build/esnext/trace/ProxyTracer.js.map +1 -0
- package/build/esnext/trace/ProxyTracerProvider.d.ts +25 -0
- package/build/esnext/trace/ProxyTracerProvider.js +50 -0
- package/build/esnext/trace/ProxyTracerProvider.js.map +1 -0
- package/build/esnext/trace/Sampler.d.ts +31 -0
- package/build/esnext/trace/Sampler.js +17 -0
- package/build/esnext/trace/Sampler.js.map +1 -0
- package/build/esnext/trace/SamplingResult.d.ts +49 -0
- package/build/esnext/trace/SamplingResult.js +39 -0
- package/build/esnext/trace/SamplingResult.js.map +1 -0
- package/build/esnext/trace/SpanOptions.d.ts +23 -0
- package/build/esnext/trace/SpanOptions.js +17 -0
- package/build/esnext/trace/SpanOptions.js.map +1 -0
- package/build/esnext/trace/attributes.d.ts +10 -0
- package/build/esnext/trace/attributes.js +17 -0
- package/build/esnext/trace/attributes.js.map +1 -0
- package/build/esnext/trace/context-utils.d.ts +41 -0
- package/build/esnext/trace/context-utils.js +73 -0
- package/build/esnext/trace/context-utils.js.map +1 -0
- package/build/esnext/trace/internal/tracestate-impl.d.ts +22 -0
- package/build/esnext/trace/internal/tracestate-impl.js +99 -0
- package/build/esnext/trace/internal/tracestate-impl.js.map +1 -0
- package/build/esnext/trace/internal/tracestate-validators.d.ts +15 -0
- package/build/esnext/trace/internal/tracestate-validators.js +41 -0
- package/build/esnext/trace/internal/tracestate-validators.js.map +1 -0
- package/build/esnext/trace/internal/utils.d.ts +3 -0
- package/build/esnext/trace/internal/utils.js +20 -0
- package/build/esnext/trace/internal/utils.js.map +1 -0
- package/build/esnext/trace/invalid-span-constants.d.ts +5 -0
- package/build/esnext/trace/invalid-span-constants.js +24 -0
- package/build/esnext/trace/invalid-span-constants.js.map +1 -0
- package/build/esnext/trace/link.d.ts +26 -0
- package/build/esnext/trace/link.js +17 -0
- package/build/esnext/trace/link.js.map +1 -0
- package/build/esnext/trace/span.d.ts +101 -0
- package/build/esnext/trace/span.js +17 -0
- package/build/esnext/trace/span.js.map +1 -0
- package/build/esnext/trace/span_context.d.ts +53 -0
- package/build/esnext/trace/span_context.js +17 -0
- package/build/esnext/trace/span_context.js.map +1 -0
- package/build/esnext/trace/span_kind.d.ts +27 -0
- package/build/esnext/trace/span_kind.js +43 -0
- package/build/esnext/trace/span_kind.js.map +1 -0
- package/build/esnext/trace/spancontext-utils.d.ts +17 -0
- package/build/esnext/trace/spancontext-utils.js +42 -0
- package/build/esnext/trace/spancontext-utils.js.map +1 -0
- package/build/esnext/trace/status.d.ts +25 -0
- package/build/esnext/trace/status.js +20 -0
- package/build/esnext/trace/status.js.map +1 -0
- package/build/esnext/trace/trace_flags.d.ts +7 -0
- package/build/esnext/trace/trace_flags.js +23 -0
- package/build/esnext/trace/trace_flags.js.map +1 -0
- package/build/esnext/trace/trace_state.d.ts +38 -0
- package/build/esnext/trace/trace_state.js +17 -0
- package/build/esnext/trace/trace_state.js.map +1 -0
- package/build/esnext/trace/tracer.d.ts +71 -0
- package/build/esnext/trace/tracer.js +17 -0
- package/build/esnext/trace/tracer.js.map +1 -0
- package/build/esnext/trace/tracer_options.d.ts +10 -0
- package/build/esnext/trace/tracer_options.js +17 -0
- package/build/esnext/trace/tracer_options.js.map +1 -0
- package/build/esnext/trace/tracer_provider.d.ts +21 -0
- package/build/esnext/trace/tracer_provider.js +17 -0
- package/build/esnext/trace/tracer_provider.js.map +1 -0
- package/build/esnext/trace-api.d.ts +4 -0
- package/build/esnext/trace-api.js +21 -0
- package/build/esnext/trace-api.js.map +1 -0
- package/build/esnext/version.d.ts +2 -0
- package/build/esnext/version.js +18 -0
- package/build/esnext/version.js.map +1 -0
- package/build/src/index.d.ts +1 -1
- package/build/src/index.js.map +1 -1
- package/build/src/metrics/Metric.d.ts +16 -0
- package/build/src/metrics/Metric.js.map +1 -1
- package/build/src/trace/NonRecordingSpan.d.ts +1 -1
- package/build/src/trace/NonRecordingSpan.js +1 -1
- package/build/src/trace/NonRecordingSpan.js.map +1 -1
- package/build/src/trace/span.d.ts +0 -8
- package/build/src/trace/span.js.map +1 -1
- package/build/src/version.d.ts +1 -1
- package/build/src/version.js +1 -1
- package/build/src/version.js.map +1 -1
- package/package.json +11 -6
package/build/esm/index.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ export type { DiagAPI } from './api/diag';
|
|
|
12
12
|
export { createNoopMeter } from './metrics/NoopMeter';
|
|
13
13
|
export { MeterOptions, Meter } from './metrics/Meter';
|
|
14
14
|
export { MeterProvider } from './metrics/MeterProvider';
|
|
15
|
-
export { ValueType, Counter, Histogram, MetricOptions, Observable, ObservableCounter, ObservableGauge, ObservableUpDownCounter, UpDownCounter, BatchObservableCallback, MetricAttributes, MetricAttributeValue, ObservableCallback, } from './metrics/Metric';
|
|
15
|
+
export { ValueType, Counter, Histogram, MetricOptions, Observable, ObservableCounter, ObservableGauge, ObservableUpDownCounter, UpDownCounter, BatchObservableCallback, MetricAdvice, MetricAttributes, MetricAttributeValue, ObservableCallback, } from './metrics/Metric';
|
|
16
16
|
export { BatchObservableResult, ObservableResult, } from './metrics/ObservableResult';
|
|
17
17
|
export type { MetricsAPI } from './api/metrics';
|
|
18
18
|
export { TextMapPropagator, TextMapSetter, TextMapGetter, defaultTextMapGetter, defaultTextMapSetter, } from './propagation/TextMapPropagator';
|
package/build/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,8BAA8B,EAAE,MAAM,iBAAiB,CAAC;AAKjE,eAAe;AACf,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAInE,YAAY;AACZ,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAGL,YAAY,GAGb,MAAM,cAAc,CAAC;AAGtB,eAAe;AACf,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EACL,SAAS,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,8BAA8B,EAAE,MAAM,iBAAiB,CAAC;AAKjE,eAAe;AACf,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAInE,YAAY;AACZ,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAGL,YAAY,GAGb,MAAM,cAAc,CAAC;AAGtB,eAAe;AACf,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EACL,SAAS,GAcV,MAAM,kBAAkB,CAAC;AAO1B,mBAAmB;AACnB,OAAO,EAIL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,iCAAiC,CAAC;AAMzC,OAAO,EAAE,WAAW,EAAmB,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,OAAO,EAAE,gBAAgB,EAAkB,MAAM,wBAAwB,CAAC;AAE1E,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG7C,OAAO,EAAc,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAI1D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,aAAa,GACd,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,cAAc,EACd,eAAe,EACf,oBAAoB,GACrB,MAAM,gCAAgC,CAAC;AAGxC,sEAAsE;AACtE,qCAAqC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,gBAAgB;AAChB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;AACtD,kBAAkB;AAClB,eAAe;IACb,OAAO,SAAA;IACP,IAAI,MAAA;IACJ,OAAO,SAAA;IACP,WAAW,aAAA;IACX,KAAK,OAAA;CACN,CAAC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport { BaggageEntry, BaggageEntryMetadata, Baggage } from './baggage/types';\nexport { baggageEntryMetadataFromString } from './baggage/utils';\nexport { Exception } from './common/Exception';\nexport { HrTime, TimeInput } from './common/Time';\nexport { Attributes, AttributeValue } from './common/Attributes';\n\n// Context APIs\nexport { createContextKey, ROOT_CONTEXT } from './context/context';\nexport { Context, ContextManager } from './context/types';\nexport type { ContextAPI } from './api/context';\n\n// Diag APIs\nexport { DiagConsoleLogger } from './diag/consoleLogger';\nexport {\n DiagLogFunction,\n DiagLogger,\n DiagLogLevel,\n ComponentLoggerOptions,\n DiagLoggerOptions,\n} from './diag/types';\nexport type { DiagAPI } from './api/diag';\n\n// Metrics APIs\nexport { createNoopMeter } from './metrics/NoopMeter';\nexport { MeterOptions, Meter } from './metrics/Meter';\nexport { MeterProvider } from './metrics/MeterProvider';\nexport {\n ValueType,\n Counter,\n Histogram,\n MetricOptions,\n Observable,\n ObservableCounter,\n ObservableGauge,\n ObservableUpDownCounter,\n UpDownCounter,\n BatchObservableCallback,\n MetricAdvice,\n MetricAttributes,\n MetricAttributeValue,\n ObservableCallback,\n} from './metrics/Metric';\nexport {\n BatchObservableResult,\n ObservableResult,\n} from './metrics/ObservableResult';\nexport type { MetricsAPI } from './api/metrics';\n\n// Propagation APIs\nexport {\n TextMapPropagator,\n TextMapSetter,\n TextMapGetter,\n defaultTextMapGetter,\n defaultTextMapSetter,\n} from './propagation/TextMapPropagator';\nexport type { PropagationAPI } from './api/propagation';\n\n// Trace APIs\nexport { SpanAttributes, SpanAttributeValue } from './trace/attributes';\nexport { Link } from './trace/link';\nexport { ProxyTracer, TracerDelegator } from './trace/ProxyTracer';\nexport { ProxyTracerProvider } from './trace/ProxyTracerProvider';\nexport { Sampler } from './trace/Sampler';\nexport { SamplingDecision, SamplingResult } from './trace/SamplingResult';\nexport { SpanContext } from './trace/span_context';\nexport { SpanKind } from './trace/span_kind';\nexport { Span } from './trace/span';\nexport { SpanOptions } from './trace/SpanOptions';\nexport { SpanStatus, SpanStatusCode } from './trace/status';\nexport { TraceFlags } from './trace/trace_flags';\nexport { TraceState } from './trace/trace_state';\nexport { createTraceState } from './trace/internal/utils';\nexport { TracerProvider } from './trace/tracer_provider';\nexport { Tracer } from './trace/tracer';\nexport { TracerOptions } from './trace/tracer_options';\nexport {\n isSpanContextValid,\n isValidTraceId,\n isValidSpanId,\n} from './trace/spancontext-utils';\nexport {\n INVALID_SPANID,\n INVALID_TRACEID,\n INVALID_SPAN_CONTEXT,\n} from './trace/invalid-span-constants';\nexport type { TraceAPI } from './api/trace';\n\n// Split module-level variable definition into separate files to allow\n// tree-shaking on each api instance.\nimport { context } from './context-api';\nimport { diag } from './diag-api';\nimport { metrics } from './metrics-api';\nimport { propagation } from './propagation-api';\nimport { trace } from './trace-api';\n\n// Named export.\nexport { context, diag, metrics, propagation, trace };\n// Default export.\nexport default {\n context,\n diag,\n metrics,\n propagation,\n trace,\n};\n"]}
|
|
@@ -1,6 +1,17 @@
|
|
|
1
1
|
import { Attributes, AttributeValue } from '../common/Attributes';
|
|
2
2
|
import { Context } from '../context/types';
|
|
3
3
|
import { BatchObservableResult, ObservableResult } from './ObservableResult';
|
|
4
|
+
/**
|
|
5
|
+
* Advisory options influencing aggregation configuration parameters.
|
|
6
|
+
* @experimental
|
|
7
|
+
*/
|
|
8
|
+
export interface MetricAdvice {
|
|
9
|
+
/**
|
|
10
|
+
* Hint the explicit bucket boundaries for SDK if the metric is been
|
|
11
|
+
* aggregated with a HistogramAggregator.
|
|
12
|
+
*/
|
|
13
|
+
explicitBucketBoundaries?: number[];
|
|
14
|
+
}
|
|
4
15
|
/**
|
|
5
16
|
* Options needed for metric creation
|
|
6
17
|
*/
|
|
@@ -20,6 +31,11 @@ export interface MetricOptions {
|
|
|
20
31
|
* @default {@link ValueType.DOUBLE}
|
|
21
32
|
*/
|
|
22
33
|
valueType?: ValueType;
|
|
34
|
+
/**
|
|
35
|
+
* The advice influencing aggregation configuration parameters.
|
|
36
|
+
* @experimental
|
|
37
|
+
*/
|
|
38
|
+
advice?: MetricAdvice;
|
|
23
39
|
}
|
|
24
40
|
/** The Type of value. It describes how the data is reported. */
|
|
25
41
|
export declare enum ValueType {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Metric.js","sourceRoot":"","sources":["../../../src/metrics/Metric.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;
|
|
1
|
+
{"version":3,"file":"Metric.js","sourceRoot":"","sources":["../../../src/metrics/Metric.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AA+CH,gEAAgE;AAChE,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,uCAAG,CAAA;IACH,6CAAM,CAAA;AACR,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Attributes, AttributeValue } from '../common/Attributes';\nimport { Context } from '../context/types';\nimport { BatchObservableResult, ObservableResult } from './ObservableResult';\n\n/**\n * Advisory options influencing aggregation configuration parameters.\n * @experimental\n */\nexport interface MetricAdvice {\n /**\n * Hint the explicit bucket boundaries for SDK if the metric is been\n * aggregated with a HistogramAggregator.\n */\n explicitBucketBoundaries?: number[];\n}\n\n/**\n * Options needed for metric creation\n */\nexport interface MetricOptions {\n /**\n * The description of the Metric.\n * @default ''\n */\n description?: string;\n\n /**\n * The unit of the Metric values.\n * @default ''\n */\n unit?: string;\n\n /**\n * Indicates the type of the recorded value.\n * @default {@link ValueType.DOUBLE}\n */\n valueType?: ValueType;\n\n /**\n * The advice influencing aggregation configuration parameters.\n * @experimental\n */\n advice?: MetricAdvice;\n}\n\n/** The Type of value. It describes how the data is reported. */\nexport enum ValueType {\n INT,\n DOUBLE,\n}\n\n/**\n * Counter is the most common synchronous instrument. This instrument supports\n * an `Add(increment)` function for reporting a sum, and is restricted to\n * non-negative increments. The default aggregation is Sum, as for any additive\n * instrument.\n *\n * Example uses for Counter:\n * <ol>\n * <li> count the number of bytes received. </li>\n * <li> count the number of requests completed. </li>\n * <li> count the number of accounts created. </li>\n * <li> count the number of checkpoints run. </li>\n * <li> count the number of 5xx errors. </li>\n * <ol>\n */\nexport interface Counter<\n AttributesTypes extends MetricAttributes = MetricAttributes,\n> {\n /**\n * Increment value of counter by the input. Inputs must not be negative.\n */\n add(value: number, attributes?: AttributesTypes, context?: Context): void;\n}\n\nexport interface UpDownCounter<\n AttributesTypes extends MetricAttributes = MetricAttributes,\n> {\n /**\n * Increment value of counter by the input. Inputs may be negative.\n */\n add(value: number, attributes?: AttributesTypes, context?: Context): void;\n}\n\nexport interface Histogram<\n AttributesTypes extends MetricAttributes = MetricAttributes,\n> {\n /**\n * Records a measurement. Value of the measurement must not be negative.\n */\n record(value: number, attributes?: AttributesTypes, context?: Context): void;\n}\n\n/**\n * @deprecated please use {@link Attributes}\n */\nexport type MetricAttributes = Attributes;\n\n/**\n * @deprecated please use {@link AttributeValue}\n */\nexport type MetricAttributeValue = AttributeValue;\n\n/**\n * The observable callback for Observable instruments.\n */\nexport type ObservableCallback<\n AttributesTypes extends MetricAttributes = MetricAttributes,\n> = (\n observableResult: ObservableResult<AttributesTypes>\n) => void | Promise<void>;\n\n/**\n * The observable callback for a batch of Observable instruments.\n */\nexport type BatchObservableCallback<\n AttributesTypes extends MetricAttributes = MetricAttributes,\n> = (\n observableResult: BatchObservableResult<AttributesTypes>\n) => void | Promise<void>;\n\nexport interface Observable<\n AttributesTypes extends MetricAttributes = MetricAttributes,\n> {\n /**\n * Sets up a function that will be called whenever a metric collection is initiated.\n *\n * If the function is already in the list of callbacks for this Observable, the function is not added a second time.\n */\n addCallback(callback: ObservableCallback<AttributesTypes>): void;\n\n /**\n * Removes a callback previously registered with {@link Observable.addCallback}.\n */\n removeCallback(callback: ObservableCallback<AttributesTypes>): void;\n}\n\nexport type ObservableCounter<\n AttributesTypes extends MetricAttributes = MetricAttributes,\n> = Observable<AttributesTypes>;\nexport type ObservableUpDownCounter<\n AttributesTypes extends MetricAttributes = MetricAttributes,\n> = Observable<AttributesTypes>;\nexport type ObservableGauge<\n AttributesTypes extends MetricAttributes = MetricAttributes,\n> = Observable<AttributesTypes>;\n"]}
|
|
@@ -20,6 +20,6 @@ export declare class NonRecordingSpan implements Span {
|
|
|
20
20
|
updateName(_name: string): this;
|
|
21
21
|
end(_endTime?: TimeInput): void;
|
|
22
22
|
isRecording(): boolean;
|
|
23
|
-
recordException(_exception: Exception,
|
|
23
|
+
recordException(_exception: Exception, _time?: TimeInput): void;
|
|
24
24
|
}
|
|
25
25
|
//# sourceMappingURL=NonRecordingSpan.d.ts.map
|
|
@@ -55,7 +55,7 @@ var NonRecordingSpan = /** @class */ (function () {
|
|
|
55
55
|
return false;
|
|
56
56
|
};
|
|
57
57
|
// By default does nothing
|
|
58
|
-
NonRecordingSpan.prototype.recordException = function (_exception,
|
|
58
|
+
NonRecordingSpan.prototype.recordException = function (_exception, _time) { };
|
|
59
59
|
return NonRecordingSpan;
|
|
60
60
|
}());
|
|
61
61
|
export { NonRecordingSpan };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"NonRecordingSpan.js","sourceRoot":"","sources":["../../../src/trace/NonRecordingSpan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAKH,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAKhE;;;;GAIG;AACH;IACE,0BACmB,YAAgD;QAAhD,6BAAA,EAAA,mCAAgD;QAAhD,iBAAY,GAAZ,YAAY,CAAoC;IAChE,CAAC;IAEJ,yBAAyB;IACzB,sCAAW,GAAX;QACE,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,0BAA0B;IAC1B,uCAAY,GAAZ,UAAa,IAAY,EAAE,MAAe;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,wCAAa,GAAb,UAAc,WAA2B;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,mCAAQ,GAAR,UAAS,KAAa,EAAE,WAA4B;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,oCAAS,GAAT,UAAU,OAAmB;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,qCAAU,GAAV,UAAW,KAAa;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,8BAAG,GAAH,UAAI,QAAoB,IAAS,CAAC;IAElC,yDAAyD;IACzD,sCAAW,GAAX;QACE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0BAA0B;IAC1B,0CAAe,GAAf,
|
|
1
|
+
{"version":3,"file":"NonRecordingSpan.js","sourceRoot":"","sources":["../../../src/trace/NonRecordingSpan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAKH,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAKhE;;;;GAIG;AACH;IACE,0BACmB,YAAgD;QAAhD,6BAAA,EAAA,mCAAgD;QAAhD,iBAAY,GAAZ,YAAY,CAAoC;IAChE,CAAC;IAEJ,yBAAyB;IACzB,sCAAW,GAAX;QACE,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,0BAA0B;IAC1B,uCAAY,GAAZ,UAAa,IAAY,EAAE,MAAe;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,wCAAa,GAAb,UAAc,WAA2B;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,mCAAQ,GAAR,UAAS,KAAa,EAAE,WAA4B;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,oCAAS,GAAT,UAAU,OAAmB;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,qCAAU,GAAV,UAAW,KAAa;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,8BAAG,GAAH,UAAI,QAAoB,IAAS,CAAC;IAElC,yDAAyD;IACzD,sCAAW,GAAX;QACE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0BAA0B;IAC1B,0CAAe,GAAf,UAAgB,UAAqB,EAAE,KAAiB,IAAS,CAAC;IACpE,uBAAC;AAAD,CAAC,AA7CD,IA6CC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Exception } from '../common/Exception';\nimport { TimeInput } from '../common/Time';\nimport { SpanAttributes } from './attributes';\nimport { INVALID_SPAN_CONTEXT } from './invalid-span-constants';\nimport { Span } from './span';\nimport { SpanContext } from './span_context';\nimport { SpanStatus } from './status';\n\n/**\n * The NonRecordingSpan is the default {@link Span} that is used when no Span\n * implementation is available. All operations are no-op including context\n * propagation.\n */\nexport class NonRecordingSpan implements Span {\n constructor(\n private readonly _spanContext: SpanContext = INVALID_SPAN_CONTEXT\n ) {}\n\n // Returns a SpanContext.\n spanContext(): SpanContext {\n return this._spanContext;\n }\n\n // By default does nothing\n setAttribute(_key: string, _value: unknown): this {\n return this;\n }\n\n // By default does nothing\n setAttributes(_attributes: SpanAttributes): this {\n return this;\n }\n\n // By default does nothing\n addEvent(_name: string, _attributes?: SpanAttributes): this {\n return this;\n }\n\n // By default does nothing\n setStatus(_status: SpanStatus): this {\n return this;\n }\n\n // By default does nothing\n updateName(_name: string): this {\n return this;\n }\n\n // By default does nothing\n end(_endTime?: TimeInput): void {}\n\n // isRecording always returns false for NonRecordingSpan.\n isRecording(): boolean {\n return false;\n }\n\n // By default does nothing\n recordException(_exception: Exception, _time?: TimeInput): void {}\n}\n"]}
|
|
@@ -97,13 +97,5 @@ export interface Span {
|
|
|
97
97
|
* use the current time.
|
|
98
98
|
*/
|
|
99
99
|
recordException(exception: Exception, time?: TimeInput): void;
|
|
100
|
-
/**
|
|
101
|
-
* Sets exception as a span event
|
|
102
|
-
* @param exception the exception the only accepted values are string or Error
|
|
103
|
-
* @param [attributes] the attributes that will be added to the error event.
|
|
104
|
-
* @param [time] the time to set as Span's event time. If not provided,
|
|
105
|
-
* use the current time.
|
|
106
|
-
*/
|
|
107
|
-
recordException(exception: Exception, attributes?: SpanAttributes, time?: TimeInput): void;
|
|
108
100
|
}
|
|
109
101
|
//# sourceMappingURL=span.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"span.js","sourceRoot":"","sources":["../../../src/trace/span.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Exception } from '../common/Exception';\nimport { TimeInput } from '../common/Time';\nimport { SpanAttributes, SpanAttributeValue } from './attributes';\nimport { SpanContext } from './span_context';\nimport { SpanStatus } from './status';\n\n/**\n * An interface that represents a span. A span represents a single operation\n * within a trace. Examples of span might include remote procedure calls or a\n * in-process function calls to sub-components. A Trace has a single, top-level\n * \"root\" Span that in turn may have zero or more child Spans, which in turn\n * may have children.\n *\n * Spans are created by the {@link Tracer.startSpan} method.\n */\nexport interface Span {\n /**\n * Returns the {@link SpanContext} object associated with this Span.\n *\n * Get an immutable, serializable identifier for this span that can be used\n * to create new child spans. Returned SpanContext is usable even after the\n * span ends.\n *\n * @returns the SpanContext object associated with this Span.\n */\n spanContext(): SpanContext;\n\n /**\n * Sets an attribute to the span.\n *\n * Sets a single Attribute with the key and value passed as arguments.\n *\n * @param key the key for this attribute.\n * @param value the value for this attribute. Setting a value null or\n * undefined is invalid and will result in undefined behavior.\n */\n setAttribute(key: string, value: SpanAttributeValue): this;\n\n /**\n * Sets attributes to the span.\n *\n * @param attributes the attributes that will be added.\n * null or undefined attribute values\n * are invalid and will result in undefined behavior.\n */\n setAttributes(attributes: SpanAttributes): this;\n\n /**\n * Adds an event to the Span.\n *\n * @param name the name of the event.\n * @param [attributesOrStartTime] the attributes that will be added; these are\n * associated with this event. Can be also a start time\n * if type is {@type TimeInput} and 3rd param is undefined\n * @param [startTime] start time of the event.\n */\n addEvent(\n name: string,\n attributesOrStartTime?: SpanAttributes | TimeInput,\n startTime?: TimeInput\n ): this;\n\n /**\n * Sets a status to the span. If used, this will override the default Span\n * status. Default is {@link SpanStatusCode.UNSET}. SetStatus overrides the value\n * of previous calls to SetStatus on the Span.\n *\n * @param status the SpanStatus to set.\n */\n setStatus(status: SpanStatus): this;\n\n /**\n * Updates the Span name.\n *\n * This will override the name provided via {@link Tracer.startSpan}.\n *\n * Upon this update, any sampling behavior based on Span name will depend on\n * the implementation.\n *\n * @param name the Span name.\n */\n updateName(name: string): this;\n\n /**\n * Marks the end of Span execution.\n *\n * Call to End of a Span MUST not have any effects on child spans. Those may\n * still be running and can be ended later.\n *\n * Do not return `this`. The Span generally should not be used after it\n * is ended so chaining is not desired in this context.\n *\n * @param [endTime] the time to set as Span's end time. If not provided,\n * use the current time as the span's end time.\n */\n end(endTime?: TimeInput): void;\n\n /**\n * Returns the flag whether this span will be recorded.\n *\n * @returns true if this Span is active and recording information like events\n * with the `AddEvent` operation and attributes using `setAttributes`.\n */\n isRecording(): boolean;\n\n /**\n * Sets exception as a span event\n * @param exception the exception the only accepted values are string or Error\n * @param [time] the time to set as Span's event time. If not provided,\n * use the current time.\n */\n recordException(exception: Exception, time?: TimeInput): void;\n
|
|
1
|
+
{"version":3,"file":"span.js","sourceRoot":"","sources":["../../../src/trace/span.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Exception } from '../common/Exception';\nimport { TimeInput } from '../common/Time';\nimport { SpanAttributes, SpanAttributeValue } from './attributes';\nimport { SpanContext } from './span_context';\nimport { SpanStatus } from './status';\n\n/**\n * An interface that represents a span. A span represents a single operation\n * within a trace. Examples of span might include remote procedure calls or a\n * in-process function calls to sub-components. A Trace has a single, top-level\n * \"root\" Span that in turn may have zero or more child Spans, which in turn\n * may have children.\n *\n * Spans are created by the {@link Tracer.startSpan} method.\n */\nexport interface Span {\n /**\n * Returns the {@link SpanContext} object associated with this Span.\n *\n * Get an immutable, serializable identifier for this span that can be used\n * to create new child spans. Returned SpanContext is usable even after the\n * span ends.\n *\n * @returns the SpanContext object associated with this Span.\n */\n spanContext(): SpanContext;\n\n /**\n * Sets an attribute to the span.\n *\n * Sets a single Attribute with the key and value passed as arguments.\n *\n * @param key the key for this attribute.\n * @param value the value for this attribute. Setting a value null or\n * undefined is invalid and will result in undefined behavior.\n */\n setAttribute(key: string, value: SpanAttributeValue): this;\n\n /**\n * Sets attributes to the span.\n *\n * @param attributes the attributes that will be added.\n * null or undefined attribute values\n * are invalid and will result in undefined behavior.\n */\n setAttributes(attributes: SpanAttributes): this;\n\n /**\n * Adds an event to the Span.\n *\n * @param name the name of the event.\n * @param [attributesOrStartTime] the attributes that will be added; these are\n * associated with this event. Can be also a start time\n * if type is {@type TimeInput} and 3rd param is undefined\n * @param [startTime] start time of the event.\n */\n addEvent(\n name: string,\n attributesOrStartTime?: SpanAttributes | TimeInput,\n startTime?: TimeInput\n ): this;\n\n /**\n * Sets a status to the span. If used, this will override the default Span\n * status. Default is {@link SpanStatusCode.UNSET}. SetStatus overrides the value\n * of previous calls to SetStatus on the Span.\n *\n * @param status the SpanStatus to set.\n */\n setStatus(status: SpanStatus): this;\n\n /**\n * Updates the Span name.\n *\n * This will override the name provided via {@link Tracer.startSpan}.\n *\n * Upon this update, any sampling behavior based on Span name will depend on\n * the implementation.\n *\n * @param name the Span name.\n */\n updateName(name: string): this;\n\n /**\n * Marks the end of Span execution.\n *\n * Call to End of a Span MUST not have any effects on child spans. Those may\n * still be running and can be ended later.\n *\n * Do not return `this`. The Span generally should not be used after it\n * is ended so chaining is not desired in this context.\n *\n * @param [endTime] the time to set as Span's end time. If not provided,\n * use the current time as the span's end time.\n */\n end(endTime?: TimeInput): void;\n\n /**\n * Returns the flag whether this span will be recorded.\n *\n * @returns true if this Span is active and recording information like events\n * with the `AddEvent` operation and attributes using `setAttributes`.\n */\n isRecording(): boolean;\n\n /**\n * Sets exception as a span event\n * @param exception the exception the only accepted values are string or Error\n * @param [time] the time to set as Span's event time. If not provided,\n * use the current time.\n */\n recordException(exception: Exception, time?: TimeInput): void;\n}\n"]}
|
package/build/esm/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "1.
|
|
1
|
+
export declare const VERSION = "1.7.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/build/esm/version.js
CHANGED
package/build/esm/version.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,4DAA4D;AAC5D,MAAM,CAAC,IAAM,OAAO,GAAG,OAAO,CAAC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// this is autogenerated file, see scripts/version-update.js\nexport const VERSION = '1.
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,4DAA4D;AAC5D,MAAM,CAAC,IAAM,OAAO,GAAG,OAAO,CAAC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// this is autogenerated file, see scripts/version-update.js\nexport const VERSION = '1.7.0';\n"]}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { Context, ContextManager } from '../context/types';
|
|
2
|
+
/**
|
|
3
|
+
* Singleton object which represents the entry point to the OpenTelemetry Context API
|
|
4
|
+
*/
|
|
5
|
+
export declare class ContextAPI {
|
|
6
|
+
private static _instance?;
|
|
7
|
+
/** Empty private constructor prevents end users from constructing a new instance of the API */
|
|
8
|
+
private constructor();
|
|
9
|
+
/** Get the singleton instance of the Context API */
|
|
10
|
+
static getInstance(): ContextAPI;
|
|
11
|
+
/**
|
|
12
|
+
* Set the current context manager.
|
|
13
|
+
*
|
|
14
|
+
* @returns true if the context manager was successfully registered, else false
|
|
15
|
+
*/
|
|
16
|
+
setGlobalContextManager(contextManager: ContextManager): boolean;
|
|
17
|
+
/**
|
|
18
|
+
* Get the currently active context
|
|
19
|
+
*/
|
|
20
|
+
active(): Context;
|
|
21
|
+
/**
|
|
22
|
+
* Execute a function with an active context
|
|
23
|
+
*
|
|
24
|
+
* @param context context to be active during function execution
|
|
25
|
+
* @param fn function to execute in a context
|
|
26
|
+
* @param thisArg optional receiver to be used for calling fn
|
|
27
|
+
* @param args optional arguments forwarded to fn
|
|
28
|
+
*/
|
|
29
|
+
with<A extends unknown[], F extends (...args: A) => ReturnType<F>>(context: Context, fn: F, thisArg?: ThisParameterType<F>, ...args: A): ReturnType<F>;
|
|
30
|
+
/**
|
|
31
|
+
* Bind a context to a target function or event emitter
|
|
32
|
+
*
|
|
33
|
+
* @param context context to bind to the event emitter or function. Defaults to the currently active context
|
|
34
|
+
* @param target function or event emitter to bind
|
|
35
|
+
*/
|
|
36
|
+
bind<T>(context: Context, target: T): T;
|
|
37
|
+
private _getContextManager;
|
|
38
|
+
/** Disable and remove the global context manager */
|
|
39
|
+
disable(): void;
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=context.d.ts.map
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright The OpenTelemetry Authors
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* https://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import { NoopContextManager } from '../context/NoopContextManager';
|
|
17
|
+
import { getGlobal, registerGlobal, unregisterGlobal, } from '../internal/global-utils';
|
|
18
|
+
import { DiagAPI } from './diag';
|
|
19
|
+
const API_NAME = 'context';
|
|
20
|
+
const NOOP_CONTEXT_MANAGER = new NoopContextManager();
|
|
21
|
+
/**
|
|
22
|
+
* Singleton object which represents the entry point to the OpenTelemetry Context API
|
|
23
|
+
*/
|
|
24
|
+
export class ContextAPI {
|
|
25
|
+
/** Empty private constructor prevents end users from constructing a new instance of the API */
|
|
26
|
+
constructor() { }
|
|
27
|
+
/** Get the singleton instance of the Context API */
|
|
28
|
+
static getInstance() {
|
|
29
|
+
if (!this._instance) {
|
|
30
|
+
this._instance = new ContextAPI();
|
|
31
|
+
}
|
|
32
|
+
return this._instance;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Set the current context manager.
|
|
36
|
+
*
|
|
37
|
+
* @returns true if the context manager was successfully registered, else false
|
|
38
|
+
*/
|
|
39
|
+
setGlobalContextManager(contextManager) {
|
|
40
|
+
return registerGlobal(API_NAME, contextManager, DiagAPI.instance());
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Get the currently active context
|
|
44
|
+
*/
|
|
45
|
+
active() {
|
|
46
|
+
return this._getContextManager().active();
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Execute a function with an active context
|
|
50
|
+
*
|
|
51
|
+
* @param context context to be active during function execution
|
|
52
|
+
* @param fn function to execute in a context
|
|
53
|
+
* @param thisArg optional receiver to be used for calling fn
|
|
54
|
+
* @param args optional arguments forwarded to fn
|
|
55
|
+
*/
|
|
56
|
+
with(context, fn, thisArg, ...args) {
|
|
57
|
+
return this._getContextManager().with(context, fn, thisArg, ...args);
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Bind a context to a target function or event emitter
|
|
61
|
+
*
|
|
62
|
+
* @param context context to bind to the event emitter or function. Defaults to the currently active context
|
|
63
|
+
* @param target function or event emitter to bind
|
|
64
|
+
*/
|
|
65
|
+
bind(context, target) {
|
|
66
|
+
return this._getContextManager().bind(context, target);
|
|
67
|
+
}
|
|
68
|
+
_getContextManager() {
|
|
69
|
+
return getGlobal(API_NAME) || NOOP_CONTEXT_MANAGER;
|
|
70
|
+
}
|
|
71
|
+
/** Disable and remove the global context manager */
|
|
72
|
+
disable() {
|
|
73
|
+
this._getContextManager().disable();
|
|
74
|
+
unregisterGlobal(API_NAME, DiagAPI.instance());
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
//# sourceMappingURL=context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../src/api/context.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EACL,SAAS,EACT,cAAc,EACd,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEjC,MAAM,QAAQ,GAAG,SAAS,CAAC;AAC3B,MAAM,oBAAoB,GAAG,IAAI,kBAAkB,EAAE,CAAC;AAEtD;;GAEG;AACH,MAAM,OAAO,UAAU;IAGrB,+FAA+F;IAC/F,gBAAuB,CAAC;IAExB,oDAAoD;IAC7C,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,SAAS,GAAG,IAAI,UAAU,EAAE,CAAC;SACnC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAAC,cAA8B;QAC3D,OAAO,cAAc,CAAC,QAAQ,EAAE,cAAc,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,IAAI,CACT,OAAgB,EAChB,EAAK,EACL,OAA8B,EAC9B,GAAG,IAAO;QAEV,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAI,OAAgB,EAAE,MAAS;QACxC,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAEO,kBAAkB;QACxB,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,oBAAoB,CAAC;IACrD,CAAC;IAED,oDAAoD;IAC7C,OAAO;QACZ,IAAI,CAAC,kBAAkB,EAAE,CAAC,OAAO,EAAE,CAAC;QACpC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjD,CAAC;CACF","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { NoopContextManager } from '../context/NoopContextManager';\nimport { Context, ContextManager } from '../context/types';\nimport {\n getGlobal,\n registerGlobal,\n unregisterGlobal,\n} from '../internal/global-utils';\nimport { DiagAPI } from './diag';\n\nconst API_NAME = 'context';\nconst NOOP_CONTEXT_MANAGER = new NoopContextManager();\n\n/**\n * Singleton object which represents the entry point to the OpenTelemetry Context API\n */\nexport class ContextAPI {\n private static _instance?: ContextAPI;\n\n /** Empty private constructor prevents end users from constructing a new instance of the API */\n private constructor() {}\n\n /** Get the singleton instance of the Context API */\n public static getInstance(): ContextAPI {\n if (!this._instance) {\n this._instance = new ContextAPI();\n }\n\n return this._instance;\n }\n\n /**\n * Set the current context manager.\n *\n * @returns true if the context manager was successfully registered, else false\n */\n public setGlobalContextManager(contextManager: ContextManager): boolean {\n return registerGlobal(API_NAME, contextManager, DiagAPI.instance());\n }\n\n /**\n * Get the currently active context\n */\n public active(): Context {\n return this._getContextManager().active();\n }\n\n /**\n * Execute a function with an active context\n *\n * @param context context to be active during function execution\n * @param fn function to execute in a context\n * @param thisArg optional receiver to be used for calling fn\n * @param args optional arguments forwarded to fn\n */\n public with<A extends unknown[], F extends (...args: A) => ReturnType<F>>(\n context: Context,\n fn: F,\n thisArg?: ThisParameterType<F>,\n ...args: A\n ): ReturnType<F> {\n return this._getContextManager().with(context, fn, thisArg, ...args);\n }\n\n /**\n * Bind a context to a target function or event emitter\n *\n * @param context context to bind to the event emitter or function. Defaults to the currently active context\n * @param target function or event emitter to bind\n */\n public bind<T>(context: Context, target: T): T {\n return this._getContextManager().bind(context, target);\n }\n\n private _getContextManager(): ContextManager {\n return getGlobal(API_NAME) || NOOP_CONTEXT_MANAGER;\n }\n\n /** Disable and remove the global context manager */\n public disable() {\n this._getContextManager().disable();\n unregisterGlobal(API_NAME, DiagAPI.instance());\n }\n}\n"]}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { ComponentLoggerOptions, DiagLogFunction, DiagLogger, DiagLoggerApi } from '../diag/types';
|
|
2
|
+
/**
|
|
3
|
+
* Singleton object which represents the entry point to the OpenTelemetry internal
|
|
4
|
+
* diagnostic API
|
|
5
|
+
*/
|
|
6
|
+
export declare class DiagAPI implements DiagLogger, DiagLoggerApi {
|
|
7
|
+
private static _instance?;
|
|
8
|
+
/** Get the singleton instance of the DiagAPI API */
|
|
9
|
+
static instance(): DiagAPI;
|
|
10
|
+
/**
|
|
11
|
+
* Private internal constructor
|
|
12
|
+
* @private
|
|
13
|
+
*/
|
|
14
|
+
private constructor();
|
|
15
|
+
setLogger: DiagLoggerApi['setLogger'];
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
*/
|
|
19
|
+
createComponentLogger: (options: ComponentLoggerOptions) => DiagLogger;
|
|
20
|
+
verbose: DiagLogFunction;
|
|
21
|
+
debug: DiagLogFunction;
|
|
22
|
+
info: DiagLogFunction;
|
|
23
|
+
warn: DiagLogFunction;
|
|
24
|
+
error: DiagLogFunction;
|
|
25
|
+
/**
|
|
26
|
+
* Unregister the global logger and return to Noop
|
|
27
|
+
*/
|
|
28
|
+
disable: () => void;
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=diag.d.ts.map
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright The OpenTelemetry Authors
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* https://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import { DiagComponentLogger } from '../diag/ComponentLogger';
|
|
17
|
+
import { createLogLevelDiagLogger } from '../diag/internal/logLevelLogger';
|
|
18
|
+
import { DiagLogLevel, } from '../diag/types';
|
|
19
|
+
import { getGlobal, registerGlobal, unregisterGlobal, } from '../internal/global-utils';
|
|
20
|
+
const API_NAME = 'diag';
|
|
21
|
+
/**
|
|
22
|
+
* Singleton object which represents the entry point to the OpenTelemetry internal
|
|
23
|
+
* diagnostic API
|
|
24
|
+
*/
|
|
25
|
+
export class DiagAPI {
|
|
26
|
+
/**
|
|
27
|
+
* Private internal constructor
|
|
28
|
+
* @private
|
|
29
|
+
*/
|
|
30
|
+
constructor() {
|
|
31
|
+
function _logProxy(funcName) {
|
|
32
|
+
return function (...args) {
|
|
33
|
+
const logger = getGlobal('diag');
|
|
34
|
+
// shortcut if logger not set
|
|
35
|
+
if (!logger)
|
|
36
|
+
return;
|
|
37
|
+
return logger[funcName](...args);
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
// Using self local variable for minification purposes as 'this' cannot be minified
|
|
41
|
+
const self = this;
|
|
42
|
+
// DiagAPI specific functions
|
|
43
|
+
const setLogger = (logger, optionsOrLogLevel = { logLevel: DiagLogLevel.INFO }) => {
|
|
44
|
+
var _a, _b, _c;
|
|
45
|
+
if (logger === self) {
|
|
46
|
+
// There isn't much we can do here.
|
|
47
|
+
// Logging to the console might break the user application.
|
|
48
|
+
// Try to log to self. If a logger was previously registered it will receive the log.
|
|
49
|
+
const err = new Error('Cannot use diag as the logger for itself. Please use a DiagLogger implementation like ConsoleDiagLogger or a custom implementation');
|
|
50
|
+
self.error((_a = err.stack) !== null && _a !== void 0 ? _a : err.message);
|
|
51
|
+
return false;
|
|
52
|
+
}
|
|
53
|
+
if (typeof optionsOrLogLevel === 'number') {
|
|
54
|
+
optionsOrLogLevel = {
|
|
55
|
+
logLevel: optionsOrLogLevel,
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
const oldLogger = getGlobal('diag');
|
|
59
|
+
const newLogger = createLogLevelDiagLogger((_b = optionsOrLogLevel.logLevel) !== null && _b !== void 0 ? _b : DiagLogLevel.INFO, logger);
|
|
60
|
+
// There already is an logger registered. We'll let it know before overwriting it.
|
|
61
|
+
if (oldLogger && !optionsOrLogLevel.suppressOverrideMessage) {
|
|
62
|
+
const stack = (_c = new Error().stack) !== null && _c !== void 0 ? _c : '<failed to generate stacktrace>';
|
|
63
|
+
oldLogger.warn(`Current logger will be overwritten from ${stack}`);
|
|
64
|
+
newLogger.warn(`Current logger will overwrite one already registered from ${stack}`);
|
|
65
|
+
}
|
|
66
|
+
return registerGlobal('diag', newLogger, self, true);
|
|
67
|
+
};
|
|
68
|
+
self.setLogger = setLogger;
|
|
69
|
+
self.disable = () => {
|
|
70
|
+
unregisterGlobal(API_NAME, self);
|
|
71
|
+
};
|
|
72
|
+
self.createComponentLogger = (options) => {
|
|
73
|
+
return new DiagComponentLogger(options);
|
|
74
|
+
};
|
|
75
|
+
self.verbose = _logProxy('verbose');
|
|
76
|
+
self.debug = _logProxy('debug');
|
|
77
|
+
self.info = _logProxy('info');
|
|
78
|
+
self.warn = _logProxy('warn');
|
|
79
|
+
self.error = _logProxy('error');
|
|
80
|
+
}
|
|
81
|
+
/** Get the singleton instance of the DiagAPI API */
|
|
82
|
+
static instance() {
|
|
83
|
+
if (!this._instance) {
|
|
84
|
+
this._instance = new DiagAPI();
|
|
85
|
+
}
|
|
86
|
+
return this._instance;
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
//# sourceMappingURL=diag.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"diag.js","sourceRoot":"","sources":["../../../src/api/diag.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAKL,YAAY,GACb,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,SAAS,EACT,cAAc,EACd,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAElC,MAAM,QAAQ,GAAG,MAAM,CAAC;AAExB;;;GAGG;AACH,MAAM,OAAO,OAAO;IAYlB;;;OAGG;IACH;QACE,SAAS,SAAS,CAAC,QAA0B;YAC3C,OAAO,UAAU,GAAG,IAAI;gBACtB,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;gBACjC,6BAA6B;gBAC7B,IAAI,CAAC,MAAM;oBAAE,OAAO;gBACpB,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;YACnC,CAAC,CAAC;QACJ,CAAC;QAED,mFAAmF;QACnF,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,6BAA6B;QAE7B,MAAM,SAAS,GAA+B,CAC5C,MAAM,EACN,iBAAiB,GAAG,EAAE,QAAQ,EAAE,YAAY,CAAC,IAAI,EAAE,EACnD,EAAE;;YACF,IAAI,MAAM,KAAK,IAAI,EAAE;gBACnB,mCAAmC;gBACnC,2DAA2D;gBAC3D,qFAAqF;gBACrF,MAAM,GAAG,GAAG,IAAI,KAAK,CACnB,oIAAoI,CACrI,CAAC;gBACF,IAAI,CAAC,KAAK,CAAC,MAAA,GAAG,CAAC,KAAK,mCAAI,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrC,OAAO,KAAK,CAAC;aACd;YAED,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;gBACzC,iBAAiB,GAAG;oBAClB,QAAQ,EAAE,iBAAiB;iBAC5B,CAAC;aACH;YAED,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;YACpC,MAAM,SAAS,GAAG,wBAAwB,CACxC,MAAA,iBAAiB,CAAC,QAAQ,mCAAI,YAAY,CAAC,IAAI,EAC/C,MAAM,CACP,CAAC;YACF,kFAAkF;YAClF,IAAI,SAAS,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,EAAE;gBAC3D,MAAM,KAAK,GAAG,MAAA,IAAI,KAAK,EAAE,CAAC,KAAK,mCAAI,iCAAiC,CAAC;gBACrE,SAAS,CAAC,IAAI,CAAC,2CAA2C,KAAK,EAAE,CAAC,CAAC;gBACnE,SAAS,CAAC,IAAI,CACZ,6DAA6D,KAAK,EAAE,CACrE,CAAC;aACH;YAED,OAAO,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC;QAEF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE;YAClB,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC;QAEF,IAAI,CAAC,qBAAqB,GAAG,CAAC,OAA+B,EAAE,EAAE;YAC/D,OAAO,IAAI,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAC1C,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAjFD,oDAAoD;IAC7C,MAAM,CAAC,QAAQ;QACpB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,SAAS,GAAG,IAAI,OAAO,EAAE,CAAC;SAChC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;CA+FF","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { DiagComponentLogger } from '../diag/ComponentLogger';\nimport { createLogLevelDiagLogger } from '../diag/internal/logLevelLogger';\nimport {\n ComponentLoggerOptions,\n DiagLogFunction,\n DiagLogger,\n DiagLoggerApi,\n DiagLogLevel,\n} from '../diag/types';\nimport {\n getGlobal,\n registerGlobal,\n unregisterGlobal,\n} from '../internal/global-utils';\n\nconst API_NAME = 'diag';\n\n/**\n * Singleton object which represents the entry point to the OpenTelemetry internal\n * diagnostic API\n */\nexport class DiagAPI implements DiagLogger, DiagLoggerApi {\n private static _instance?: DiagAPI;\n\n /** Get the singleton instance of the DiagAPI API */\n public static instance(): DiagAPI {\n if (!this._instance) {\n this._instance = new DiagAPI();\n }\n\n return this._instance;\n }\n\n /**\n * Private internal constructor\n * @private\n */\n private constructor() {\n function _logProxy(funcName: keyof DiagLogger): DiagLogFunction {\n return function (...args) {\n const logger = getGlobal('diag');\n // shortcut if logger not set\n if (!logger) return;\n return logger[funcName](...args);\n };\n }\n\n // Using self local variable for minification purposes as 'this' cannot be minified\n const self = this;\n\n // DiagAPI specific functions\n\n const setLogger: DiagLoggerApi['setLogger'] = (\n logger,\n optionsOrLogLevel = { logLevel: DiagLogLevel.INFO }\n ) => {\n if (logger === self) {\n // There isn't much we can do here.\n // Logging to the console might break the user application.\n // Try to log to self. If a logger was previously registered it will receive the log.\n const err = new Error(\n 'Cannot use diag as the logger for itself. Please use a DiagLogger implementation like ConsoleDiagLogger or a custom implementation'\n );\n self.error(err.stack ?? err.message);\n return false;\n }\n\n if (typeof optionsOrLogLevel === 'number') {\n optionsOrLogLevel = {\n logLevel: optionsOrLogLevel,\n };\n }\n\n const oldLogger = getGlobal('diag');\n const newLogger = createLogLevelDiagLogger(\n optionsOrLogLevel.logLevel ?? DiagLogLevel.INFO,\n logger\n );\n // There already is an logger registered. We'll let it know before overwriting it.\n if (oldLogger && !optionsOrLogLevel.suppressOverrideMessage) {\n const stack = new Error().stack ?? '<failed to generate stacktrace>';\n oldLogger.warn(`Current logger will be overwritten from ${stack}`);\n newLogger.warn(\n `Current logger will overwrite one already registered from ${stack}`\n );\n }\n\n return registerGlobal('diag', newLogger, self, true);\n };\n\n self.setLogger = setLogger;\n\n self.disable = () => {\n unregisterGlobal(API_NAME, self);\n };\n\n self.createComponentLogger = (options: ComponentLoggerOptions) => {\n return new DiagComponentLogger(options);\n };\n\n self.verbose = _logProxy('verbose');\n self.debug = _logProxy('debug');\n self.info = _logProxy('info');\n self.warn = _logProxy('warn');\n self.error = _logProxy('error');\n }\n\n public setLogger!: DiagLoggerApi['setLogger'];\n /**\n *\n */\n public createComponentLogger!: (\n options: ComponentLoggerOptions\n ) => DiagLogger;\n\n // DiagLogger implementation\n public verbose!: DiagLogFunction;\n public debug!: DiagLogFunction;\n public info!: DiagLogFunction;\n public warn!: DiagLogFunction;\n public error!: DiagLogFunction;\n\n /**\n * Unregister the global logger and return to Noop\n */\n public disable!: () => void;\n}\n"]}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { Meter, MeterOptions } from '../metrics/Meter';
|
|
2
|
+
import { MeterProvider } from '../metrics/MeterProvider';
|
|
3
|
+
/**
|
|
4
|
+
* Singleton object which represents the entry point to the OpenTelemetry Metrics API
|
|
5
|
+
*/
|
|
6
|
+
export declare class MetricsAPI {
|
|
7
|
+
private static _instance?;
|
|
8
|
+
/** Empty private constructor prevents end users from constructing a new instance of the API */
|
|
9
|
+
private constructor();
|
|
10
|
+
/** Get the singleton instance of the Metrics API */
|
|
11
|
+
static getInstance(): MetricsAPI;
|
|
12
|
+
/**
|
|
13
|
+
* Set the current global meter provider.
|
|
14
|
+
* Returns true if the meter provider was successfully registered, else false.
|
|
15
|
+
*/
|
|
16
|
+
setGlobalMeterProvider(provider: MeterProvider): boolean;
|
|
17
|
+
/**
|
|
18
|
+
* Returns the global meter provider.
|
|
19
|
+
*/
|
|
20
|
+
getMeterProvider(): MeterProvider;
|
|
21
|
+
/**
|
|
22
|
+
* Returns a meter from the global meter provider.
|
|
23
|
+
*/
|
|
24
|
+
getMeter(name: string, version?: string, options?: MeterOptions): Meter;
|
|
25
|
+
/** Remove the global meter provider */
|
|
26
|
+
disable(): void;
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=metrics.d.ts.map
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright The OpenTelemetry Authors
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* https://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import { NOOP_METER_PROVIDER } from '../metrics/NoopMeterProvider';
|
|
17
|
+
import { getGlobal, registerGlobal, unregisterGlobal, } from '../internal/global-utils';
|
|
18
|
+
import { DiagAPI } from './diag';
|
|
19
|
+
const API_NAME = 'metrics';
|
|
20
|
+
/**
|
|
21
|
+
* Singleton object which represents the entry point to the OpenTelemetry Metrics API
|
|
22
|
+
*/
|
|
23
|
+
export class MetricsAPI {
|
|
24
|
+
/** Empty private constructor prevents end users from constructing a new instance of the API */
|
|
25
|
+
constructor() { }
|
|
26
|
+
/** Get the singleton instance of the Metrics API */
|
|
27
|
+
static getInstance() {
|
|
28
|
+
if (!this._instance) {
|
|
29
|
+
this._instance = new MetricsAPI();
|
|
30
|
+
}
|
|
31
|
+
return this._instance;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Set the current global meter provider.
|
|
35
|
+
* Returns true if the meter provider was successfully registered, else false.
|
|
36
|
+
*/
|
|
37
|
+
setGlobalMeterProvider(provider) {
|
|
38
|
+
return registerGlobal(API_NAME, provider, DiagAPI.instance());
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Returns the global meter provider.
|
|
42
|
+
*/
|
|
43
|
+
getMeterProvider() {
|
|
44
|
+
return getGlobal(API_NAME) || NOOP_METER_PROVIDER;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Returns a meter from the global meter provider.
|
|
48
|
+
*/
|
|
49
|
+
getMeter(name, version, options) {
|
|
50
|
+
return this.getMeterProvider().getMeter(name, version, options);
|
|
51
|
+
}
|
|
52
|
+
/** Remove the global meter provider */
|
|
53
|
+
disable() {
|
|
54
|
+
unregisterGlobal(API_NAME, DiagAPI.instance());
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=metrics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/api/metrics.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EACL,SAAS,EACT,cAAc,EACd,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEjC,MAAM,QAAQ,GAAG,SAAS,CAAC;AAE3B;;GAEG;AACH,MAAM,OAAO,UAAU;IAGrB,+FAA+F;IAC/F,gBAAuB,CAAC;IAExB,oDAAoD;IAC7C,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,SAAS,GAAG,IAAI,UAAU,EAAE,CAAC;SACnC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,sBAAsB,CAAC,QAAuB;QACnD,OAAO,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,mBAAmB,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,QAAQ,CACb,IAAY,EACZ,OAAgB,EAChB,OAAsB;QAEtB,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED,uCAAuC;IAChC,OAAO;QACZ,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjD,CAAC;CACF","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Meter, MeterOptions } from '../metrics/Meter';\nimport { MeterProvider } from '../metrics/MeterProvider';\nimport { NOOP_METER_PROVIDER } from '../metrics/NoopMeterProvider';\nimport {\n getGlobal,\n registerGlobal,\n unregisterGlobal,\n} from '../internal/global-utils';\nimport { DiagAPI } from './diag';\n\nconst API_NAME = 'metrics';\n\n/**\n * Singleton object which represents the entry point to the OpenTelemetry Metrics API\n */\nexport class MetricsAPI {\n private static _instance?: MetricsAPI;\n\n /** Empty private constructor prevents end users from constructing a new instance of the API */\n private constructor() {}\n\n /** Get the singleton instance of the Metrics API */\n public static getInstance(): MetricsAPI {\n if (!this._instance) {\n this._instance = new MetricsAPI();\n }\n\n return this._instance;\n }\n\n /**\n * Set the current global meter provider.\n * Returns true if the meter provider was successfully registered, else false.\n */\n public setGlobalMeterProvider(provider: MeterProvider): boolean {\n return registerGlobal(API_NAME, provider, DiagAPI.instance());\n }\n\n /**\n * Returns the global meter provider.\n */\n public getMeterProvider(): MeterProvider {\n return getGlobal(API_NAME) || NOOP_METER_PROVIDER;\n }\n\n /**\n * Returns a meter from the global meter provider.\n */\n public getMeter(\n name: string,\n version?: string,\n options?: MeterOptions\n ): Meter {\n return this.getMeterProvider().getMeter(name, version, options);\n }\n\n /** Remove the global meter provider */\n public disable(): void {\n unregisterGlobal(API_NAME, DiagAPI.instance());\n }\n}\n"]}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { Context } from '../context/types';
|
|
2
|
+
import { TextMapGetter, TextMapPropagator, TextMapSetter } from '../propagation/TextMapPropagator';
|
|
3
|
+
import { getBaggage, getActiveBaggage, setBaggage, deleteBaggage } from '../baggage/context-helpers';
|
|
4
|
+
import { createBaggage } from '../baggage/utils';
|
|
5
|
+
/**
|
|
6
|
+
* Singleton object which represents the entry point to the OpenTelemetry Propagation API
|
|
7
|
+
*/
|
|
8
|
+
export declare class PropagationAPI {
|
|
9
|
+
private static _instance?;
|
|
10
|
+
/** Empty private constructor prevents end users from constructing a new instance of the API */
|
|
11
|
+
private constructor();
|
|
12
|
+
/** Get the singleton instance of the Propagator API */
|
|
13
|
+
static getInstance(): PropagationAPI;
|
|
14
|
+
/**
|
|
15
|
+
* Set the current propagator.
|
|
16
|
+
*
|
|
17
|
+
* @returns true if the propagator was successfully registered, else false
|
|
18
|
+
*/
|
|
19
|
+
setGlobalPropagator(propagator: TextMapPropagator): boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Inject context into a carrier to be propagated inter-process
|
|
22
|
+
*
|
|
23
|
+
* @param context Context carrying tracing data to inject
|
|
24
|
+
* @param carrier carrier to inject context into
|
|
25
|
+
* @param setter Function used to set values on the carrier
|
|
26
|
+
*/
|
|
27
|
+
inject<Carrier>(context: Context, carrier: Carrier, setter?: TextMapSetter<Carrier>): void;
|
|
28
|
+
/**
|
|
29
|
+
* Extract context from a carrier
|
|
30
|
+
*
|
|
31
|
+
* @param context Context which the newly created context will inherit from
|
|
32
|
+
* @param carrier Carrier to extract context from
|
|
33
|
+
* @param getter Function used to extract keys from a carrier
|
|
34
|
+
*/
|
|
35
|
+
extract<Carrier>(context: Context, carrier: Carrier, getter?: TextMapGetter<Carrier>): Context;
|
|
36
|
+
/**
|
|
37
|
+
* Return a list of all fields which may be used by the propagator.
|
|
38
|
+
*/
|
|
39
|
+
fields(): string[];
|
|
40
|
+
/** Remove the global propagator */
|
|
41
|
+
disable(): void;
|
|
42
|
+
createBaggage: typeof createBaggage;
|
|
43
|
+
getBaggage: typeof getBaggage;
|
|
44
|
+
getActiveBaggage: typeof getActiveBaggage;
|
|
45
|
+
setBaggage: typeof setBaggage;
|
|
46
|
+
deleteBaggage: typeof deleteBaggage;
|
|
47
|
+
private _getGlobalPropagator;
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=propagation.d.ts.map
|