From 53d45bf96771103285f6a72b5b29691fd4801cda Mon Sep 17 00:00:00 2001 From: trentm Date: Tue, 20 May 2025 21:52:02 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20open-tel?= =?UTF-8?q?emetry/opentelemetry-js@6d0d33b3dfbc503cf28dc2db42570447b06c030?= =?UTF-8?q?3=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_opentelemetry_api-logs.NoopLogger.html | 4 +- ...telemetry_api-logs.NoopLoggerProvider.html | 4 +- .../_opentelemetry_api-logs.ProxyLogger.html | 6 +- ...elemetry_api-logs.ProxyLoggerProvider.html | 8 +- ...try_api._opentelemetry_api.ContextAPI.html | 14 +- ...emetry_api._opentelemetry_api.DiagAPI.html | 20 +- ...._opentelemetry_api.DiagConsoleLogger.html | 14 +- ...try_api._opentelemetry_api.MetricsAPI.html | 12 +- ...api._opentelemetry_api.PropagationAPI.html | 24 +-- ...ry_api._opentelemetry_api.ProxyTracer.html | 8 +- ...opentelemetry_api.ProxyTracerProvider.html | 8 +- ...metry_api._opentelemetry_api.TraceAPI.html | 28 +-- ...emetry_api_experimental.SugaredTracer.html | 22 +-- ...-async-hooks.AsyncHooksContextManager.html | 6 +- ...hooks.AsyncLocalStorageContextManager.html | 6 +- ...text-zone-peer-dep.ZoneContextManager.html | 12 +- .../_opentelemetry_core.AnchoredClock.html | 6 +- .../_opentelemetry_core.BindOnceFuture.html | 4 +- ...pentelemetry_core.CompositePropagator.html | 10 +- classes/_opentelemetry_core.TimeoutError.html | 4 +- classes/_opentelemetry_core.TraceState.html | 12 +- ...entelemetry_core.W3CBaggagePropagator.html | 8 +- ...emetry_core.W3CTraceContextPropagator.html | 8 +- ...emetry_exporter-jaeger.JaegerExporter.html | 10 +- ...porter-logs-otlp-grpc.OTLPLogExporter.html | 4 +- ...porter-logs-otlp-http.OTLPLogExporter.html | 4 +- ...orter-logs-otlp-proto.OTLPLogExporter.html | 4 +- ...-metrics-otlp-grpc.OTLPMetricExporter.html | 4 +- ...-metrics-otlp-http.OTLPMetricExporter.html | 8 +- ...rics-otlp-http.OTLPMetricExporterBase.html | 8 +- ...metrics-otlp-proto.OTLPMetricExporter.html | 4 +- ...xporter-prometheus.PrometheusExporter.html | 14 +- ...orter-prometheus.PrometheusSerializer.html | 4 +- ...ter-trace-otlp-grpc.OTLPTraceExporter.html | 4 +- ...ter-trace-otlp-http.OTLPTraceExporter.html | 4 +- ...er-trace-otlp-proto.OTLPTraceExporter.html | 4 +- ...emetry_exporter-zipkin.ZipkinExporter.html | 10 +- ...umentation-fetch.FetchInstrumentation.html | 12 +- ...trumentation-grpc.GrpcInstrumentation.html | 8 +- ...trumentation-http.HttpInstrumentation.html | 10 +- ...request.XMLHttpRequestInstrumentation.html | 12 +- ...y_instrumentation.InstrumentationBase.html | 30 +-- ...n.InstrumentationNodeModuleDefinition.html | 14 +- ...ntation.InstrumentationNodeModuleFile.html | 8 +- ...ntelemetry_propagator-b3.B3Propagator.html | 10 +- ...ry_propagator-jaeger.JaegerPropagator.html | 10 +- ...ler-jaeger-remote.JaegerRemoteSampler.html | 8 +- ..._opentelemetry_sdk-events.EventLogger.html | 6 +- ...emetry_sdk-events.EventLoggerProvider.html | 6 +- ...etry_sdk-logs.BatchLogRecordProcessor.html | 10 +- ...try_sdk-logs.ConsoleLogRecordExporter.html | 6 +- ...ry_sdk-logs.InMemoryLogRecordExporter.html | 8 +- .../_opentelemetry_sdk-logs.LogRecord.html | 6 +- ...opentelemetry_sdk-logs.LoggerProvider.html | 12 +- ...metry_sdk-logs.NoopLogRecordProcessor.html | 8 +- ...try_sdk-logs.SimpleLogRecordProcessor.html | 10 +- ...try_sdk-metrics.ConsoleMetricExporter.html | 12 +- ...ry_sdk-metrics.InMemoryMetricExporter.html | 12 +- ...entelemetry_sdk-metrics.MeterProvider.html | 10 +- ...pentelemetry_sdk-metrics.MetricReader.html | 24 +-- ...metrics.PeriodicExportingMetricReader.html | 24 +-- ...pentelemetry_sdk-metrics.TimeoutError.html | 4 +- classes/_opentelemetry_sdk-node.NodeSDK.html | 6 +- ...metry_sdk-trace-base.AlwaysOffSampler.html | 6 +- ...emetry_sdk-trace-base.AlwaysOnSampler.html | 6 +- ...ry_sdk-trace-base.BasicTracerProvider.html | 6 +- ...try_sdk-trace-base.BatchSpanProcessor.html | 12 +- ...ry_sdk-trace-base.ConsoleSpanExporter.html | 8 +- ...y_sdk-trace-base.InMemorySpanExporter.html | 10 +- ...etry_sdk-trace-base.NoopSpanProcessor.html | 10 +- ...try_sdk-trace-base.ParentBasedSampler.html | 8 +- ...etry_sdk-trace-base.RandomIdGenerator.html | 6 +- ...ry_sdk-trace-base.SimpleSpanProcessor.html | 12 +- ...k-trace-base.TraceIdRatioBasedSampler.html | 8 +- ...try_sdk-trace-node.NodeTracerProvider.html | 6 +- ...try_sdk-trace-web.StackContextManager.html | 14 +- ...metry_sdk-trace-web.WebTracerProvider.html | 6 +- ...-opencensus..OpenCensusMetricProducer.html | 6 +- ...telemetry_shim-opencensus..ShimTracer.html | 42 ++-- ...telemetry_shim-opentracing.TracerShim.html | 6 +- ...opentelemetry_api-logs.SeverityNumber.html | 4 +- ...y_api._opentelemetry_api.DiagLogLevel.html | 16 +- ...i._opentelemetry_api.SamplingDecision.html | 8 +- ...metry_api._opentelemetry_api.SpanKind.html | 12 +- ...api._opentelemetry_api.SpanStatusCode.html | 8 +- ...try_api._opentelemetry_api.TraceFlags.html | 6 +- ...etry_api._opentelemetry_api.ValueType.html | 4 +- .../_opentelemetry_core.ExportResultCode.html | 4 +- enums/_opentelemetry_core.RPCType.html | 4 +- ...http.AggregationTemporalityPreference.html | 4 +- ...etry_instrumentation.SemconvStability.html | 8 +- ...emetry_propagator-b3.B3InjectEncoding.html | 4 +- ...ry_sampler-jaeger-remote.StrategyType.html | 10 +- ...ry_sdk-metrics.AggregationTemporality.html | 4 +- ...telemetry_sdk-metrics.AggregationType.html | 4 +- ...entelemetry_sdk-metrics.DataPointType.html | 10 +- ...ntelemetry_sdk-metrics.InstrumentType.html | 4 +- ...metry_sdk-trace-base.SamplingDecision.html | 8 +- ..._sdk-trace-web.PerformanceTimingNames.html | 4 +- ...ry_api.baggageEntryMetadataFromString.html | 2 +- ...i._opentelemetry_api.createContextKey.html | 2 +- ...pi._opentelemetry_api.createNoopMeter.html | 2 +- ...i._opentelemetry_api.createTraceState.html | 2 +- ..._opentelemetry_api.isSpanContextValid.html | 2 +- ..._api._opentelemetry_api.isValidSpanId.html | 2 +- ...api._opentelemetry_api.isValidTraceId.html | 2 +- ...telemetry_api_experimental.wrapTracer.html | 2 +- functions/_opentelemetry_core.addHrTimes.html | 2 +- .../_opentelemetry_core.callWithTimeout.html | 2 +- ..._opentelemetry_core.deleteRPCMetadata.html | 2 +- ...telemetry_core.diagLogLevelFromString.html | 2 +- ..._opentelemetry_core.getBooleanFromEnv.html | 2 +- .../_opentelemetry_core.getNumberFromEnv.html | 2 +- .../_opentelemetry_core.getRPCMetadata.html | 2 +- .../_opentelemetry_core.getStringFromEnv.html | 2 +- ...entelemetry_core.getStringListFromEnv.html | 2 +- .../_opentelemetry_core.getTimeOrigin.html | 2 +- ...opentelemetry_core.globalErrorHandler.html | 2 +- functions/_opentelemetry_core.hrTime.html | 2 +- .../_opentelemetry_core.hrTimeDuration.html | 2 +- ...entelemetry_core.hrTimeToMicroseconds.html | 2 +- ...entelemetry_core.hrTimeToMilliseconds.html | 2 +- ...pentelemetry_core.hrTimeToNanoseconds.html | 2 +- ..._opentelemetry_core.hrTimeToTimeStamp.html | 2 +- .../_opentelemetry_core.isAttributeValue.html | 2 +- .../_opentelemetry_core.isTimeInput.html | 2 +- ..._opentelemetry_core.isTimeInputHrTime.html | 2 +- ...pentelemetry_core.isTracingSuppressed.html | 2 +- .../_opentelemetry_core.isUrlIgnored.html | 2 +- ...pentelemetry_core.loggingErrorHandler.html | 2 +- functions/_opentelemetry_core.merge.html | 2 +- .../_opentelemetry_core.millisToHrTime.html | 2 +- ...elemetry_core.parseKeyPairsIntoRecord.html | 2 +- .../_opentelemetry_core.parseTraceParent.html | 2 +- ...opentelemetry_core.sanitizeAttributes.html | 2 +- ...ntelemetry_core.setGlobalErrorHandler.html | 2 +- .../_opentelemetry_core.setRPCMetadata.html | 2 +- .../_opentelemetry_core.suppressTracing.html | 2 +- ..._opentelemetry_core.timeInputToHrTime.html | 2 +- functions/_opentelemetry_core.unrefTimer.html | 2 +- ..._opentelemetry_core.unsuppressTracing.html | 2 +- functions/_opentelemetry_core.urlMatches.html | 2 +- ...lp-http.CumulativeTemporalitySelector.html | 2 +- ...cs-otlp-http.DeltaTemporalitySelector.html | 2 +- ...tlp-http.LowMemoryTemporalitySelector.html | 2 +- ...telemetry_exporter-zipkin.prepareSend.html | 2 +- ...entelemetry_instrumentation.isWrapped.html | 2 +- ...trumentation.registerInstrumentations.html | 2 +- ...nstrumentation.safeExecuteInTheMiddle.html | 2 +- ...mentation.safeExecuteInTheMiddleAsync.html | 2 +- ...strumentation.semconvStabilityFromStr.html | 2 +- ...ter-base.convertLegacyOtlpGrpcOptions.html | 2 +- ...ter-base.createOtlpGrpcExportDelegate.html | 2 +- ...entelemetry_resources.defaultResource.html | 2 +- ...elemetry_resources.defaultServiceName.html | 2 +- ...entelemetry_resources.detectResources.html | 2 +- ...opentelemetry_resources.emptyResource.html | 2 +- ...etry_resources.resourceFromAttributes.html | 2 +- ...cs.createAllowListAttributesProcessor.html | 2 +- ...ics.createDenyListAttributesProcessor.html | 2 +- ...try_sdk-trace-web.addSpanNetworkEvent.html | 2 +- ...ry_sdk-trace-web.addSpanNetworkEvents.html | 2 +- ...lemetry_sdk-trace-web.getElementXPath.html | 2 +- ...entelemetry_sdk-trace-web.getResource.html | 2 +- .../_opentelemetry_sdk-trace-web.hasKey.html | 2 +- ...ntelemetry_sdk-trace-web.normalizeUrl.html | 2 +- ..._opentelemetry_sdk-trace-web.parseUrl.html | 2 +- ...telemetry_sdk-trace-web.sortResources.html | 2 +- ...elemetry_shim-opencensus..installShim.html | 2 +- ...emetry_shim-opencensus..uninstallShim.html | 2 +- ...ommon.createSessionLogRecordProcessor.html | 2 +- ...web-common.createSessionSpanProcessor.html | 2 +- .../_opentelemetry_api-events.Event.html | 14 +- ..._opentelemetry_api-events.EventLogger.html | 4 +- ...lemetry_api-events.EventLoggerOptions.html | 6 +- ...emetry_api-events.EventLoggerProvider.html | 4 +- .../_opentelemetry_api-logs.AnyValueMap.html | 2 +- .../_opentelemetry_api-logs.LogRecord.html | 16 +- .../_opentelemetry_api-logs.Logger.html | 4 +- ..._opentelemetry_api-logs.LoggerOptions.html | 8 +- ...opentelemetry_api-logs.LoggerProvider.html | 4 +- ...try_api._opentelemetry_api.Attributes.html | 2 +- ...emetry_api._opentelemetry_api.Baggage.html | 14 +- ...y_api._opentelemetry_api.BaggageEntry.html | 6 +- ...entelemetry_api.BatchObservableResult.html | 4 +- ...ntelemetry_api.ComponentLoggerOptions.html | 4 +- ...emetry_api._opentelemetry_api.Context.html | 8 +- ...api._opentelemetry_api.ContextManager.html | 12 +- ...emetry_api._opentelemetry_api.Counter.html | 4 +- ...try_api._opentelemetry_api.DiagLogger.html | 12 +- ...._opentelemetry_api.DiagLoggerOptions.html | 6 +- ...elemetry_api._opentelemetry_api.Gauge.html | 4 +- ...etry_api._opentelemetry_api.Histogram.html | 4 +- ...telemetry_api._opentelemetry_api.Link.html | 8 +- ...elemetry_api._opentelemetry_api.Meter.html | 20 +- ...y_api._opentelemetry_api.MeterOptions.html | 4 +- ..._api._opentelemetry_api.MeterProvider.html | 4 +- ...y_api._opentelemetry_api.MetricAdvice.html | 4 +- ..._api._opentelemetry_api.MetricOptions.html | 10 +- ...try_api._opentelemetry_api.Observable.html | 6 +- ...i._opentelemetry_api.ObservableResult.html | 4 +- ...emetry_api._opentelemetry_api.Sampler.html | 6 +- ...api._opentelemetry_api.SamplingResult.html | 8 +- ...telemetry_api._opentelemetry_api.Span.html | 24 +-- ...ry_api._opentelemetry_api.SpanContext.html | 12 +- ...ry_api._opentelemetry_api.SpanOptions.html | 12 +- ...try_api._opentelemetry_api.SpanStatus.html | 6 +- ..._api._opentelemetry_api.TextMapGetter.html | 6 +- ...._opentelemetry_api.TextMapPropagator.html | 8 +- ..._api._opentelemetry_api.TextMapSetter.html | 4 +- ...try_api._opentelemetry_api.TraceState.html | 10 +- ...lemetry_api._opentelemetry_api.Tracer.html | 6 +- ...pi._opentelemetry_api.TracerDelegator.html | 4 +- ..._api._opentelemetry_api.TracerOptions.html | 4 +- ...api._opentelemetry_api.TracerProvider.html | 4 +- ..._api._opentelemetry_api.UpDownCounter.html | 4 +- ...y_api_experimental.SugaredSpanOptions.html | 14 +- ...ontext-zone-peer-dep.TargetWithEvents.html | 4 +- interfaces/_opentelemetry_core.Clock.html | 4 +- ...emetry_core.CompositePropagatorConfig.html | 4 +- .../_opentelemetry_core.ExportResult.html | 4 +- ...entelemetry_core.InstrumentationScope.html | 4 +- ...emetry_exporter-jaeger.ExporterConfig.html | 6 +- ...s-otlp-http.OTLPMetricExporterOptions.html | 4 +- ...ry_exporter-prometheus.ExporterConfig.html | 18 +- ...emetry_exporter-zipkin.ExporterConfig.html | 4 +- ...on-fetch.FetchCustomAttributeFunction.html | 2 +- ...tion-fetch.FetchInstrumentationConfig.html | 14 +- ...tation-fetch.FetchRequestHookFunction.html | 2 +- ...tation-grpc.GrpcInstrumentationConfig.html | 6 +- ...tion-http.HttpCustomAttributeFunction.html | 2 +- ...tation-http.HttpInstrumentationConfig.html | 32 +-- ...tp.HttpRequestCustomAttributeFunction.html | 2 +- ...p.HttpResponseCustomAttributeFunction.html | 2 +- ...on-http.IgnoreIncomingRequestFunction.html | 2 +- ...on-http.IgnoreOutgoingRequestFunction.html | 2 +- ...rtIncomingSpanCustomAttributeFunction.html | 2 +- ...rtOutgoingSpanCustomAttributeFunction.html | 2 +- ...t.XMLHttpRequestInstrumentationConfig.html | 16 +- ...try_instrumentation.AutoLoaderOptions.html | 4 +- ...etry_instrumentation.AutoLoaderResult.html | 4 +- ...metry_instrumentation.Instrumentation.html | 20 +- ...instrumentation.InstrumentationConfig.html | 4 +- ...ation.InstrumentationModuleDefinition.html | 16 +- ...rumentation.InstrumentationModuleFile.html | 12 +- ...telemetry_instrumentation.ShimWrapped.html | 4 +- ...orter-base.OTLPGRPCExporterConfigNode.html | 4 +- ...transformer.IExportLogsPartialSuccess.html | 6 +- ...ransformer.IExportLogsServiceResponse.html | 4 +- ...nsformer.IExportMetricsPartialSuccess.html | 6 +- ...sformer.IExportMetricsServiceResponse.html | 4 +- ...ransformer.IExportTracePartialSuccess.html | 6 +- ...ansformer.IExportTraceServiceResponse.html | 4 +- ...elemetry_otlp-transformer.ISerializer.html | 4 +- ...etry_propagator-b3.B3PropagatorConfig.html | 4 +- .../_opentelemetry_resources.Resource.html | 10 +- ...try_resources.ResourceDetectionConfig.html | 4 +- ...ntelemetry_resources.ResourceDetector.html | 4 +- ...r-remote.ProbabilisticSamplingOptions.html | 4 +- ....BatchLogRecordProcessorBrowserConfig.html | 12 +- .../_opentelemetry_sdk-logs.BufferConfig.html | 10 +- ...ntelemetry_sdk-logs.LogRecordExporter.html | 6 +- ...pentelemetry_sdk-logs.LogRecordLimits.html | 6 +- ...telemetry_sdk-logs.LogRecordProcessor.html | 8 +- ...lemetry_sdk-logs.LoggerProviderConfig.html | 10 +- ...ntelemetry_sdk-logs.ReadableLogRecord.html | 4 +- ...elemetry_sdk-metrics.CollectionResult.html | 6 +- .../_opentelemetry_sdk-metrics.DataPoint.html | 10 +- ...etry_sdk-metrics.ExponentialHistogram.html | 4 +- ...etrics.ExponentialHistogramMetricData.html | 6 +- ...telemetry_sdk-metrics.GaugeMetricData.html | 6 +- .../_opentelemetry_sdk-metrics.Histogram.html | 4 +- ...metry_sdk-metrics.HistogramMetricData.html | 6 +- ...etry_sdk-metrics.IAttributesProcessor.html | 4 +- ...entelemetry_sdk-metrics.IMetricReader.html | 16 +- ...etry_sdk-metrics.MeterProviderOptions.html | 6 +- ...etry_sdk-metrics.MetricCollectOptions.html | 4 +- ...elemetry_sdk-metrics.MetricDescriptor.html | 4 +- ...ntelemetry_sdk-metrics.MetricProducer.html | 4 +- ...metry_sdk-metrics.MetricReaderOptions.html | 10 +- ...emetry_sdk-metrics.PushMetricExporter.html | 12 +- ...telemetry_sdk-metrics.ResourceMetrics.html | 4 +- ...pentelemetry_sdk-metrics.ScopeMetrics.html | 4 +- ...entelemetry_sdk-metrics.SumMetricData.html | 6 +- ...lemetry_sdk-node.NodeSDKConfiguration.html | 8 +- ...-base.BatchSpanProcessorBrowserConfig.html | 12 +- ...telemetry_sdk-trace-base.BufferConfig.html | 10 +- ...elemetry_sdk-trace-base.GeneralLimits.html | 6 +- ...ntelemetry_sdk-trace-base.IdGenerator.html | 6 +- ...telemetry_sdk-trace-base.ReadableSpan.html | 4 +- ..._sdk-trace-base.SDKRegistrationConfig.html | 6 +- ..._opentelemetry_sdk-trace-base.Sampler.html | 6 +- ...lemetry_sdk-trace-base.SamplingResult.html | 8 +- ...telemetry_sdk-trace-base.SpanExporter.html | 8 +- ...entelemetry_sdk-trace-base.SpanLimits.html | 14 +- ...elemetry_sdk-trace-base.SpanProcessor.html | 10 +- ...entelemetry_sdk-trace-base.TimedEvent.html | 8 +- ...telemetry_sdk-trace-base.TracerConfig.html | 16 +- ...metry_sdk-trace-web.PerformanceLegacy.html | 4 +- ...ace-web.PerformanceResourceTimingInfo.html | 4 +- .../_opentelemetry_sdk-trace-web.URLLike.html | 4 +- ...ntelemetry_web-common.SessionProvider.html | 4 +- media/experimental_attributes.ts | 185 ++++++++++++++++++ types/_opentelemetry_api-logs.AnyValue.html | 2 +- ..._opentelemetry_api-logs.LogAttributes.html | 2 +- types/_opentelemetry_api-logs.LogBody.html | 2 +- ...api._opentelemetry_api.AttributeValue.html | 2 +- ...pentelemetry_api.BaggageEntryMetadata.html | 2 +- ...telemetry_api.BatchObservableCallback.html | 2 +- ...pi._opentelemetry_api.DiagLogFunction.html | 2 +- ...etry_api._opentelemetry_api.Exception.html | 2 +- ...lemetry_api._opentelemetry_api.HrTime.html | 2 +- ...pentelemetry_api.MetricAttributeValue.html | 2 +- ...i._opentelemetry_api.MetricAttributes.html | 2 +- ..._opentelemetry_api.ObservableCallback.html | 2 +- ...._opentelemetry_api.ObservableCounter.html | 2 +- ...pi._opentelemetry_api.ObservableGauge.html | 2 +- ...telemetry_api.ObservableUpDownCounter.html | 2 +- ..._opentelemetry_api.SpanAttributeValue.html | 2 +- ...api._opentelemetry_api.SpanAttributes.html | 2 +- ...etry_api._opentelemetry_api.TimeInput.html | 2 +- ...ntelemetry_context-zone-peer-dep.Func.html | 2 +- types/_opentelemetry_core.ErrorHandler.html | 2 +- types/_opentelemetry_core.RPCMetadata.html | 2 +- ...tp-request.XHRCustomAttributeFunction.html | 2 +- ...instrumentation.SpanCustomizationHook.html | 2 +- ...ntelemetry_resources.DetectedResource.html | 2 +- ..._resources.DetectedResourceAttributes.html | 2 +- ..._opentelemetry_resources.MaybePromise.html | 2 +- ...emetry_resources.RawResourceAttribute.html | 2 +- ...lemetry_sdk-metrics.AggregationOption.html | 2 +- ...metry_sdk-metrics.AggregationSelector.html | 2 +- ...etrics.AggregationTemporalitySelector.html | 2 +- .../_opentelemetry_sdk-metrics.LastValue.html | 2 +- ..._opentelemetry_sdk-metrics.MetricData.html | 2 +- ....PeriodicExportingMetricReaderOptions.html | 2 +- types/_opentelemetry_sdk-metrics.Sum.html | 2 +- ...opentelemetry_sdk-metrics.ViewOptions.html | 2 +- ...lemetry_sdk-node.LoggerProviderConfig.html | 2 +- ...elemetry_sdk-node.MeterProviderConfig.html | 2 +- types/_opentelemetry_sdk-trace-base.Span.html | 2 +- ...metry_sdk-trace-node.NodeTracerConfig.html | 2 +- ...etry_sdk-trace-web.PerformanceEntries.html | 2 +- ...race-web.PropagateTraceHeaderCorsUrls.html | 2 +- ...lemetry_sdk-trace-web.WebTracerConfig.html | 2 +- .../_opentelemetry_api-events.events.html | 2 +- .../_opentelemetry_api-logs.NOOP_LOGGER.html | 2 +- ...lemetry_api-logs.NOOP_LOGGER_PROVIDER.html | 2 +- variables/_opentelemetry_api-logs.logs.html | 2 +- ...api._opentelemetry_api.INVALID_SPANID.html | 2 +- ...pentelemetry_api.INVALID_SPAN_CONTEXT.html | 2 +- ...pi._opentelemetry_api.INVALID_TRACEID.html | 2 +- ...y_api._opentelemetry_api.ROOT_CONTEXT.html | 2 +- ...etry_api._opentelemetry_api.context-1.html | 2 +- ...emetry_api._opentelemetry_api.default.html | 2 +- ...pentelemetry_api.defaultTextMapGetter.html | 2 +- ...pentelemetry_api.defaultTextMapSetter.html | 2 +- ...telemetry_api._opentelemetry_api.diag.html | 2 +- ...emetry_api._opentelemetry_api.metrics.html | 2 +- ...ry_api._opentelemetry_api.propagation.html | 2 +- ...elemetry_api._opentelemetry_api.trace.html | 2 +- variables/_opentelemetry_core.SDK_INFO.html | 2 +- ...pentelemetry_core.TRACE_PARENT_HEADER.html | 2 +- ...opentelemetry_core.TRACE_STATE_HEADER.html | 2 +- .../_opentelemetry_core._globalThis.html | 2 +- variables/_opentelemetry_core.internal.html | 2 +- .../_opentelemetry_core.otperformance.html | 2 +- ...etry-browser-detector.browserDetector.html | 2 +- ...y_otlp-transformer.JsonLogsSerializer.html | 2 +- ...tlp-transformer.JsonMetricsSerializer.html | 2 +- ..._otlp-transformer.JsonTraceSerializer.html | 2 +- ...lp-transformer.ProtobufLogsSerializer.html | 2 +- ...transformer.ProtobufMetricsSerializer.html | 2 +- ...p-transformer.ProtobufTraceSerializer.html | 2 +- ...metry_propagator-b3.B3_CONTEXT_HEADER.html | 2 +- ...pentelemetry_propagator-b3.X_B3_FLAGS.html | 2 +- ...try_propagator-b3.X_B3_PARENT_SPAN_ID.html | 2 +- ...ntelemetry_propagator-b3.X_B3_SAMPLED.html | 2 +- ...ntelemetry_propagator-b3.X_B3_SPAN_ID.html | 2 +- ...telemetry_propagator-b3.X_B3_TRACE_ID.html | 2 +- ...tor-jaeger.UBER_BAGGAGE_HEADER_PREFIX.html | 2 +- ...ropagator-jaeger.UBER_TRACE_ID_HEADER.html | 2 +- .../_opentelemetry_resources.envDetector.html | 2 +- ..._opentelemetry_resources.hostDetector.html | 2 +- .../_opentelemetry_resources.osDetector.html | 2 +- ...entelemetry_resources.processDetector.html | 2 +- ...y_resources.serviceInstanceIdDetector.html | 2 +- 387 files changed, 1256 insertions(+), 1071 deletions(-) diff --git a/classes/_opentelemetry_api-logs.NoopLogger.html b/classes/_opentelemetry_api-logs.NoopLogger.html index f902d1a18..eee41b279 100644 --- a/classes/_opentelemetry_api-logs.NoopLogger.html +++ b/classes/_opentelemetry_api-logs.NoopLogger.html @@ -1,4 +1,4 @@ -NoopLogger | OpenTelemetry SDK

Implements

Constructors

constructor +NoopLogger | OpenTelemetry SDK

Implements

Constructors

Methods

Constructors

Methods

+

Parameters

Returns void

diff --git a/classes/_opentelemetry_api-logs.NoopLoggerProvider.html b/classes/_opentelemetry_api-logs.NoopLoggerProvider.html index 1ae548741..6b55832c8 100644 --- a/classes/_opentelemetry_api-logs.NoopLoggerProvider.html +++ b/classes/_opentelemetry_api-logs.NoopLoggerProvider.html @@ -1,7 +1,7 @@ NoopLoggerProvider | OpenTelemetry SDK

A registry for creating named Loggers.

-

Implements

Constructors

Implements

Constructors

Methods

Constructors

Methods

+
diff --git a/classes/_opentelemetry_api-logs.ProxyLogger.html b/classes/_opentelemetry_api-logs.ProxyLogger.html index d5710952f..ffc4b9b2d 100644 --- a/classes/_opentelemetry_api-logs.ProxyLogger.html +++ b/classes/_opentelemetry_api-logs.ProxyLogger.html @@ -1,7 +1,7 @@ -ProxyLogger | OpenTelemetry SDK

Implements

Constructors

constructor +ProxyLogger | OpenTelemetry SDK

Implements

Constructors

Properties

Methods

Constructors

Properties

name: string
options?: LoggerOptions
version?: string

Methods

+

Constructors

Properties

name: string
options?: LoggerOptions
version?: string

Methods

diff --git a/classes/_opentelemetry_api-logs.ProxyLoggerProvider.html b/classes/_opentelemetry_api-logs.ProxyLoggerProvider.html index 50868998c..cf1889812 100644 --- a/classes/_opentelemetry_api-logs.ProxyLoggerProvider.html +++ b/classes/_opentelemetry_api-logs.ProxyLoggerProvider.html @@ -1,14 +1,14 @@ ProxyLoggerProvider | OpenTelemetry SDK

A registry for creating named Loggers.

-

Implements

Constructors

Implements

Constructors

Methods

  • Returns a Logger, creating one if one with the given name, version, and +

Constructors

Methods

  • Returns a Logger, creating one if one with the given name, version, and schemaUrl pair is not already created.

    Parameters

    • name: string

      The name of the logger or instrumentation library.

    • Optionalversion: string

      The version of the logger or instrumentation library.

    • Optionaloptions: LoggerOptions

      The options of the logger or instrumentation library.

    Returns Logger

    Logger A Logger with the given name and version

    -
+
diff --git a/classes/_opentelemetry_api._opentelemetry_api.ContextAPI.html b/classes/_opentelemetry_api._opentelemetry_api.ContextAPI.html index b035c6ed5..c63bba107 100644 --- a/classes/_opentelemetry_api._opentelemetry_api.ContextAPI.html +++ b/classes/_opentelemetry_api._opentelemetry_api.ContextAPI.html @@ -1,22 +1,22 @@ ContextAPI | OpenTelemetry SDK

Singleton object which represents the entry point to the OpenTelemetry Context API

1.0.0

-

Methods

Methods

  • Bind a context to a target function or event emitter

    Type Parameters

    • T

    Parameters

    • context: Context

      context to bind to the event emitter or function. Defaults to the currently active context

    • target: T

      function or event emitter to bind

      -

    Returns T

  • Disable and remove the global context manager

    -

    Returns void

  • Set the current context manager.

    +

Returns T

+

Returns ReturnType<F>

diff --git a/classes/_opentelemetry_api._opentelemetry_api.DiagAPI.html b/classes/_opentelemetry_api._opentelemetry_api.DiagAPI.html index cbd6f1d77..8d672b38a 100644 --- a/classes/_opentelemetry_api._opentelemetry_api.DiagAPI.html +++ b/classes/_opentelemetry_api._opentelemetry_api.DiagAPI.html @@ -1,7 +1,7 @@ DiagAPI | OpenTelemetry SDK

Singleton object which represents the entry point to the OpenTelemetry internal diagnostic API

1.0.0

-

Implements

Implements

Properties

createComponentLogger debug disable error @@ -10,16 +10,16 @@ diagnostic API

verbose warn

Methods

Properties

createComponentLogger: (options: ComponentLoggerOptions) => DiagLogger

Log a general debug message that can be useful for identifying a failure. +

Properties

createComponentLogger: (options: ComponentLoggerOptions) => DiagLogger

Log a general debug message that can be useful for identifying a failure. Information logged at this level may include diagnostic details that would help identify a failure scenario. For example: Logging the order of execution of async operations.

-
disable: () => void

Unregister the global logger and return to Noop

-

Log an error scenario that was not expected and caused the requested operation to fail.

-

Log a general informational message, this should not affect functionality. +

disable: () => void

Unregister the global logger and return to Noop

+

Log an error scenario that was not expected and caused the requested operation to fail.

+

Log a general informational message, this should not affect functionality. This is also the default logging level so this should NOT be used for logging debugging level information.

-
setLogger: {
    (logger: DiagLogger, options?: DiagLoggerOptions): boolean;
    (logger: DiagLogger, logLevel?: DiagLogLevel): boolean;
}

Set the global DiagLogger and DiagLogLevel. +

setLogger: {
    (logger: DiagLogger, options?: DiagLoggerOptions): boolean;
    (logger: DiagLogger, logLevel?: DiagLogLevel): boolean;
}

Set the global DiagLogger and DiagLogLevel. If a global diag logger is already set, this will override it.

Type declaration

The DiagLogger instance to set as the default logger.

A DiagLoggerOptions object. If not provided, default values will be set.

true if the logger was successfully registered, else false

-

Log a detailed (verbose) trace level logging that can be used to identify failures +

Log a detailed (verbose) trace level logging that can be used to identify failures where debug level logging would be insufficient, this level of tracing can include input and output parameters and as such may include PII information passing through the API. As such it is recommended that this level of tracing should not be enabled in a production environment.

-

Log a warning scenario to inform the developer of an issues that should be investigated. +

Log a warning scenario to inform the developer of an issues that should be investigated. The requested operation may or may not have succeeded or completed.

-

Methods

+

Methods

diff --git a/classes/_opentelemetry_api._opentelemetry_api.DiagConsoleLogger.html b/classes/_opentelemetry_api._opentelemetry_api.DiagConsoleLogger.html index dd8c6ff6d..075b1c58e 100644 --- a/classes/_opentelemetry_api._opentelemetry_api.DiagConsoleLogger.html +++ b/classes/_opentelemetry_api._opentelemetry_api.DiagConsoleLogger.html @@ -2,25 +2,25 @@ If you want to limit the amount of logging to a specific level or lower use the createLogLevelDiagLogger

1.0.0

-

Implements

Constructors

Implements

Constructors

Properties

Constructors

Properties

Log a general debug message that can be useful for identifying a failure. +

Constructors

Properties

Log a general debug message that can be useful for identifying a failure. Information logged at this level may include diagnostic details that would help identify a failure scenario. Useful scenarios would be to log the execution order of async operations

-

Log an error scenario that was not expected and caused the requested operation to fail.

-

Log a general informational message, this should not affect functionality. +

Log an error scenario that was not expected and caused the requested operation to fail.

+

Log a general informational message, this should not affect functionality. This is also the default logging level so this should NOT be used for logging debugging level information.

-

Log a detailed (verbose) trace level logging that can be used to identify failures +

Log a detailed (verbose) trace level logging that can be used to identify failures where debug level logging would be insufficient, this level of tracing can include input and output parameters and as such may include PII information passing through the API. As such it is recommended that this level of tracing should not be enabled in a production environment.

-

Log a warning scenario to inform the developer of an issues that should be investigated. +

Log a warning scenario to inform the developer of an issues that should be investigated. The requested operation may or may not have succeeded or completed.

-
+
diff --git a/classes/_opentelemetry_api._opentelemetry_api.MetricsAPI.html b/classes/_opentelemetry_api._opentelemetry_api.MetricsAPI.html index 1a77cd759..c175a799f 100644 --- a/classes/_opentelemetry_api._opentelemetry_api.MetricsAPI.html +++ b/classes/_opentelemetry_api._opentelemetry_api.MetricsAPI.html @@ -1,13 +1,13 @@ MetricsAPI | OpenTelemetry SDK

Singleton object which represents the entry point to the OpenTelemetry Metrics API

-

Methods

Methods

  • Remove the global meter provider

    -

    Returns void

  • Set the current global meter provider. Returns true if the meter provider was successfully registered, else false.

    -

    Parameters

    Returns boolean

+

Parameters

Returns boolean

diff --git a/classes/_opentelemetry_api._opentelemetry_api.PropagationAPI.html b/classes/_opentelemetry_api._opentelemetry_api.PropagationAPI.html index 3430fe264..11565c61f 100644 --- a/classes/_opentelemetry_api._opentelemetry_api.PropagationAPI.html +++ b/classes/_opentelemetry_api._opentelemetry_api.PropagationAPI.html @@ -1,6 +1,6 @@ PropagationAPI | OpenTelemetry SDK

Singleton object which represents the entry point to the OpenTelemetry Propagation API

1.0.0

-

Properties

Properties

createBaggage: (entries?: Record<string, BaggageEntry>) => Baggage = createBaggage

Type declaration

    • (entries?: Record<string, BaggageEntry>): Baggage
    • Create a new Baggage with optional entries

      Parameters

      • entries: Record<string, BaggageEntry> = {}

        An array of baggage entries the new baggage should contain

        -

      Returns Baggage

deleteBaggage: (context: Context) => Context = deleteBaggage

Type declaration

getActiveBaggage: () => undefined | Baggage = getActiveBaggage

Type declaration

    • (): undefined | Baggage
    • Retrieve the current baggage from the active/current context

      +

Returns Baggage

deleteBaggage: (context: Context) => Context = deleteBaggage

Type declaration

getActiveBaggage: () => undefined | Baggage = getActiveBaggage

Type declaration

    • (): undefined | Baggage
    • Retrieve the current baggage from the active/current context

      Returns undefined | Baggage

      Extracted baggage from the context

      -
getBaggage: (context: Context) => undefined | Baggage = getBaggage

Type declaration

    • (context: Context): undefined | Baggage
    • Retrieve the current baggage from the given context

      +
getBaggage: (context: Context) => undefined | Baggage = getBaggage

Type declaration

    • (context: Context): undefined | Baggage
    • Retrieve the current baggage from the given context

      Parameters

      Returns undefined | Baggage

      Extracted baggage from the context

      -
setBaggage: (context: Context, baggage: Baggage) => Context = setBaggage

Type declaration

setBaggage: (context: Context, baggage: Baggage) => Context = setBaggage

Type declaration

Methods

Returns Context

Methods

  • Return a list of all fields which may be used by the propagator.

    -

    Returns string[]

Returns Context

  • Return a list of all fields which may be used by the propagator.

    +

    Returns string[]

  • Set the current propagator.

    +

Returns void

+
diff --git a/classes/_opentelemetry_api._opentelemetry_api.ProxyTracer.html b/classes/_opentelemetry_api._opentelemetry_api.ProxyTracer.html index 612666d63..411278e52 100644 --- a/classes/_opentelemetry_api._opentelemetry_api.ProxyTracer.html +++ b/classes/_opentelemetry_api._opentelemetry_api.ProxyTracer.html @@ -1,12 +1,12 @@ ProxyTracer | OpenTelemetry SDK

Proxy tracer provided by the proxy tracer provider

1.0.0

-

Implements

Constructors

Implements

Constructors

Properties

name: string
options?: TracerOptions
version?: string

Methods

  • Starts a new Span and calls the given function passing it the +

Constructors

Properties

name: string
options?: TracerOptions
version?: string

Methods

  • Starts a new Span and calls the given function passing it the created span as first argument. Additionally the new span gets set in context and this context is activated for the duration of the function call.

    @@ -17,7 +17,7 @@ for the duration of the function call.

    const span = tracer.startActiveSpan('op', span => {
    try {
    do some work
    return span;
    } catch (err) {
    span.setStatus({
    code: SpanStatusCode.ERROR,
    message: err.message,
    });
    throw err;
    }
    });
    do some more work
    span.end();
    -
+
diff --git a/classes/_opentelemetry_api._opentelemetry_api.ProxyTracerProvider.html b/classes/_opentelemetry_api._opentelemetry_api.ProxyTracerProvider.html index 68bc31979..7cdec4c92 100644 --- a/classes/_opentelemetry_api._opentelemetry_api.ProxyTracerProvider.html +++ b/classes/_opentelemetry_api._opentelemetry_api.ProxyTracerProvider.html @@ -4,11 +4,11 @@ When a delegate is set, traces are provided from the delegate. When a delegate is set after tracers have already been provided, all tracers already provided will use the provided delegate implementation.

1.0.0

-

Implements

Constructors

Implements

Constructors

Methods

+

Constructors

Methods

diff --git a/classes/_opentelemetry_api._opentelemetry_api.TraceAPI.html b/classes/_opentelemetry_api._opentelemetry_api.TraceAPI.html index 701a71aea..bf0e4f575 100644 --- a/classes/_opentelemetry_api._opentelemetry_api.TraceAPI.html +++ b/classes/_opentelemetry_api._opentelemetry_api.TraceAPI.html @@ -1,6 +1,6 @@ TraceAPI | OpenTelemetry SDK

Singleton object which represents the entry point to the OpenTelemetry Tracing API

1.0.0

-

Properties

Properties

deleteSpan: (context: Context) => Context = deleteSpan

Type declaration

getActiveSpan: () => undefined | Span = getActiveSpan

Type declaration

    • (): undefined | Span
    • Gets the span from the current context, if one exists.

      -

      Returns undefined | Span

getSpan: (context: Context) => undefined | Span = getSpan

Type declaration

    • (context: Context): undefined | Span
    • Return the span if one exists

      +

Returns Context

getActiveSpan: () => undefined | Span = getActiveSpan

Type declaration

    • (): undefined | Span
    • Gets the span from the current context, if one exists.

      +

      Returns undefined | Span

getSpan: (context: Context) => undefined | Span = getSpan

Type declaration

    • (context: Context): undefined | Span
    • Return the span if one exists

      Parameters

      • context: Context

        context to get span from

        -

      Returns undefined | Span

getSpanContext: (context: Context) => undefined | SpanContext = getSpanContext

Type declaration

    • (context: Context): undefined | SpanContext
    • Get the span context of the span if it exists.

      +

Returns undefined | Span

getSpanContext: (context: Context) => undefined | SpanContext = getSpanContext

Type declaration

isSpanContextValid: (spanContext: SpanContext) => boolean = isSpanContextValid

Type declaration

Returns undefined | SpanContext

isSpanContextValid: (spanContext: SpanContext) => boolean = isSpanContextValid

Type declaration

setSpan: (context: Context, span: Span) => Context = setSpan

Type declaration

setSpan: (context: Context, span: Span) => Context = setSpan

Type declaration

setSpanContext: (context: Context, spanContext: SpanContext) => Context = setSpanContext

Type declaration

Returns Context

setSpanContext: (context: Context, spanContext: SpanContext) => Context = setSpanContext

Type declaration

wrapSpanContext: (spanContext: SpanContext) => Span = wrapSpanContext

Type declaration

Returns Context

wrapSpanContext: (spanContext: SpanContext) => Span = wrapSpanContext

Type declaration

Methods

  • Remove the global tracer provider

    -

    Returns void

  • Returns a tracer from the global tracer provider.

    -

    Parameters

    • name: string
    • Optionalversion: string

    Returns Tracer

  • Set the current global tracer.

    +

Methods

  • Remove the global tracer provider

    +

    Returns void

  • Returns a tracer from the global tracer provider.

    +

    Parameters

    • name: string
    • Optionalversion: string

    Returns Tracer

  • Set the current global tracer.

    Parameters

    Returns boolean

    true if the tracer provider was successfully registered, else false

    -
+
diff --git a/classes/_opentelemetry_api._opentelemetry_api_experimental.SugaredTracer.html b/classes/_opentelemetry_api._opentelemetry_api_experimental.SugaredTracer.html index e3bdc8a64..3230e8dfb 100644 --- a/classes/_opentelemetry_api._opentelemetry_api_experimental.SugaredTracer.html +++ b/classes/_opentelemetry_api._opentelemetry_api_experimental.SugaredTracer.html @@ -1,11 +1,11 @@ SugaredTracer | OpenTelemetry SDK

Tracer provides an interface for creating Spans.

1.0.0

-

Implements

Constructors

Implements

Constructors

Properties

startActiveSpan: {
    <F extends (span: Span) => unknown>(name: string, fn: F): ReturnType<F>;
    <F extends (span: Span) => unknown>(
        name: string,
        options: SpanOptions,
        fn: F,
    ): ReturnType<F>;
    <F extends (span: Span) => unknown>(
        name: string,
        options: SpanOptions,
        context: Context,
        fn: F,
    ): ReturnType<F>;
}

Starts a new Span and calls the given function passing it the +

Constructors

Properties

startActiveSpan: {
    <F extends (span: Span) => unknown>(name: string, fn: F): ReturnType<F>;
    <F extends (span: Span) => unknown>(
        name: string,
        options: SpanOptions,
        fn: F,
    ): ReturnType<F>;
    <F extends (span: Span) => unknown>(
        name: string,
        options: SpanOptions,
        context: Context,
        fn: F,
    ): ReturnType<F>;
}

Starts a new Span and calls the given function passing it the created span as first argument. Additionally the new span gets set in context and this context is activated for the duration of the function call.

@@ -20,7 +20,7 @@ for the duration of the function call.

const span = tracer.startActiveSpan('op', span => {
try {
do some work
return span;
} catch (err) {
span.setStatus({
code: SpanStatusCode.ERROR,
message: err.message,
});
throw err;
}
});
do some more work
span.end();
-
startSpan: (name: string, options?: SpanOptions, context?: Context) => Span

Starts a new Span. Start the span without setting it on context.

+
startSpan: (name: string, options?: SpanOptions, context?: Context) => Span

Starts a new Span. Start the span without setting it on context.

This method do NOT modify the current Context.

Type declaration

    • (name: string, options?: SpanOptions, context?: Context): Span
    • Parameters

      • name: string

        The name of the span

      • Optionaloptions: SpanOptions

        SpanOptions used for span creation

        @@ -29,7 +29,7 @@ for the duration of the function call.

const span = tracer.startSpan('op');
span.setAttribute('key', 'value');
span.end();
-

Methods

Methods

  • Starts a new Span and calls the given function passing it the created span as first argument. Additionally, the new span gets set in context and this context is activated for the duration of the function call. @@ -44,7 +44,7 @@ If an exception occurs, it is recorded, the status is set to ERROR and the excep

    const something = await tracer.withActiveSpan('op', span => {
    // do some async work
    });
    -
  • Starts a new Span and calls the given function passing it the +

  • Starts a new Span and calls the given function passing it the created span as first argument. Additionally, the new span gets set in context and this context is activated for the duration of the function call. @@ -60,7 +60,7 @@ If an exception occurs, it is recorded, the status is set to ERROR and the excep

    const something = await tracer.withActiveSpan('op', span => {
    // do some async work
    });
    -
  • Starts a new Span and calls the given function passing it the +

  • Starts a new Span and calls the given function passing it the created span as first argument. Additionally, the new span gets set in context and this context is activated for the duration of the function call. @@ -77,7 +77,7 @@ If an exception occurs, it is recorded, the status is set to ERROR and the excep

    const something = await tracer.withActiveSpan('op', span => {
    // do some async work
    });
    -
  • Starts a new Span and ends it after execution of fn without setting it on context. +

  • Starts a new Span and ends it after execution of fn without setting it on context. The span will be closed after the function has executed. If an exception occurs, it is recorded, the status is et to ERROR and rethrown.

    This method does NOT modify the current Context.

    @@ -90,7 +90,7 @@ If an exception occurs, it is recorded, the status is et to ERROR and rethrown.<
    const something = await tracer.withSpan('op', span => {
    // do some async work
    });
    -
  • Starts a new Span and ends it after execution of fn without setting it on context. +

  • Starts a new Span and ends it after execution of fn without setting it on context. The span will be closed after the function has executed. If an exception occurs, it is recorded, the status is et to ERROR and rethrown.

    This method does NOT modify the current Context.

    @@ -104,7 +104,7 @@ If an exception occurs, it is recorded, the status is et to ERROR and rethrown.<
    const something = await tracer.withSpan('op', span => {
    // do some async work
    });
    -
  • Starts a new Span and ends it after execution of fn without setting it on context. +

  • Starts a new Span and ends it after execution of fn without setting it on context. The span will be closed after the function has executed. If an exception occurs, it is recorded, the status is et to ERROR and rethrown.

    This method does NOT modify the current Context.

    @@ -119,7 +119,7 @@ If an exception occurs, it is recorded, the status is et to ERROR and rethrown.<
    const something = await tracer.withSpan('op', span => {
    // do some async work
    });
    -
  • Starts a new Span and ends it after execution of fn without setting it on context. +

  • Starts a new Span and ends it after execution of fn without setting it on context. The span will be closed after the function has executed. If an exception occurs, it is recorded, the status is et to ERROR and rethrown.

    This method does NOT modify the current Context.

    @@ -134,4 +134,4 @@ If an exception occurs, it is recorded, the status is et to ERROR and rethrown.<
    const something = await tracer.withSpan('op', span => {
    // do some async work
    });
    -
+
diff --git a/classes/_opentelemetry_context-async-hooks.AsyncHooksContextManager.html b/classes/_opentelemetry_context-async-hooks.AsyncHooksContextManager.html index 53ccde98b..473bbab93 100644 --- a/classes/_opentelemetry_context-async-hooks.AsyncHooksContextManager.html +++ b/classes/_opentelemetry_context-async-hooks.AsyncHooksContextManager.html @@ -1,11 +1,11 @@ -AsyncHooksContextManager | OpenTelemetry SDK

Hierarchy

  • AbstractAsyncHooksContextManager
    • AsyncHooksContextManager

Constructors

constructor +AsyncHooksContextManager | OpenTelemetry SDK

Hierarchy

  • AbstractAsyncHooksContextManager
    • AsyncHooksContextManager

Constructors

Methods

Constructors

Methods

  • Binds a the certain context or the active one to the target function and then returns the target

    +

Constructors

Methods

  • Binds a the certain context or the active one to the target function and then returns the target

    Type Parameters

    • T

    Parameters

    • context: Context

      A context (span) to be bind to target

    • target: T

      a function or event emitter. When target or one of its callbacks is called, the provided context will be used as the active context for the duration of the call.

      -

    Returns T

  • Type Parameters

    • A extends unknown[]
    • F extends (...args: A) => ReturnType<F>

    Parameters

    • context: Context
    • fn: F
    • OptionalthisArg: ThisParameterType<F>
    • ...args: A

    Returns ReturnType<F>

+

Returns T

diff --git a/classes/_opentelemetry_context-async-hooks.AsyncLocalStorageContextManager.html b/classes/_opentelemetry_context-async-hooks.AsyncLocalStorageContextManager.html index d300a1aa1..b70446686 100644 --- a/classes/_opentelemetry_context-async-hooks.AsyncLocalStorageContextManager.html +++ b/classes/_opentelemetry_context-async-hooks.AsyncLocalStorageContextManager.html @@ -1,11 +1,11 @@ -AsyncLocalStorageContextManager | OpenTelemetry SDK

Hierarchy

  • AbstractAsyncHooksContextManager
    • AsyncLocalStorageContextManager

Constructors

constructor +AsyncLocalStorageContextManager | OpenTelemetry SDK

Hierarchy

  • AbstractAsyncHooksContextManager
    • AsyncLocalStorageContextManager

Constructors

Methods

Constructors

Methods

  • Binds a the certain context or the active one to the target function and then returns the target

    +

Constructors

Methods

  • Binds a the certain context or the active one to the target function and then returns the target

    Type Parameters

    • T

    Parameters

    • context: Context

      A context (span) to be bind to target

    • target: T

      a function or event emitter. When target or one of its callbacks is called, the provided context will be used as the active context for the duration of the call.

      -

    Returns T

  • Type Parameters

    • A extends unknown[]
    • F extends (...args: A) => ReturnType<F>

    Parameters

    • context: Context
    • fn: F
    • OptionalthisArg: ThisParameterType<F>
    • ...args: A

    Returns ReturnType<F>

+

Returns T

diff --git a/classes/_opentelemetry_context-zone-peer-dep.ZoneContextManager.html b/classes/_opentelemetry_context-zone-peer-dep.ZoneContextManager.html index b881d50e4..dff674dde 100644 --- a/classes/_opentelemetry_context-zone-peer-dep.ZoneContextManager.html +++ b/classes/_opentelemetry_context-zone-peer-dep.ZoneContextManager.html @@ -5,24 +5,24 @@ It heavily depends on [zone.js]h It stores the information about context in zone. Each Context will have always new Zone; It also supports binding a certain Span to a target that has "addEventListener" and "removeEventListener". When this happens a new zone is being created and the provided Span is being assigned to this zone.

-

Implements

Constructors

Implements

Constructors

Methods

  • Binds a the certain context or the active one to the target function and then returns the target

    Type Parameters

    • T

    Parameters

    • context: Context

      A context (span) to be bind to target

    • target: TargetWithEvents | T

      a function or event emitter. When target or one of its callbacks is called, the provided context will be used as the active context for the duration of the call.

      -

    Returns T

  • Calls the callback function [fn] with the provided [context]. +

Returns T

  • Calls the callback function [fn] with the provided [context]. If [context] is undefined then it will use the active context. The context will be set as active

    Type Parameters

    • A extends unknown[]
    • F extends (...args: A) => ReturnType<F>

    Parameters

    • context: null | Context

      A context (span) to be called with provided callback

    • fn: F

      Callback function

    • OptionalthisArg: ThisParameterType<F>

      optional receiver to be used for calling fn

    • ...args: A

      optional arguments forwarded to fn

      -

    Returns ReturnType<F>

+

Returns ReturnType<F>

diff --git a/classes/_opentelemetry_core.AnchoredClock.html b/classes/_opentelemetry_core.AnchoredClock.html index ecec38d50..a9815d585 100644 --- a/classes/_opentelemetry_core.AnchoredClock.html +++ b/classes/_opentelemetry_core.AnchoredClock.html @@ -10,11 +10,11 @@ to each other. For example, a child span will never have a start time before its if the system clock is corrected during the local trace.

Heavily inspired by the OTel Java anchored clock https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/AnchoredClock.java

-

Implements

Constructors

Implements

Constructors

Methods

Constructors

Methods

  • Returns the current time by adding the number of milliseconds since the +

Returns AnchoredClock

Methods

+

Returns number

diff --git a/classes/_opentelemetry_core.BindOnceFuture.html b/classes/_opentelemetry_core.BindOnceFuture.html index 4e938619a..deda56c07 100644 --- a/classes/_opentelemetry_core.BindOnceFuture.html +++ b/classes/_opentelemetry_core.BindOnceFuture.html @@ -1,6 +1,6 @@ BindOnceFuture | OpenTelemetry SDK

Bind the callback and only invoke the callback once regardless how many times BindOnceFuture.call is invoked.

-

Type Parameters

  • R
  • This = unknown
  • T extends (this: This, ...args: unknown[]) => R = () => R

Constructors

Type Parameters

  • R
  • This = unknown
  • T extends (this: This, ...args: unknown[]) => R = () => R

Constructors

Accessors

Methods

Constructors

Accessors

Methods

+

Constructors

Accessors

Methods

diff --git a/classes/_opentelemetry_core.CompositePropagator.html b/classes/_opentelemetry_core.CompositePropagator.html index b3d9fa72b..986770e25 100644 --- a/classes/_opentelemetry_core.CompositePropagator.html +++ b/classes/_opentelemetry_core.CompositePropagator.html @@ -1,21 +1,21 @@ CompositePropagator | OpenTelemetry SDK

Combines multiple propagators into a single propagator.

-

Implements

Constructors

Implements

Constructors

Methods

Constructors

Methods

  • Run each of the configured propagators with the given context and carrier. +

Returns CompositePropagator

Methods

  • Run each of the configured propagators with the given context and carrier. +

  • getter: TextMapGetter

Returns Context

+
  • setter: TextMapSetter
  • Returns void

    diff --git a/classes/_opentelemetry_core.TimeoutError.html b/classes/_opentelemetry_core.TimeoutError.html index f9e2b5afc..d32c1b290 100644 --- a/classes/_opentelemetry_core.TimeoutError.html +++ b/classes/_opentelemetry_core.TimeoutError.html @@ -1,5 +1,5 @@ TimeoutError | OpenTelemetry SDK

    Error that is thrown on timeouts.

    -

    Hierarchy

    • Error
      • TimeoutError

    Constructors

    Hierarchy

    • Error
      • TimeoutError

    Constructors

    Properties

    Methods

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    +

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    diff --git a/classes/_opentelemetry_core.TraceState.html b/classes/_opentelemetry_core.TraceState.html index 98cfb9c69..3194197ef 100644 --- a/classes/_opentelemetry_core.TraceState.html +++ b/classes/_opentelemetry_core.TraceState.html @@ -6,28 +6,28 @@ requirement (htt
  • The value of any key can be updated. Modified keys MUST be moved to the beginning of the list.
  • -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Returns the value to which the specified key is mapped, or undefined if +

    Constructors

    Methods

    • Returns the value to which the specified key is mapped, or undefined if this map contains no mapping for the key.

      Parameters

      • key: string

        with which the specified value is to be associated.

      Returns undefined | string

      the value to which the specified key is mapped, or undefined if this map contains no mapping for the key.

      -
    • Serializes the TraceState to a list as defined below. The list is a series of list-members separated by commas ,, and a list-member is a key/value pair separated by an equals sign =. Spaces and horizontal tabs surrounding list-members are ignored. There can be a maximum of 32 list-members in a list.

      Returns string

      the serialized string.

      -
    • Return a new TraceState which inherits from this TraceState but does not +

    Returns TraceState

    +

    Returns TraceState

    diff --git a/classes/_opentelemetry_core.W3CBaggagePropagator.html b/classes/_opentelemetry_core.W3CBaggagePropagator.html index 7f6bf643b..8986cf7e6 100644 --- a/classes/_opentelemetry_core.W3CBaggagePropagator.html +++ b/classes/_opentelemetry_core.W3CBaggagePropagator.html @@ -1,7 +1,7 @@ W3CBaggagePropagator | OpenTelemetry SDK

    Propagates Baggage through Context format propagation.

    Based on the Baggage specification: https://w3c.github.io/baggage/

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    extract fields inject @@ -14,8 +14,8 @@ the wire.

    headers.

  • getter: TextMapGetter

    an optional TextMapGetter. If undefined, keys will be all own properties, and keys will be accessed by direct object access.

    -
  • Returns Context

    • Injects values from a given Context into a carrier.

      +

    Returns Context

    +

    Returns void

    diff --git a/classes/_opentelemetry_core.W3CTraceContextPropagator.html b/classes/_opentelemetry_core.W3CTraceContextPropagator.html index 4d15ed697..5ac29440f 100644 --- a/classes/_opentelemetry_core.W3CTraceContextPropagator.html +++ b/classes/_opentelemetry_core.W3CTraceContextPropagator.html @@ -1,7 +1,7 @@ W3CTraceContextPropagator | OpenTelemetry SDK

    Propagates SpanContext through Trace Context format propagation.

    Based on the Trace Context specification: https://www.w3.org/TR/trace-context/

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    extract fields inject @@ -14,8 +14,8 @@ the wire.

    headers.

  • getter: TextMapGetter

    an optional TextMapGetter. If undefined, keys will be all own properties, and keys will be accessed by direct object access.

    -
  • Returns Context

    • Injects values from a given Context into a carrier.

      +

    Returns Context

    +

    Returns void

    diff --git a/classes/_opentelemetry_exporter-jaeger.JaegerExporter.html b/classes/_opentelemetry_exporter-jaeger.JaegerExporter.html index 2c50f6ae5..b6d1ce245 100644 --- a/classes/_opentelemetry_exporter-jaeger.JaegerExporter.html +++ b/classes/_opentelemetry_exporter-jaeger.JaegerExporter.html @@ -9,11 +9,11 @@ will not receive any security fixes past March 2024.

  • @opentelemetry/exporter-trace-otlp-grpc
  • @opentelemetry/exporter-trace-otlp-http
  • -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    +

    Constructors

    Methods

    diff --git a/classes/_opentelemetry_exporter-logs-otlp-grpc.OTLPLogExporter.html b/classes/_opentelemetry_exporter-logs-otlp-grpc.OTLPLogExporter.html index 5d6263fbd..0dc745877 100644 --- a/classes/_opentelemetry_exporter-logs-otlp-grpc.OTLPLogExporter.html +++ b/classes/_opentelemetry_exporter-logs-otlp-grpc.OTLPLogExporter.html @@ -1,8 +1,8 @@ OTLPLogExporter | OpenTelemetry SDK

    OTLP Logs Exporter for Node

    -

    Hierarchy

    Implements

    Constructors

    Hierarchy

    Implements

    Constructors

    Methods

    Constructors

    Methods

    Constructors

    Methods

    • Returns Promise<void>

    • Stops the exporter.

      Returns Promise<void>

    diff --git a/classes/_opentelemetry_exporter-logs-otlp-http.OTLPLogExporter.html b/classes/_opentelemetry_exporter-logs-otlp-http.OTLPLogExporter.html index 4e7988f8a..b3fa0f96e 100644 --- a/classes/_opentelemetry_exporter-logs-otlp-http.OTLPLogExporter.html +++ b/classes/_opentelemetry_exporter-logs-otlp-http.OTLPLogExporter.html @@ -1,8 +1,8 @@ OTLPLogExporter | OpenTelemetry SDK

    Collector Logs Exporter for Node

    -

    Hierarchy

    Implements

    Constructors

    Hierarchy

    Implements

    Constructors

    Methods

    Constructors

    Methods

    Constructors

    Methods

    • Returns Promise<void>

    • Stops the exporter.

      Returns Promise<void>

    diff --git a/classes/_opentelemetry_exporter-logs-otlp-proto.OTLPLogExporter.html b/classes/_opentelemetry_exporter-logs-otlp-proto.OTLPLogExporter.html index ff315c2eb..737620505 100644 --- a/classes/_opentelemetry_exporter-logs-otlp-proto.OTLPLogExporter.html +++ b/classes/_opentelemetry_exporter-logs-otlp-proto.OTLPLogExporter.html @@ -1,8 +1,8 @@ OTLPLogExporter | OpenTelemetry SDK

    OTLP Log Protobuf Exporter for Node.js

    -

    Hierarchy

    Implements

    Constructors

    Hierarchy

    Implements

    Constructors

    Methods

    Constructors

    Methods

    Constructors

    Methods

    • Returns Promise<void>

    • Stops the exporter.

      Returns Promise<void>

    diff --git a/classes/_opentelemetry_exporter-metrics-otlp-grpc.OTLPMetricExporter.html b/classes/_opentelemetry_exporter-metrics-otlp-grpc.OTLPMetricExporter.html index bd118ceea..6c3eeb64e 100644 --- a/classes/_opentelemetry_exporter-metrics-otlp-grpc.OTLPMetricExporter.html +++ b/classes/_opentelemetry_exporter-metrics-otlp-grpc.OTLPMetricExporter.html @@ -1,11 +1,11 @@ OTLPMetricExporter | OpenTelemetry SDK

    OTLP-gRPC metric exporter

    -

    Hierarchy (View Summary)

    Constructors

    Hierarchy (View Summary)

    Constructors

    Methods

    Constructors

    Methods

    • Ensure that the export of any metrics the exporter has received is completed before the returned promise is settled.

      Returns Promise<void>

    • Handle once the SDK has initialized this MetricReader Overriding this method is optional.

      Returns void

    • Shuts down the metric reader, the promise will reject after the optional timeout or resolve after completion.

      NOTE: this operation MAY continue even after the promise rejects due to a timeout.

      Parameters

      • Optionaloptions: CommonReaderOptions

        options with timeout.

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_exporter-prometheus.PrometheusSerializer.html b/classes/_opentelemetry_exporter-prometheus.PrometheusSerializer.html index df642505e..67dddbbab 100644 --- a/classes/_opentelemetry_exporter-prometheus.PrometheusSerializer.html +++ b/classes/_opentelemetry_exporter-prometheus.PrometheusSerializer.html @@ -1,4 +1,4 @@ -PrometheusSerializer | OpenTelemetry SDK

    Constructors

    constructor +PrometheusSerializer | OpenTelemetry SDK

    Constructors

    Methods

    +

    Constructors

    Methods

    diff --git a/classes/_opentelemetry_exporter-trace-otlp-grpc.OTLPTraceExporter.html b/classes/_opentelemetry_exporter-trace-otlp-grpc.OTLPTraceExporter.html index 7b5122e8b..9ba1f8d97 100644 --- a/classes/_opentelemetry_exporter-trace-otlp-grpc.OTLPTraceExporter.html +++ b/classes/_opentelemetry_exporter-trace-otlp-grpc.OTLPTraceExporter.html @@ -1,9 +1,9 @@ OTLPTraceExporter | OpenTelemetry SDK

    OTLP Trace Exporter for Node

    -

    Hierarchy

    Implements

    Constructors

    Hierarchy

    Implements

    Constructors

    Methods

    Constructors

    Methods

    Constructors

    Methods

    • Immediately export all spans

      Returns Promise<void>

    • Stops the exporter.

      Returns Promise<void>

    diff --git a/classes/_opentelemetry_exporter-trace-otlp-http.OTLPTraceExporter.html b/classes/_opentelemetry_exporter-trace-otlp-http.OTLPTraceExporter.html index c80cfdb22..f65cd3dbc 100644 --- a/classes/_opentelemetry_exporter-trace-otlp-http.OTLPTraceExporter.html +++ b/classes/_opentelemetry_exporter-trace-otlp-http.OTLPTraceExporter.html @@ -1,9 +1,9 @@ OTLPTraceExporter | OpenTelemetry SDK

    Collector Trace Exporter for Node

    -

    Hierarchy

    Implements

    Constructors

    Hierarchy

    Implements

    Constructors

    Methods

    Constructors

    Methods

    Constructors

    Methods

    • Immediately export all spans

      Returns Promise<void>

    • Stops the exporter.

      Returns Promise<void>

    diff --git a/classes/_opentelemetry_exporter-trace-otlp-proto.OTLPTraceExporter.html b/classes/_opentelemetry_exporter-trace-otlp-proto.OTLPTraceExporter.html index e6173c757..d6f06903c 100644 --- a/classes/_opentelemetry_exporter-trace-otlp-proto.OTLPTraceExporter.html +++ b/classes/_opentelemetry_exporter-trace-otlp-proto.OTLPTraceExporter.html @@ -1,9 +1,9 @@ OTLPTraceExporter | OpenTelemetry SDK

    Collector Trace Exporter for Node with protobuf

    -

    Hierarchy

    Implements

    Constructors

    Hierarchy

    Implements

    Constructors

    Methods

    Constructors

    Methods

    Constructors

    Methods

    • Immediately export all spans

      Returns Promise<void>

    • Stops the exporter.

      Returns Promise<void>

    diff --git a/classes/_opentelemetry_exporter-zipkin.ZipkinExporter.html b/classes/_opentelemetry_exporter-zipkin.ZipkinExporter.html index ebb4d9bbf..2beb8a6ff 100644 --- a/classes/_opentelemetry_exporter-zipkin.ZipkinExporter.html +++ b/classes/_opentelemetry_exporter-zipkin.ZipkinExporter.html @@ -1,9 +1,9 @@ ZipkinExporter | OpenTelemetry SDK

    Zipkin Exporter

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    +

    Constructors

    Methods

    diff --git a/classes/_opentelemetry_instrumentation-fetch.FetchInstrumentation.html b/classes/_opentelemetry_instrumentation-fetch.FetchInstrumentation.html index bb44a95db..481f592f5 100644 --- a/classes/_opentelemetry_instrumentation-fetch.FetchInstrumentation.html +++ b/classes/_opentelemetry_instrumentation-fetch.FetchInstrumentation.html @@ -1,5 +1,5 @@ FetchInstrumentation | OpenTelemetry SDK

    This class represents a fetch plugin for auto instrumentation

    -

    Hierarchy (View Summary)

    Constructors

    Hierarchy (View Summary)

    Constructors

    Properties

    _diag: DiagLogger
    _massUnwrap: <Nodule extends object>(
        nodules: Nodule[],
        names: (keyof Nodule)[],
    ) => void
    _massWrap: <Nodule extends object, FieldName extends string | number | symbol>(
        nodules: Nodule[],
        names: FieldName[],
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ) => void
    _unwrap: <Nodule extends object>(nodule: Nodule, name: keyof Nodule) => void
    _wrap: <Nodule extends object, FieldName extends string | number | symbol>(
        nodule: Nodule,
        name: FieldName,
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ) => void
    component: string = 'fetch'
    instrumentationName: string

    Instrumentation Name

    +

    Constructors

    Properties

    _diag: DiagLogger
    _massUnwrap: <Nodule extends object>(
        nodules: Nodule[],
        names: (keyof Nodule)[],
    ) => void
    _massWrap: <Nodule extends object, FieldName extends string | number | symbol>(
        nodules: Nodule[],
        names: FieldName[],
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ) => void
    _unwrap: <Nodule extends object>(nodule: Nodule, name: keyof Nodule) => void
    _wrap: <Nodule extends object, FieldName extends string | number | symbol>(
        nodule: Nodule,
        name: FieldName,
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ) => void
    component: string = 'fetch'
    instrumentationName: string

    Instrumentation Name

    instrumentationVersion: string

    Instrumentation Version

    -
    moduleName: string = ...
    version: string = VERSION

    Accessors

    • get logger(): Logger

      Returns Logger

    • get meter(): Meter

      Returns Meter

    • get tracer(): Tracer

      Returns Tracer

    Methods

    moduleName: string = ...
    version: string = VERSION

    Accessors

    • get logger(): Logger

      Returns Logger

    • get meter(): Meter

      Returns Meter

    • get tracer(): Tracer

      Returns Tracer

    Methods

    • Execute span customization hook, if configured, and log any errors. Any semantics of the trigger and info are defined by the specific instrumentation.

      Type Parameters

      • SpanCustomizationInfoType

      Parameters

      • hookHandler: undefined | SpanCustomizationHook<SpanCustomizationInfoType>

        The optional hook handler which the user has configured via instrumentation config

      • triggerName: string

        The name of the trigger for executing the hook for logging purposes

        @@ -36,14 +36,14 @@ Any semantics of the trigger and info are defined by the specific instrumentatio
      • info: SpanCustomizationInfoType

        The info object to be passed to the hook, with useful data the hook may use

      Returns void

    • Sets the new metric instruments with the current Meter.

      Returns void

    • Returns boolean

    • Returns boolean

    • Method to disable the instrumentation

      Returns void

    • Method to enable the instrumentation

      Returns void

    • Returns boolean

    • Returns boolean

    diff --git a/classes/_opentelemetry_instrumentation-xml-http-request.XMLHttpRequestInstrumentation.html b/classes/_opentelemetry_instrumentation-xml-http-request.XMLHttpRequestInstrumentation.html index 2e0fea2fa..4a18e4fe5 100644 --- a/classes/_opentelemetry_instrumentation-xml-http-request.XMLHttpRequestInstrumentation.html +++ b/classes/_opentelemetry_instrumentation-xml-http-request.XMLHttpRequestInstrumentation.html @@ -1,5 +1,5 @@ XMLHttpRequestInstrumentation | OpenTelemetry SDK

    This class represents a XMLHttpRequest plugin for auto instrumentation

    -

    Hierarchy (View Summary)

    Constructors

    Hierarchy (View Summary)

    Constructors

    Properties

    _diag: DiagLogger
    _massUnwrap: <Nodule extends object>(
        nodules: Nodule[],
        names: (keyof Nodule)[],
    ) => void
    _massWrap: <Nodule extends object, FieldName extends string | number | symbol>(
        nodules: Nodule[],
        names: FieldName[],
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ) => void
    _unwrap: <Nodule extends object>(nodule: Nodule, name: keyof Nodule) => void
    _wrap: <Nodule extends object, FieldName extends string | number | symbol>(
        nodule: Nodule,
        name: FieldName,
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ) => void
    component: string = 'xml-http-request'
    instrumentationName: string

    Instrumentation Name

    +

    Constructors

    Properties

    _diag: DiagLogger
    _massUnwrap: <Nodule extends object>(
        nodules: Nodule[],
        names: (keyof Nodule)[],
    ) => void
    _massWrap: <Nodule extends object, FieldName extends string | number | symbol>(
        nodules: Nodule[],
        names: FieldName[],
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ) => void
    _unwrap: <Nodule extends object>(nodule: Nodule, name: keyof Nodule) => void
    _wrap: <Nodule extends object, FieldName extends string | number | symbol>(
        nodule: Nodule,
        name: FieldName,
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ) => void
    component: string = 'xml-http-request'
    instrumentationName: string

    Instrumentation Name

    instrumentationVersion: string

    Instrumentation Version

    -
    moduleName: string = ...
    version: string = VERSION

    Accessors

    • get logger(): Logger

      Returns Logger

    • get meter(): Meter

      Returns Meter

    • get tracer(): Tracer

      Returns Tracer

    Methods

    moduleName: string = ...
    version: string = VERSION

    Accessors

    • get logger(): Logger

      Returns Logger

    • get meter(): Meter

      Returns Meter

    • get tracer(): Tracer

      Returns Tracer

    Methods

    • Execute span customization hook, if configured, and log any errors. Any semantics of the trigger and info are defined by the specific instrumentation.

      Type Parameters

      • SpanCustomizationInfoType

      Parameters

      • hookHandler: undefined | SpanCustomizationHook<SpanCustomizationInfoType>

        The optional hook handler which the user has configured via instrumentation config

      • triggerName: string

        The name of the trigger for executing the hook for logging purposes

        @@ -36,14 +36,14 @@ Any semantics of the trigger and info are defined by the specific instrumentatio
      • info: SpanCustomizationInfoType

        The info object to be passed to the hook, with useful data the hook may use

      Returns void

    • Sets the new metric instruments with the current Meter.

      Returns void

    • Returns boolean

    • Returns boolean

    +

    Returns void | InstrumentationModuleDefinition | InstrumentationModuleDefinition[]

    diff --git a/classes/_opentelemetry_instrumentation.InstrumentationNodeModuleDefinition.html b/classes/_opentelemetry_instrumentation.InstrumentationNodeModuleDefinition.html index 4c184f9ed..f4dd92b0e 100644 --- a/classes/_opentelemetry_instrumentation.InstrumentationNodeModuleDefinition.html +++ b/classes/_opentelemetry_instrumentation.InstrumentationNodeModuleDefinition.html @@ -1,13 +1,13 @@ -InstrumentationNodeModuleDefinition | OpenTelemetry SDK

    Implements

    Constructors

    constructor +InstrumentationNodeModuleDefinition | OpenTelemetry SDK

    Implements

    Constructors

    Properties

    Module internal files to be patched

    -
    name: string

    Module name or path

    -
    patch?: (exports: any, moduleVersion?: string) => any

    Method to patch the instrumentation

    -
    supportedVersions: string[]

    Supported version of module.

    +

    Constructors

    Properties

    Module internal files to be patched

    +
    name: string

    Module name or path

    +
    patch?: (exports: any, moduleVersion?: string) => any

    Method to patch the instrumentation

    +
    supportedVersions: string[]

    Supported version of module.

    A module version is supported if one of the supportedVersions in the array satisfies the module version. The syntax of the version is checked with the satisfies function of "The semantic versioner for npm". @@ -16,5 +16,5 @@ If omitted, all versions of the module will be patched.

    It is recommended to always specify a range that is bound to a major version, to avoid breaking changes. New major versions should be reviewed and tested before being added to the supportedVersions array.

    Example: ['>=1.2.3 <3']

    -
    unpatch?: (exports: any, moduleVersion?: string) => void

    Method to unpatch the instrumentation

    -
    +
    unpatch?: (exports: any, moduleVersion?: string) => void

    Method to unpatch the instrumentation

    +
    diff --git a/classes/_opentelemetry_instrumentation.InstrumentationNodeModuleFile.html b/classes/_opentelemetry_instrumentation.InstrumentationNodeModuleFile.html index de2181db6..6412207fb 100644 --- a/classes/_opentelemetry_instrumentation.InstrumentationNodeModuleFile.html +++ b/classes/_opentelemetry_instrumentation.InstrumentationNodeModuleFile.html @@ -1,10 +1,10 @@ -InstrumentationNodeModuleFile | OpenTelemetry SDK

    Implements

    Constructors

    constructor +InstrumentationNodeModuleFile | OpenTelemetry SDK

    Implements

    Constructors

    Properties

    name: string

    Name of file to be patched with relative path

    -
    patch: (moduleExports: any, moduleVersion?: string) => any
    supportedVersions: string[]

    Supported versions for the file.

    +

    Constructors

    Properties

    name: string

    Name of file to be patched with relative path

    +
    patch: (moduleExports: any, moduleVersion?: string) => any
    supportedVersions: string[]

    Supported versions for the file.

    A module version is supported if one of the supportedVersions in the array satisfies the module version. The syntax of the version is checked with a function compatible with node-semver's satisfies() function. @@ -13,4 +13,4 @@ If omitted, all versions of the module will be patched.

    It is recommended to always specify a range that is bound to a major version, to avoid breaking changes. New major versions should be reviewed and tested before being added to the supportedVersions array.

    Example: ['>=1.2.3 <3']

    -
    unpatch: (moduleExports?: any, moduleVersion?: string) => void
    +
    unpatch: (moduleExports?: any, moduleVersion?: string) => void
    diff --git a/classes/_opentelemetry_propagator-b3.B3Propagator.html b/classes/_opentelemetry_propagator-b3.B3Propagator.html index e098be238..a010330f0 100644 --- a/classes/_opentelemetry_propagator-b3.B3Propagator.html +++ b/classes/_opentelemetry_propagator-b3.B3Propagator.html @@ -3,12 +3,12 @@ with configurable injection format defaulting to B3 single-header. Due to the asymmetry in injection and extraction formats this is not suitable to be implemented as a composite propagator. Based on: https://github.com/openzipkin/b3-propagation

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    _fields: string[]

    Methods

    • Given a Context and a carrier, extract context values from a +

    Constructors

    Properties

    _fields: string[]

    Methods

    • Given a Context and a carrier, extract context values from a carrier and return a new context, created from the old context, with the extracted values.

      Parameters

      • context: Context

        the Context from which to extract values to transmit over @@ -17,8 +17,8 @@ the wire.

        headers.

      • getter: TextMapGetter

        an optional TextMapGetter. If undefined, keys will be all own properties, and keys will be accessed by direct object access.

        -

      Returns Context

    • Injects values from a given Context into a carrier.

      +

    Returns Context

    • Injects values from a given Context into a carrier.

      OpenTelemetry defines a common set of format values (TextMapPropagator), and each has an expected carrier type.

      Parameters

      • context: Context

        the Context from which to extract values to transmit over @@ -27,4 +27,4 @@ the wire.

        headers.

      • setter: TextMapSetter

        an optional TextMapSetter. If undefined, values will be set by direct object assignment.

        -

      Returns void

    +

    Returns void

    diff --git a/classes/_opentelemetry_propagator-jaeger.JaegerPropagator.html b/classes/_opentelemetry_propagator-jaeger.JaegerPropagator.html index 3916c9c77..4bfb5c0e6 100644 --- a/classes/_opentelemetry_propagator-jaeger.JaegerPropagator.html +++ b/classes/_opentelemetry_propagator-jaeger.JaegerPropagator.html @@ -11,11 +11,11 @@ Set to 0 because this field is deprecated. {flags} One byte bitmap, as two hex digits. Inspired by jaeger-client-node project.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Given a Context and a carrier, extract context values from a +

    Constructors

    Methods

    • Given a Context and a carrier, extract context values from a carrier and return a new context, created from the old context, with the extracted values.

      Parameters

      • context: Context

        the Context from which to extract values to transmit over @@ -24,8 +24,8 @@ the wire.

        headers.

      • getter: TextMapGetter

        an optional TextMapGetter. If undefined, keys will be all own properties, and keys will be accessed by direct object access.

        -

      Returns Context

    • Injects values from a given Context into a carrier.

      +

    Returns Context

    • Injects values from a given Context into a carrier.

      OpenTelemetry defines a common set of format values (TextMapPropagator), and each has an expected carrier type.

      Parameters

      • context: Context

        the Context from which to extract values to transmit over @@ -34,4 +34,4 @@ the wire.

        headers.

      • setter: TextMapSetter

        an optional TextMapSetter. If undefined, values will be set by direct object assignment.

        -

      Returns void

    +

    Returns void

    diff --git a/classes/_opentelemetry_sampler-jaeger-remote.JaegerRemoteSampler.html b/classes/_opentelemetry_sampler-jaeger-remote.JaegerRemoteSampler.html index ff1ddb665..4fe6d15ae 100644 --- a/classes/_opentelemetry_sampler-jaeger-remote.JaegerRemoteSampler.html +++ b/classes/_opentelemetry_sampler-jaeger-remote.JaegerRemoteSampler.html @@ -1,8 +1,8 @@ JaegerRemoteSampler | OpenTelemetry SDK

    JaegerRemoteSampler

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Checks whether span needs to be created and tracked.

      +

    Constructors

    Methods

    • Checks whether span needs to be created and tracked.

      Parameters

      • context: Context

        Parent Context which may contain a span.

      • traceId: string

        of the span to be created. It can be different from the traceId in the SpanContext. Typically in situations when the @@ -13,5 +13,5 @@ span to be created starts a new trace.

      • links: Link[]

        Collection of links that will be associated with the Span to be created. Typically useful for batch operations.

      Returns node.SamplingResult

      a SamplingResult.

      -
    +
    diff --git a/classes/_opentelemetry_sdk-events.EventLogger.html b/classes/_opentelemetry_sdk-events.EventLogger.html index a09b2fb35..1254be2bf 100644 --- a/classes/_opentelemetry_sdk-events.EventLogger.html +++ b/classes/_opentelemetry_sdk-events.EventLogger.html @@ -1,4 +1,4 @@ -EventLogger | OpenTelemetry SDK

    Implements

    Constructors

    constructor +EventLogger | OpenTelemetry SDK

    Implements

    Constructors

    Methods

    Constructors

    Methods

    +

    Constructors

    Methods

    diff --git a/classes/_opentelemetry_sdk-events.EventLoggerProvider.html b/classes/_opentelemetry_sdk-events.EventLoggerProvider.html index 74d4491cf..d19ec36eb 100644 --- a/classes/_opentelemetry_sdk-events.EventLoggerProvider.html +++ b/classes/_opentelemetry_sdk-events.EventLoggerProvider.html @@ -1,11 +1,11 @@ EventLoggerProvider | OpenTelemetry SDK

    A registry for creating named EventLoggers.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    • Returns an EventLogger, creating one if one with the given name, version, and +

    Constructors

    Methods

    • Returns an EventLogger, creating one if one with the given name, version, and schemaUrl pair is not already created.

      Parameters

      • name: string

        The name of the event logger or instrumentation library.

      • Optionalversion: string

        The version of the event logger or instrumentation library.

      • Optionaloptions: EventLoggerOptions

        The options of the event logger or instrumentation library.

      Returns EventLogger

      EventLogger An event logger with the given name and version.

      -
    +
    diff --git a/classes/_opentelemetry_sdk-logs.BatchLogRecordProcessor.html b/classes/_opentelemetry_sdk-logs.BatchLogRecordProcessor.html index 4c08ebc30..0898f7048 100644 --- a/classes/_opentelemetry_sdk-logs.BatchLogRecordProcessor.html +++ b/classes/_opentelemetry_sdk-logs.BatchLogRecordProcessor.html @@ -1,11 +1,11 @@ -BatchLogRecordProcessor | OpenTelemetry SDK

    Hierarchy

    • BatchLogRecordProcessorBase<BufferConfig>
      • BatchLogRecordProcessor

    Constructors

    constructor +BatchLogRecordProcessor | OpenTelemetry SDK

    Hierarchy

    • BatchLogRecordProcessorBase<BufferConfig>
      • BatchLogRecordProcessor

    Constructors

    Methods

    Constructors

    Methods

    • Shuts down the processor. Called when SDK is shut down. This is an +

    Returns void

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-logs.ConsoleLogRecordExporter.html b/classes/_opentelemetry_sdk-logs.ConsoleLogRecordExporter.html index 396e011bc..c3421e742 100644 --- a/classes/_opentelemetry_sdk-logs.ConsoleLogRecordExporter.html +++ b/classes/_opentelemetry_sdk-logs.ConsoleLogRecordExporter.html @@ -1,9 +1,9 @@ ConsoleLogRecordExporter | OpenTelemetry SDK

    This is implementation of LogRecordExporter that prints LogRecords to the console. This class can be used for diagnostic purposes.

    NOTE: This LogRecordExporter is intended for diagnostics use only, output rendered to the console may change at any time.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    +

    Parameters

    Returns void

    diff --git a/classes/_opentelemetry_sdk-logs.InMemoryLogRecordExporter.html b/classes/_opentelemetry_sdk-logs.InMemoryLogRecordExporter.html index bbfc1fb05..0960f239a 100644 --- a/classes/_opentelemetry_sdk-logs.InMemoryLogRecordExporter.html +++ b/classes/_opentelemetry_sdk-logs.InMemoryLogRecordExporter.html @@ -1,7 +1,7 @@ InMemoryLogRecordExporter | OpenTelemetry SDK

    This class can be used for testing purposes. It stores the exported LogRecords in a list in memory that can be retrieved using the getFinishedLogRecords() method.

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    export getFinishedLogRecords @@ -9,7 +9,7 @@ method.

    shutdown

    Constructors

    Properties

    _stopped: boolean = false

    Indicates if the exporter has been "shutdown." When false, exported log records will not be stored in-memory.

    -

    Methods

    Methods

    +
  • resultCallback: (result: core.ExportResult) => void
  • Returns void

    diff --git a/classes/_opentelemetry_sdk-logs.LogRecord.html b/classes/_opentelemetry_sdk-logs.LogRecord.html index b6a5f7bd1..c2adeb92c 100644 --- a/classes/_opentelemetry_sdk-logs.LogRecord.html +++ b/classes/_opentelemetry_sdk-logs.LogRecord.html @@ -1,4 +1,4 @@ -LogRecord | OpenTelemetry SDK

    Implements

    Constructors

    constructor +LogRecord | OpenTelemetry SDK

    Implements

    Constructors

    Properties

    attributes: AnyValueMap = {}
    hrTime: HrTime
    hrTimeObserved: HrTime
    instrumentationScope: core.InstrumentationScope
    spanContext?: SpanContext

    Accessors

    Methods

    • Internal

      A LogRecordProcessor may freely modify logRecord for the duration of the OnEmit call. +

    Constructors

    Properties

    attributes: AnyValueMap = {}
    hrTime: HrTime
    hrTimeObserved: HrTime
    instrumentationScope: core.InstrumentationScope
    spanContext?: SpanContext

    Accessors

    Methods

    • Internal

      A LogRecordProcessor may freely modify logRecord for the duration of the OnEmit call. If logRecord is needed after OnEmit returns (i.e. for asynchronous processing) only reads are permitted.

      -

      Returns void

    +

    Returns void

    diff --git a/classes/_opentelemetry_sdk-logs.LoggerProvider.html b/classes/_opentelemetry_sdk-logs.LoggerProvider.html index 999047d0e..83bd70069 100644 --- a/classes/_opentelemetry_sdk-logs.LoggerProvider.html +++ b/classes/_opentelemetry_sdk-logs.LoggerProvider.html @@ -1,16 +1,16 @@ LoggerProvider | OpenTelemetry SDK

    A registry for creating named Loggers.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Notifies all registered LogRecordProcessor to flush any buffered data.

      +
    • Notifies all registered LogRecordProcessor to flush any buffered data.

      Returns a promise which is resolved when all flushes are complete.

      -

      Returns Promise<void>

    • Flush all buffered data and shut down the LoggerProvider and all registered +

      Returns Promise<void>

    • Flush all buffered data and shut down the LoggerProvider and all registered LogRecordProcessor.

      Returns a promise which is resolved when all flushes are complete.

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-logs.NoopLogRecordProcessor.html b/classes/_opentelemetry_sdk-logs.NoopLogRecordProcessor.html index 72cccda3b..0ec3bf18f 100644 --- a/classes/_opentelemetry_sdk-logs.NoopLogRecordProcessor.html +++ b/classes/_opentelemetry_sdk-logs.NoopLogRecordProcessor.html @@ -1,11 +1,11 @@ -NoopLogRecordProcessor | OpenTelemetry SDK

    Implements

    Constructors

    constructor +NoopLogRecordProcessor | OpenTelemetry SDK

    Implements

    Constructors

    Methods

    • Shuts down the processor. Called when SDK is shut down. This is an +

    Returns void

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-logs.SimpleLogRecordProcessor.html b/classes/_opentelemetry_sdk-logs.SimpleLogRecordProcessor.html index 142815125..22e5642c3 100644 --- a/classes/_opentelemetry_sdk-logs.SimpleLogRecordProcessor.html +++ b/classes/_opentelemetry_sdk-logs.SimpleLogRecordProcessor.html @@ -1,10 +1,10 @@ -SimpleLogRecordProcessor | OpenTelemetry SDK

    Implements

    Constructors

    constructor +SimpleLogRecordProcessor | OpenTelemetry SDK

    Implements

    Constructors

    Methods

    Constructors

    Methods

    Constructors

    Methods

    • Shuts down the processor. Called when SDK is shut down. This is an +

    Returns void

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-metrics.ConsoleMetricExporter.html b/classes/_opentelemetry_sdk-metrics.ConsoleMetricExporter.html index c6680607f..bd43be3ca 100644 --- a/classes/_opentelemetry_sdk-metrics.ConsoleMetricExporter.html +++ b/classes/_opentelemetry_sdk-metrics.ConsoleMetricExporter.html @@ -1,21 +1,21 @@ ConsoleMetricExporter | OpenTelemetry SDK

    This is an implementation of PushMetricExporter that prints metrics to the console. This class can be used for diagnostic purposes.

    NOTE: This PushMetricExporter is intended for diagnostics use only, output rendered to the console may change at any time.

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    _shutdown: boolean = false
    _temporalitySelector: AggregationTemporalitySelector

    Methods

    Constructors

    Properties

    _shutdown: boolean = false
    _temporalitySelector: AggregationTemporalitySelector

    Methods

    • Ensure that the export of any metrics the exporter has received is +

    Returns void

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-metrics.InMemoryMetricExporter.html b/classes/_opentelemetry_sdk-metrics.InMemoryMetricExporter.html index 2500ecf66..c8990a8ac 100644 --- a/classes/_opentelemetry_sdk-metrics.InMemoryMetricExporter.html +++ b/classes/_opentelemetry_sdk-metrics.InMemoryMetricExporter.html @@ -1,7 +1,7 @@ InMemoryMetricExporter | OpenTelemetry SDK

    In-memory Metrics Exporter is a Push Metric Exporter which accumulates metrics data in the local memory and allows to inspect it (useful for e.g. unit tests).

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    export @@ -10,13 +10,13 @@ allows to inspect it (useful for e.g. unit tests).

    reset selectAggregationTemporality shutdown -

    Constructors

    Properties

    _aggregationTemporality: AggregationTemporality
    _shutdown: boolean = false

    Methods

    • Ensure that the export of any metrics the exporter has received is +

    Constructors

    Properties

    _aggregationTemporality: AggregationTemporality
    _shutdown: boolean = false

    Methods

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-metrics.MeterProvider.html b/classes/_opentelemetry_sdk-metrics.MeterProvider.html index 1531380b1..dbdaf612f 100644 --- a/classes/_opentelemetry_sdk-metrics.MeterProvider.html +++ b/classes/_opentelemetry_sdk-metrics.MeterProvider.html @@ -1,12 +1,12 @@ MeterProvider | OpenTelemetry SDK

    This class implements the MeterProvider interface.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    • Notifies all registered MetricReaders to flush any buffered data.

      +

    Constructors

    Methods

    • Notifies all registered MetricReaders to flush any buffered data.

      Returns a promise which is resolved when all flushes are complete.

      -

      Parameters

      • Optionaloptions: CommonReaderOptions

      Returns Promise<void>

    • Shut down the MeterProvider and all registered +

      Parameters

      • Optionaloptions: CommonReaderOptions

      Returns Promise<void>

    • Shut down the MeterProvider and all registered MetricReaders.

      Returns a promise which is resolved when all flushes are complete.

      -

      Parameters

      • Optionaloptions: CommonReaderOptions

      Returns Promise<void>

    +

    Parameters

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-metrics.MetricReader.html b/classes/_opentelemetry_sdk-metrics.MetricReader.html index 99136863f..9a196ac38 100644 --- a/classes/_opentelemetry_sdk-metrics.MetricReader.html +++ b/classes/_opentelemetry_sdk-metrics.MetricReader.html @@ -1,6 +1,6 @@ MetricReader | OpenTelemetry SDK

    A registered reader of metrics that, when linked to a MetricProducer, offers global control over metrics.

    -

    Hierarchy (View Summary)

    Implements

    Constructors

    Hierarchy (View Summary)

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Flushes metrics read by this reader, the promise will reject after the optional timeout or resolve after completion.

      +

    Constructors

    Methods

    • Flushes metrics read by this reader, the promise will reject after the optional timeout or resolve after completion.

      NOTE: this operation MAY continue even after the promise rejects due to a timeout.

      Parameters

      • Optionaloptions: CommonReaderOptions

        options with timeout.

        -

      Returns Promise<void>

    • Protected

      Handle a force flush signal by the SDK.

      +

    Returns Promise<void>

    • Shuts down the metric reader, the promise will reject after the optional timeout or resolve after completion.

      NOTE: this operation MAY continue even after the promise rejects due to a timeout.

      Parameters

      • Optionaloptions: CommonReaderOptions

        options with timeout.

        -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-metrics.PeriodicExportingMetricReader.html b/classes/_opentelemetry_sdk-metrics.PeriodicExportingMetricReader.html index e370443a4..abce57b9d 100644 --- a/classes/_opentelemetry_sdk-metrics.PeriodicExportingMetricReader.html +++ b/classes/_opentelemetry_sdk-metrics.PeriodicExportingMetricReader.html @@ -1,6 +1,6 @@ PeriodicExportingMetricReader | OpenTelemetry SDK

    MetricReader which collects metrics based on a user-configurable time interval, and passes the metrics to the configured PushMetricExporter

    -

    Hierarchy (View Summary)

    Constructors

    Hierarchy (View Summary)

    Constructors

    Methods

    Constructors

    Methods

    • Flushes metrics read by this reader, the promise will reject after the optional timeout or resolve after completion.

      +

    Constructors

    Methods

    • Flushes metrics read by this reader, the promise will reject after the optional timeout or resolve after completion.

      NOTE: this operation MAY continue even after the promise rejects due to a timeout.

      Parameters

      • Optionaloptions: CommonReaderOptions

        options with timeout.

        -

      Returns Promise<void>

    • Protected

      Handle a force flush signal by the SDK.

      +

    Returns Promise<void>

    • Shuts down the metric reader, the promise will reject after the optional timeout or resolve after completion.

      NOTE: this operation MAY continue even after the promise rejects due to a timeout.

      Parameters

      • Optionaloptions: CommonReaderOptions

        options with timeout.

        -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-metrics.TimeoutError.html b/classes/_opentelemetry_sdk-metrics.TimeoutError.html index ca67da617..c769dde4f 100644 --- a/classes/_opentelemetry_sdk-metrics.TimeoutError.html +++ b/classes/_opentelemetry_sdk-metrics.TimeoutError.html @@ -1,5 +1,5 @@ TimeoutError | OpenTelemetry SDK

    Error that is thrown on timeouts.

    -

    Hierarchy

    • Error
      • TimeoutError

    Constructors

    Hierarchy

    • Error
      • TimeoutError

    Constructors

    Properties

    Methods

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    +

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    diff --git a/classes/_opentelemetry_sdk-node.NodeSDK.html b/classes/_opentelemetry_sdk-node.NodeSDK.html index 098db7875..6e4f40080 100644 --- a/classes/_opentelemetry_sdk-node.NodeSDK.html +++ b/classes/_opentelemetry_sdk-node.NodeSDK.html @@ -1,6 +1,6 @@ -NodeSDK | OpenTelemetry SDK

    Constructors

    constructor +NodeSDK | OpenTelemetry SDK

    Constructors

    Methods

    Constructors

    Methods

    +

    Parameters

    Returns NodeSDK

    Methods

    diff --git a/classes/_opentelemetry_sdk-trace-base.AlwaysOffSampler.html b/classes/_opentelemetry_sdk-trace-base.AlwaysOffSampler.html index 9a2c27c65..4fcb9d583 100644 --- a/classes/_opentelemetry_sdk-trace-base.AlwaysOffSampler.html +++ b/classes/_opentelemetry_sdk-trace-base.AlwaysOffSampler.html @@ -1,8 +1,8 @@ AlwaysOffSampler | OpenTelemetry SDK

    Sampler that samples no traces.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    +
    diff --git a/classes/_opentelemetry_sdk-trace-base.AlwaysOnSampler.html b/classes/_opentelemetry_sdk-trace-base.AlwaysOnSampler.html index e637560fb..1f1e8c09c 100644 --- a/classes/_opentelemetry_sdk-trace-base.AlwaysOnSampler.html +++ b/classes/_opentelemetry_sdk-trace-base.AlwaysOnSampler.html @@ -1,8 +1,8 @@ AlwaysOnSampler | OpenTelemetry SDK

    Sampler that samples all traces.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    +
    diff --git a/classes/_opentelemetry_sdk-trace-base.BasicTracerProvider.html b/classes/_opentelemetry_sdk-trace-base.BasicTracerProvider.html index 2117c6c33..891ec72ad 100644 --- a/classes/_opentelemetry_sdk-trace-base.BasicTracerProvider.html +++ b/classes/_opentelemetry_sdk-trace-base.BasicTracerProvider.html @@ -1,9 +1,9 @@ BasicTracerProvider | OpenTelemetry SDK

    This class represents a basic tracer provider which platform libraries can extend

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    • Returns a Tracer, creating one if one with the given name and version is +

    Constructors

    Methods

    • Returns a Tracer, creating one if one with the given name and version is not already created.

      This function may return different Tracer types (e.g. NoopTracerProvider vs. a functional tracer).

      @@ -11,4 +11,4 @@ NoopTracerProvider vs. a functional tracer).

    • Optionalversion: string

      The version of the tracer or instrumentation library.

    • Optionaloptions: { schemaUrl?: string }

      The options of the tracer or instrumentation library.

    Returns Tracer

    Tracer A Tracer with the given name and version

    -
    +
    diff --git a/classes/_opentelemetry_sdk-trace-base.BatchSpanProcessor.html b/classes/_opentelemetry_sdk-trace-base.BatchSpanProcessor.html index b277b1e4c..5d770aca7 100644 --- a/classes/_opentelemetry_sdk-trace-base.BatchSpanProcessor.html +++ b/classes/_opentelemetry_sdk-trace-base.BatchSpanProcessor.html @@ -1,15 +1,15 @@ -BatchSpanProcessor | OpenTelemetry SDK

    Hierarchy

    Constructors

    constructor +BatchSpanProcessor | OpenTelemetry SDK

    Hierarchy

    Constructors

    Methods

    • Forces to export all finished spans

      -

      Returns Promise<void>

    Constructors

    Methods

    • Forces to export all finished spans

      +

      Returns Promise<void>

    • Called when a Span is started, if the span.isRecording() +

    Returns void

    • Shuts down the processor. Called when SDK is shut down. This is an +

      Parameters

      Returns void

    • Shuts down the processor. Called when SDK is shut down. This is an opportunity for processor to do any cleanup required.

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-trace-base.ConsoleSpanExporter.html b/classes/_opentelemetry_sdk-trace-base.ConsoleSpanExporter.html index 867f53f8b..7b35b1a0f 100644 --- a/classes/_opentelemetry_sdk-trace-base.ConsoleSpanExporter.html +++ b/classes/_opentelemetry_sdk-trace-base.ConsoleSpanExporter.html @@ -1,11 +1,11 @@ ConsoleSpanExporter | OpenTelemetry SDK

    This is implementation of SpanExporter that prints spans to the console. This class can be used for diagnostic purposes.

    NOTE: This SpanExporter is intended for diagnostics use only, output rendered to the console may change at any time.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    +

    Parameters

    Returns void

    diff --git a/classes/_opentelemetry_sdk-trace-base.InMemorySpanExporter.html b/classes/_opentelemetry_sdk-trace-base.InMemorySpanExporter.html index 56c2e2293..9102d383c 100644 --- a/classes/_opentelemetry_sdk-trace-base.InMemorySpanExporter.html +++ b/classes/_opentelemetry_sdk-trace-base.InMemorySpanExporter.html @@ -1,7 +1,7 @@ InMemorySpanExporter | OpenTelemetry SDK

    This class can be used for testing purposes. It stores the exported spans in a list in memory that can be retrieved using the getFinishedSpans() method.

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    export forceFlush @@ -10,8 +10,8 @@ method.

    shutdown

    Constructors

    Properties

    _stopped: boolean = false

    Indicates if the exporter has been "shutdown." When false, exported spans will not be stored in-memory.

    -

    Methods

    Methods

    +
  • resultCallback: (result: core.ExportResult) => void
  • Returns void

    diff --git a/classes/_opentelemetry_sdk-trace-base.NoopSpanProcessor.html b/classes/_opentelemetry_sdk-trace-base.NoopSpanProcessor.html index 30f641015..45a8c14d0 100644 --- a/classes/_opentelemetry_sdk-trace-base.NoopSpanProcessor.html +++ b/classes/_opentelemetry_sdk-trace-base.NoopSpanProcessor.html @@ -1,16 +1,16 @@ NoopSpanProcessor | OpenTelemetry SDK

    No-op implementation of SpanProcessor

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    • Called when a Span is started, if the span.isRecording() +

    Returns void

    • Shuts down the processor. Called when SDK is shut down. This is an +

    • _context: Context

    Returns void

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-trace-base.ParentBasedSampler.html b/classes/_opentelemetry_sdk-trace-base.ParentBasedSampler.html index bba37780a..082b17415 100644 --- a/classes/_opentelemetry_sdk-trace-base.ParentBasedSampler.html +++ b/classes/_opentelemetry_sdk-trace-base.ParentBasedSampler.html @@ -1,9 +1,9 @@ ParentBasedSampler | OpenTelemetry SDK

    A composite sampler that either respects the parent span's sampling decision or delegates to delegateSampler for root spans.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Checks whether span needs to be created and tracked.

      +

    Constructors

    Methods

    • Checks whether span needs to be created and tracked.

      Parameters

      • context: Context

        Parent Context which may contain a span.

      • traceId: string

        of the span to be created. It can be different from the traceId in the SpanContext. Typically in situations when the @@ -14,5 +14,5 @@ span to be created starts a new trace.

      • links: Link[]

        Collection of links that will be associated with the Span to be created. Typically useful for batch operations.

      Returns SamplingResult

      a SamplingResult.

      -
    +
    diff --git a/classes/_opentelemetry_sdk-trace-base.RandomIdGenerator.html b/classes/_opentelemetry_sdk-trace-base.RandomIdGenerator.html index 54e0d46da..68704dc76 100644 --- a/classes/_opentelemetry_sdk-trace-base.RandomIdGenerator.html +++ b/classes/_opentelemetry_sdk-trace-base.RandomIdGenerator.html @@ -1,9 +1,9 @@ RandomIdGenerator | OpenTelemetry SDK

    IdGenerator provides an interface for generating Trace Id and Span Id

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    generateSpanId: () => string = ...

    Returns a random 8-byte span ID formatted/encoded as a 16 lowercase hex characters corresponding to 64 bits.

    -
    generateTraceId: () => string = ...

    Returns a random 16-byte trace ID formatted/encoded as a 32 lowercase hex +

    generateTraceId: () => string = ...

    Returns a random 16-byte trace ID formatted/encoded as a 32 lowercase hex characters corresponding to 128 bits.

    -
    +
    diff --git a/classes/_opentelemetry_sdk-trace-base.SimpleSpanProcessor.html b/classes/_opentelemetry_sdk-trace-base.SimpleSpanProcessor.html index d8d7017be..4ffd3d65f 100644 --- a/classes/_opentelemetry_sdk-trace-base.SimpleSpanProcessor.html +++ b/classes/_opentelemetry_sdk-trace-base.SimpleSpanProcessor.html @@ -2,18 +2,18 @@ to ReadableSpan and passes it to the configured exporter.

    Only spans that are sampled are converted.

    NOTE: This SpanProcessor exports every ended span individually instead of batching spans together, which causes significant performance overhead with most exporters. For production use, please consider using the BatchSpanProcessor instead.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Called when a Span is started, if the span.isRecording() +

    Returns void

    • Shuts down the processor. Called when SDK is shut down. This is an +

    • _parentContext: Context

    Returns void

    +

    Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-trace-base.TraceIdRatioBasedSampler.html b/classes/_opentelemetry_sdk-trace-base.TraceIdRatioBasedSampler.html index 077b1d8fe..5f09a8134 100644 --- a/classes/_opentelemetry_sdk-trace-base.TraceIdRatioBasedSampler.html +++ b/classes/_opentelemetry_sdk-trace-base.TraceIdRatioBasedSampler.html @@ -1,12 +1,12 @@ TraceIdRatioBasedSampler | OpenTelemetry SDK

    Sampler that samples a given fraction of traces based of trace id deterministically.

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Checks whether span needs to be created and tracked.

      +

    Constructors

    Methods

    +
    diff --git a/classes/_opentelemetry_sdk-trace-node.NodeTracerProvider.html b/classes/_opentelemetry_sdk-trace-node.NodeTracerProvider.html index 48ba0ac2b..68257603d 100644 --- a/classes/_opentelemetry_sdk-trace-node.NodeTracerProvider.html +++ b/classes/_opentelemetry_sdk-trace-node.NodeTracerProvider.html @@ -2,12 +2,12 @@ Undefined values may be replaced with defaults, and null values will be skipped.

    Configuration object for SDK registration

    -

    Hierarchy (View Summary)

    Constructors

    Hierarchy (View Summary)

    Constructors

    Methods

    • Returns Promise<void>

    • Returns a Tracer, creating one if one with the given name and version is +

    Constructors

    Methods

    • Returns Promise<void>

    • Returns a Tracer, creating one if one with the given name and version is not already created.

      This function may return different Tracer types (e.g. NoopTracerProvider vs. a functional tracer).

      @@ -19,4 +19,4 @@ NoopTracerProvider vs. a functional tracer).

      Undefined values may be replaced with defaults, and null values will be skipped.

      Parameters

      Returns void

    • Returns Promise<void>

    +

    Returns void

    • Returns Promise<void>

    diff --git a/classes/_opentelemetry_sdk-trace-web.StackContextManager.html b/classes/_opentelemetry_sdk-trace-web.StackContextManager.html index 355da4786..9671a22be 100644 --- a/classes/_opentelemetry_sdk-trace-web.StackContextManager.html +++ b/classes/_opentelemetry_sdk-trace-web.StackContextManager.html @@ -1,6 +1,6 @@ StackContextManager | OpenTelemetry SDK

    Stack Context Manager for managing the state in web it doesn't fully support the async calls though

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    active bind @@ -8,16 +8,16 @@ it doesn't fully support the async calls though

    enable with

    Constructors

    Properties

    _currentContext: Context = ROOT_CONTEXT

    Keeps the reference to current context

    -

    Methods

    Methods

    • Binds a the certain context or the active one to the target function and then returns the target

      Type Parameters

      • T

      Parameters

      • context: Context

        A context (span) to be bind to target

      • target: T

        a function or event emitter. When target or one of its callbacks is called, the provided context will be used as the active context for the duration of the call.

        -

      Returns T

    • Calls the callback function [fn] with the provided [context]. If [context] is undefined then it will use the window. +

    Returns T

    • Calls the callback function [fn] with the provided [context]. If [context] is undefined then it will use the window. The context will be set as active

      Type Parameters

      • A extends unknown[]
      • F extends (...args: A) => ReturnType<F>

      Parameters

      • context: null | Context
      • fn: F

        Callback function

      • OptionalthisArg: ThisParameterType<F>

        optional receiver to be used for calling fn

      • ...args: A

        optional arguments forwarded to fn

        -

      Returns ReturnType<F>

    +

    Returns ReturnType<F>

    diff --git a/classes/_opentelemetry_sdk-trace-web.WebTracerProvider.html b/classes/_opentelemetry_sdk-trace-web.WebTracerProvider.html index ba089cb56..47decec8c 100644 --- a/classes/_opentelemetry_sdk-trace-web.WebTracerProvider.html +++ b/classes/_opentelemetry_sdk-trace-web.WebTracerProvider.html @@ -1,12 +1,12 @@ WebTracerProvider | OpenTelemetry SDK

    This class represents a web tracer with StackContextManager

    -

    Hierarchy (View Summary)

    Constructors

    Hierarchy (View Summary)

    Constructors

    Methods

    • Returns Promise<void>

    • Returns a Tracer, creating one if one with the given name and version is +

    Returns WebTracerProvider

    Methods

    • Returns Promise<void>

    • Returns a Tracer, creating one if one with the given name and version is not already created.

      This function may return different Tracer types (e.g. NoopTracerProvider vs. a functional tracer).

      @@ -18,4 +18,4 @@ NoopTracerProvider vs. a functional tracer).

      Undefined values may be replaced with defaults, and null values will be skipped.

      Parameters

      Returns void

    • Returns Promise<void>

    +

    Returns void

    • Returns Promise<void>

    diff --git a/classes/_opentelemetry_shim-opencensus..OpenCensusMetricProducer.html b/classes/_opentelemetry_shim-opencensus..OpenCensusMetricProducer.html index 81c43769e..9a606c3ae 100644 --- a/classes/_opentelemetry_shim-opencensus..OpenCensusMetricProducer.html +++ b/classes/_opentelemetry_shim-opencensus..OpenCensusMetricProducer.html @@ -4,8 +4,8 @@ result:

    const reader = new PeriodicExportingMetricReader({
    metricProducers: [new OpenCensusMetricProducer()],
    exporter: exporter,
    });
    const meterProvider = new MeterProvider({
    readers: [reader],
    });
    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Collects the metrics from the SDK. If there are asynchronous Instruments +

    Constructors

    Methods

    +

    Returns Promise<metrics.CollectionResult>

    diff --git a/classes/_opentelemetry_shim-opencensus..ShimTracer.html b/classes/_opentelemetry_shim-opencensus..ShimTracer.html index 74d0246e8..917a0332d 100644 --- a/classes/_opentelemetry_shim-opencensus..ShimTracer.html +++ b/classes/_opentelemetry_shim-opencensus..ShimTracer.html @@ -1,4 +1,4 @@ -ShimTracer | OpenTelemetry SDK

    Implements

    • Tracer

    Constructors

    constructor +ShimTracer | OpenTelemetry SDK

    Implements

    • Tracer

    Constructors

    Properties

    active: boolean = false

    Get the active status from tracer instance

    -
    activeTraceParams: TraceParams = {}

    A configuration object for trace parameters

    -
    eventListeners: SpanEventListener[] = []

    Get the eventListeners from tracer instance

    -
    logger: Logger = diag

    A configuration for starting the tracer

    -
    propagation: Propagation = shimPropagation

    A propagation instance

    -
    sampler: Sampler = ...

    Noop implementations

    -

    Accessors

    • get currentRootSpan(): Span

      Gets the current root span.

      -

      Returns Span

    Methods

    • Clear the currentRootSpan from tracer instance

      -

      Returns void

    • Happens when a span is ended

      -

      Returns void

    • Happens when a span is started

      -

      Returns void

    • Register a OnEndSpanEventListener on the tracer instance

      -

      Returns void

    • Sets the current root span.

      -

      Returns void

    • Start a tracer instance

      +

    Constructors

    Properties

    active: boolean = false

    Get the active status from tracer instance

    +
    activeTraceParams: TraceParams = {}

    A configuration object for trace parameters

    +
    eventListeners: SpanEventListener[] = []

    Get the eventListeners from tracer instance

    +
    logger: Logger = diag

    A configuration for starting the tracer

    +
    propagation: Propagation = shimPropagation

    A propagation instance

    +
    sampler: Sampler = ...

    Noop implementations

    +

    Accessors

    • get currentRootSpan(): Span

      Gets the current root span.

      +

      Returns Span

    Methods

    • Clear the currentRootSpan from tracer instance

      +

      Returns void

    • Happens when a span is ended

      +

      Returns void

    • Happens when a span is started

      +

      Returns void

    • Register a OnEndSpanEventListener on the tracer instance

      +

      Returns void

    • Sets the current root span.

      +

      Returns void

    • Start a tracer instance

      Parameters

      • config: TracerConfig

        Configuration for tracer instace

      Returns this

      A tracer instance started

      -
    • Start a new Span instance to the currentRootSpan

      +
    • Start a new Span instance to the currentRootSpan

      Parameters

      • Optionaloptions: SpanOptions

        A TraceOptions object to start a root span.

      Returns Span

      The new Span instance started

      -
    • Starts a root span.

      +
    • Starts a root span.

      Type Parameters

      • T

      Parameters

      • options: TraceOptions

        A TraceOptions object to start a root span.

      • fn: (root: Span) => T

        A callback function to run after starting a root span.

        -

      Returns T

    • Noop implementations

      -

      Returns this

    • Unregisters an end span event listener.

      -

      Returns void

    • Binds the trace context to the given function. +

    Returns T

    • Noop implementations

      +

      Returns this

    • Unregisters an end span event listener.

      +

      Returns void

    • Binds the trace context to the given function. This is necessary in order to create child spans correctly in functions that are called asynchronously (for example, in a network response handler).

      Type Parameters

      • T

      Parameters

      • fn: Func<T>

        A function to which to bind the trace context.

        -

      Returns Func<T>

    • Binds the trace context to the given event emitter. +

    Returns Func<T>

    • Binds the trace context to the given event emitter. This is necessary in order to create child spans correctly in event handlers.

      Parameters

      • emitter: EventEmitter

        An event emitter whose handlers should have the trace context binded to them.

        -

      Returns void

    +

    Returns void

    diff --git a/classes/_opentelemetry_shim-opentracing.TracerShim.html b/classes/_opentelemetry_shim-opentracing.TracerShim.html index d1b2a08fe..594b25d4e 100644 --- a/classes/_opentelemetry_shim-opentracing.TracerShim.html +++ b/classes/_opentelemetry_shim-opentracing.TracerShim.html @@ -1,13 +1,13 @@ TracerShim | OpenTelemetry SDK

    TracerShim wraps a api.Tracer and implements the OpenTracing tracer API.

    -

    Hierarchy

    • Tracer
      • TracerShim

    Constructors

    Hierarchy

    • Tracer
      • TracerShim

    Constructors

    Methods

    • Parameters

      • name: string
      • fields: SpanOptions

      Returns Span

    • Returns a SpanContext instance extracted from carrier in the given +

    Constructors

    Methods

    • Parameters

      • name: string
      • fields: SpanOptions

      Returns Span

    • Returns a SpanContext instance extracted from carrier in the given format.

      OpenTracing defines a common set of format values (see FORMAT_TEXT_MAP, FORMAT_HTTP_HEADERS, and FORMAT_BINARY), and each has @@ -69,4 +69,4 @@ var child = Tracer.startSpan('async-cache-write', {

    Returns Span

    • a new Span object.
    -
    +
    diff --git a/enums/_opentelemetry_api-logs.SeverityNumber.html b/enums/_opentelemetry_api-logs.SeverityNumber.html index 015c768ab..bb0984b2c 100644 --- a/enums/_opentelemetry_api-logs.SeverityNumber.html +++ b/enums/_opentelemetry_api-logs.SeverityNumber.html @@ -1,4 +1,4 @@ -SeverityNumber | OpenTelemetry SDK

    Enumeration Members

    DEBUG +SeverityNumber | OpenTelemetry SDK

    Enumeration Members

    DEBUG DEBUG2 DEBUG3 DEBUG4 @@ -23,4 +23,4 @@ WARN2 WARN3 WARN4 -

    Enumeration Members

    DEBUG: 5
    DEBUG2: 6
    DEBUG3: 7
    DEBUG4: 8
    ERROR: 17
    ERROR2: 18
    ERROR3: 19
    ERROR4: 20
    FATAL: 21
    FATAL2: 22
    FATAL3: 23
    FATAL4: 24
    INFO: 9
    INFO2: 10
    INFO3: 11
    INFO4: 12
    TRACE: 1
    TRACE2: 2
    TRACE3: 3
    TRACE4: 4
    UNSPECIFIED: 0
    WARN: 13
    WARN2: 14
    WARN3: 15
    WARN4: 16
    +

    Enumeration Members

    DEBUG: 5
    DEBUG2: 6
    DEBUG3: 7
    DEBUG4: 8
    ERROR: 17
    ERROR2: 18
    ERROR3: 19
    ERROR4: 20
    FATAL: 21
    FATAL2: 22
    FATAL3: 23
    FATAL4: 24
    INFO: 9
    INFO2: 10
    INFO3: 11
    INFO4: 12
    TRACE: 1
    TRACE2: 2
    TRACE3: 3
    TRACE4: 4
    UNSPECIFIED: 0
    WARN: 13
    WARN2: 14
    WARN3: 15
    WARN4: 16
    diff --git a/enums/_opentelemetry_api._opentelemetry_api.DiagLogLevel.html b/enums/_opentelemetry_api._opentelemetry_api.DiagLogLevel.html index f044d5f79..db2626920 100644 --- a/enums/_opentelemetry_api._opentelemetry_api.DiagLogLevel.html +++ b/enums/_opentelemetry_api._opentelemetry_api.DiagLogLevel.html @@ -1,7 +1,7 @@ DiagLogLevel | OpenTelemetry SDK

    Defines the available internal logging levels for the diagnostic logger, the numeric values of the levels are defined to match the original values from the initial LogLevel to avoid compatibility/migration issues for any implementation that assume the numeric ordering.

    -

    Enumeration Members

    ALL +

    Enumeration Members

    ALL DEBUG ERROR INFO @@ -9,11 +9,11 @@ compatibility/migration issues for any implementation that assume the numeric or VERBOSE WARN

    Enumeration Members

    ALL: 9999

    Used to set the logging level to include all logging

    -
    DEBUG: 70

    General debug log message

    -
    ERROR: 30

    Identifies an error scenario

    -
    INFO: 60

    General informational log message

    -
    NONE: 0

    Diagnostic Logging level setting to disable all logging (except and forced logs)

    -
    VERBOSE: 80

    Detailed trace level logging should only be used for development, should only be set +

    DEBUG: 70

    General debug log message

    +
    ERROR: 30

    Identifies an error scenario

    +
    INFO: 60

    General informational log message

    +
    NONE: 0

    Diagnostic Logging level setting to disable all logging (except and forced logs)

    +
    VERBOSE: 80

    Detailed trace level logging should only be used for development, should only be set in a development environment.

    -
    WARN: 50

    Identifies a warning scenario

    -
    +
    WARN: 50

    Identifies a warning scenario

    +
    diff --git a/enums/_opentelemetry_api._opentelemetry_api.SamplingDecision.html b/enums/_opentelemetry_api._opentelemetry_api.SamplingDecision.html index f7bd307b4..e09404475 100644 --- a/enums/_opentelemetry_api._opentelemetry_api.SamplingDecision.html +++ b/enums/_opentelemetry_api._opentelemetry_api.SamplingDecision.html @@ -2,13 +2,13 @@ A sampling decision that determines how a Span will be recorded and collected.

    1.0.0

    -

    Enumeration Members

    Enumeration Members

    NOT_RECORD: 0

    Span.isRecording() === false, span will not be recorded and all events and attributes will be dropped.

    -
    RECORD: 1

    Span.isRecording() === true, but Sampled flag in TraceFlags +

    RECORD: 1

    Span.isRecording() === true, but Sampled flag in TraceFlags MUST NOT be set.

    -
    RECORD_AND_SAMPLED: 2

    Span.isRecording() === true AND Sampled flag in TraceFlags +

    RECORD_AND_SAMPLED: 2

    Span.isRecording() === true AND Sampled flag in TraceFlags MUST be set.

    -
    +
    diff --git a/enums/_opentelemetry_api._opentelemetry_api.SpanKind.html b/enums/_opentelemetry_api._opentelemetry_api.SpanKind.html index aa8830ecb..d8b516a63 100644 --- a/enums/_opentelemetry_api._opentelemetry_api.SpanKind.html +++ b/enums/_opentelemetry_api._opentelemetry_api.SpanKind.html @@ -1,18 +1,18 @@ SpanKind | OpenTelemetry SDK

    1.0.0

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    CLIENT: 2

    Indicates that the span covers the client-side wrapper around an RPC or other remote request.

    -
    CONSUMER: 4

    Indicates that the span describes consumer receiving a message from a +

    CONSUMER: 4

    Indicates that the span describes consumer receiving a message from a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.

    -
    INTERNAL: 0

    Default value. Indicates that the span is used internally.

    -
    PRODUCER: 3

    Indicates that the span describes producer sending a message to a +

    INTERNAL: 0

    Default value. Indicates that the span is used internally.

    +
    PRODUCER: 3

    Indicates that the span describes producer sending a message to a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.

    -
    SERVER: 1

    Indicates that the span covers server-side handling of an RPC or other +

    SERVER: 1

    Indicates that the span covers server-side handling of an RPC or other remote request.

    -
    +
    diff --git a/enums/_opentelemetry_api._opentelemetry_api.SpanStatusCode.html b/enums/_opentelemetry_api._opentelemetry_api.SpanStatusCode.html index abffc573a..72d8957de 100644 --- a/enums/_opentelemetry_api._opentelemetry_api.SpanStatusCode.html +++ b/enums/_opentelemetry_api._opentelemetry_api.SpanStatusCode.html @@ -1,10 +1,10 @@ SpanStatusCode | OpenTelemetry SDK

    An enumeration of status codes.

    1.0.0

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    ERROR: 2

    The operation contains an error.

    -
    OK: 1

    The operation has been validated by an Application developer or +

    OK: 1

    The operation has been validated by an Application developer or Operator to have completed successfully.

    -
    UNSET: 0

    The default status.

    -
    +
    UNSET: 0

    The default status.

    +
    diff --git a/enums/_opentelemetry_api._opentelemetry_api.TraceFlags.html b/enums/_opentelemetry_api._opentelemetry_api.TraceFlags.html index d98cb7da7..19783593c 100644 --- a/enums/_opentelemetry_api._opentelemetry_api.TraceFlags.html +++ b/enums/_opentelemetry_api._opentelemetry_api.TraceFlags.html @@ -1,6 +1,6 @@ TraceFlags | OpenTelemetry SDK

    1.0.0

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    NONE: 0

    Represents no flag set.

    -
    SAMPLED: 1

    Bit to represent whether trace is sampled in trace flags.

    -
    +
    SAMPLED: 1

    Bit to represent whether trace is sampled in trace flags.

    +
    diff --git a/enums/_opentelemetry_api._opentelemetry_api.ValueType.html b/enums/_opentelemetry_api._opentelemetry_api.ValueType.html index f69948ba7..908956e42 100644 --- a/enums/_opentelemetry_api._opentelemetry_api.ValueType.html +++ b/enums/_opentelemetry_api._opentelemetry_api.ValueType.html @@ -1,5 +1,5 @@ ValueType | OpenTelemetry SDK

    The Type of value. It describes how the data is reported.

    1.3.0

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    DOUBLE: 1
    INT: 0
    +

    Enumeration Members

    DOUBLE: 1
    INT: 0
    diff --git a/enums/_opentelemetry_core.ExportResultCode.html b/enums/_opentelemetry_core.ExportResultCode.html index fb2cfd4da..df3193116 100644 --- a/enums/_opentelemetry_core.ExportResultCode.html +++ b/enums/_opentelemetry_core.ExportResultCode.html @@ -1,3 +1,3 @@ -ExportResultCode | OpenTelemetry SDK

    Enumeration Members

    FAILED +ExportResultCode | OpenTelemetry SDK
    +

    Enumeration Members

    FAILED: 1
    SUCCESS: 0
    diff --git a/enums/_opentelemetry_core.RPCType.html b/enums/_opentelemetry_core.RPCType.html index 95418e9ad..d80a0241a 100644 --- a/enums/_opentelemetry_core.RPCType.html +++ b/enums/_opentelemetry_core.RPCType.html @@ -1,2 +1,2 @@ -RPCType | OpenTelemetry SDK
    +RPCType | OpenTelemetry SDK
    diff --git a/enums/_opentelemetry_exporter-metrics-otlp-http.AggregationTemporalityPreference.html b/enums/_opentelemetry_exporter-metrics-otlp-http.AggregationTemporalityPreference.html index 0e1c117e2..94cb9d66d 100644 --- a/enums/_opentelemetry_exporter-metrics-otlp-http.AggregationTemporalityPreference.html +++ b/enums/_opentelemetry_exporter-metrics-otlp-http.AggregationTemporalityPreference.html @@ -1,4 +1,4 @@ -AggregationTemporalityPreference | OpenTelemetry SDK

    Enumeration Members

    CUMULATIVE +AggregationTemporalityPreference | OpenTelemetry SDK
    +

    Enumeration Members

    CUMULATIVE: 1
    DELTA: 0
    LOWMEMORY: 2
    diff --git a/enums/_opentelemetry_instrumentation.SemconvStability.html b/enums/_opentelemetry_instrumentation.SemconvStability.html index 7c8e8bd95..aa256a2dd 100644 --- a/enums/_opentelemetry_instrumentation.SemconvStability.html +++ b/enums/_opentelemetry_instrumentation.SemconvStability.html @@ -1,7 +1,7 @@ -SemconvStability | OpenTelemetry SDK

    Enumeration Members

    DUPLICATE +SemconvStability | OpenTelemetry SDK

    Enumeration Members

    Enumeration Members

    DUPLICATE: 3

    Emit both stable and old semantic conventions.

    -
    OLD: 2

    Emit only old semantic conventions.

    -
    STABLE: 1

    Emit only stable semantic conventions.

    -
    +
    OLD: 2

    Emit only old semantic conventions.

    +
    STABLE: 1

    Emit only stable semantic conventions.

    +
    diff --git a/enums/_opentelemetry_propagator-b3.B3InjectEncoding.html b/enums/_opentelemetry_propagator-b3.B3InjectEncoding.html index 32f3d2148..56fee1779 100644 --- a/enums/_opentelemetry_propagator-b3.B3InjectEncoding.html +++ b/enums/_opentelemetry_propagator-b3.B3InjectEncoding.html @@ -1,4 +1,4 @@ B3InjectEncoding | OpenTelemetry SDK

    Enumeration of B3 inject encodings

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    MULTI_HEADER: 1
    SINGLE_HEADER: 0
    +

    Enumeration Members

    MULTI_HEADER: 1
    SINGLE_HEADER: 0
    diff --git a/enums/_opentelemetry_sampler-jaeger-remote.StrategyType.html b/enums/_opentelemetry_sampler-jaeger-remote.StrategyType.html index 7a84ce952..e1b5aaec3 100644 --- a/enums/_opentelemetry_sampler-jaeger-remote.StrategyType.html +++ b/enums/_opentelemetry_sampler-jaeger-remote.StrategyType.html @@ -1,10 +1,10 @@ StrategyType | OpenTelemetry SDK

    Enum representing different types of sampling strategies.

    -

    Enumeration Members

    Enumeration Members

    CONST: "CONST"

    Constant sampling strategy

    -
    PROBABILISTIC: "PROBABILISTIC"

    Probabilistic sampling strategy

    -
    RATELIMITING: "RATELIMITING"

    Rate-limiting sampling strategy

    -
    REMOTE: "REMOTE"

    Remote sampling strategy

    -
    +
    PROBABILISTIC: "PROBABILISTIC"

    Probabilistic sampling strategy

    +
    RATELIMITING: "RATELIMITING"

    Rate-limiting sampling strategy

    +
    REMOTE: "REMOTE"

    Remote sampling strategy

    +
    diff --git a/enums/_opentelemetry_sdk-metrics.AggregationTemporality.html b/enums/_opentelemetry_sdk-metrics.AggregationTemporality.html index d01977962..b4467f90f 100644 --- a/enums/_opentelemetry_sdk-metrics.AggregationTemporality.html +++ b/enums/_opentelemetry_sdk-metrics.AggregationTemporality.html @@ -1,4 +1,4 @@ AggregationTemporality | OpenTelemetry SDK

    AggregationTemporality indicates the way additive quantities are expressed.

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    CUMULATIVE: 1
    DELTA: 0
    +

    Enumeration Members

    CUMULATIVE: 1
    DELTA: 0
    diff --git a/enums/_opentelemetry_sdk-metrics.AggregationType.html b/enums/_opentelemetry_sdk-metrics.AggregationType.html index dfbbcc587..f09a154ed 100644 --- a/enums/_opentelemetry_sdk-metrics.AggregationType.html +++ b/enums/_opentelemetry_sdk-metrics.AggregationType.html @@ -1,7 +1,7 @@ -AggregationType | OpenTelemetry SDK

    Enumeration Members

    DEFAULT +AggregationType | OpenTelemetry SDK
    +

    Enumeration Members

    DEFAULT: 0
    DROP: 1
    EXPLICIT_BUCKET_HISTOGRAM: 4
    EXPONENTIAL_HISTOGRAM: 5
    LAST_VALUE: 3
    SUM: 2
    diff --git a/enums/_opentelemetry_sdk-metrics.DataPointType.html b/enums/_opentelemetry_sdk-metrics.DataPointType.html index 7dcec5e93..ee6cb2e43 100644 --- a/enums/_opentelemetry_sdk-metrics.DataPointType.html +++ b/enums/_opentelemetry_sdk-metrics.DataPointType.html @@ -1,5 +1,5 @@ DataPointType | OpenTelemetry SDK

    The aggregated point data type.

    -

    Enumeration Members

    Enumeration Members

    EXPONENTIAL_HISTOGRAM GAUGE HISTOGRAM SUM @@ -7,10 +7,10 @@ collected values where bucket boundaries are automatically calculated using an exponential function, and statistics such as min, max, count, and sum of all collected values.

    -
    GAUGE: 2

    A gauge metric data point has only a single numeric value.

    -
    HISTOGRAM: 0

    A histogram data point contains a histogram statistics of collected +

    GAUGE: 2

    A gauge metric data point has only a single numeric value.

    +
    HISTOGRAM: 0

    A histogram data point contains a histogram statistics of collected values with a list of explicit bucket boundaries and statistics such as min, max, count, and sum of all collected values.

    -
    SUM: 3

    A sum metric data point has a single numeric value and a +

    SUM: 3

    A sum metric data point has a single numeric value and a monotonicity-indicator.

    -
    +
    diff --git a/enums/_opentelemetry_sdk-metrics.InstrumentType.html b/enums/_opentelemetry_sdk-metrics.InstrumentType.html index 495d30c15..7fe081b5a 100644 --- a/enums/_opentelemetry_sdk-metrics.InstrumentType.html +++ b/enums/_opentelemetry_sdk-metrics.InstrumentType.html @@ -1,9 +1,9 @@ InstrumentType | OpenTelemetry SDK

    Supported types of metric instruments.

    -

    Enumeration Members

    Enumeration Members

    COUNTER: "COUNTER"
    GAUGE: "GAUGE"
    HISTOGRAM: "HISTOGRAM"
    OBSERVABLE_COUNTER: "OBSERVABLE_COUNTER"
    OBSERVABLE_GAUGE: "OBSERVABLE_GAUGE"
    OBSERVABLE_UP_DOWN_COUNTER: "OBSERVABLE_UP_DOWN_COUNTER"
    UP_DOWN_COUNTER: "UP_DOWN_COUNTER"
    +

    Enumeration Members

    COUNTER: "COUNTER"
    GAUGE: "GAUGE"
    HISTOGRAM: "HISTOGRAM"
    OBSERVABLE_COUNTER: "OBSERVABLE_COUNTER"
    OBSERVABLE_GAUGE: "OBSERVABLE_GAUGE"
    OBSERVABLE_UP_DOWN_COUNTER: "OBSERVABLE_UP_DOWN_COUNTER"
    UP_DOWN_COUNTER: "UP_DOWN_COUNTER"
    diff --git a/enums/_opentelemetry_sdk-trace-base.SamplingDecision.html b/enums/_opentelemetry_sdk-trace-base.SamplingDecision.html index b6a5e8c3b..9fd0e6753 100644 --- a/enums/_opentelemetry_sdk-trace-base.SamplingDecision.html +++ b/enums/_opentelemetry_sdk-trace-base.SamplingDecision.html @@ -1,12 +1,12 @@ SamplingDecision | OpenTelemetry SDK

    A sampling decision that determines how a Span will be recorded and collected.

    -

    Enumeration Members

    Enumeration Members

    NOT_RECORD: 0

    Span.isRecording() === false, span will not be recorded and all events and attributes will be dropped.

    -
    RECORD: 1

    Span.isRecording() === true, but Sampled flag in TraceFlags +

    RECORD: 1

    Span.isRecording() === true, but Sampled flag in TraceFlags MUST NOT be set.

    -
    RECORD_AND_SAMPLED: 2

    Span.isRecording() === true AND Sampled flag in TraceFlags +

    RECORD_AND_SAMPLED: 2

    Span.isRecording() === true AND Sampled flag in TraceFlags MUST be set.

    -
    +
    diff --git a/enums/_opentelemetry_sdk-trace-web.PerformanceTimingNames.html b/enums/_opentelemetry_sdk-trace-web.PerformanceTimingNames.html index a05f4b0c2..daf40d6e4 100644 --- a/enums/_opentelemetry_sdk-trace-web.PerformanceTimingNames.html +++ b/enums/_opentelemetry_sdk-trace-web.PerformanceTimingNames.html @@ -1,4 +1,4 @@ -PerformanceTimingNames | OpenTelemetry SDK

    Enumeration Members

    CONNECT_END +PerformanceTimingNames | OpenTelemetry SDK

    Enumeration Members

    CONNECT_END: "connectEnd"
    CONNECT_START: "connectStart"
    DECODED_BODY_SIZE: "decodedBodySize"
    DOM_COMPLETE: "domComplete"
    DOM_CONTENT_LOADED_EVENT_END: "domContentLoadedEventEnd"
    DOM_CONTENT_LOADED_EVENT_START: "domContentLoadedEventStart"
    DOM_INTERACTIVE: "domInteractive"
    DOMAIN_LOOKUP_END: "domainLookupEnd"
    DOMAIN_LOOKUP_START: "domainLookupStart"
    ENCODED_BODY_SIZE: "encodedBodySize"
    FETCH_START: "fetchStart"
    LOAD_EVENT_END: "loadEventEnd"
    LOAD_EVENT_START: "loadEventStart"
    NAVIGATION_START: "navigationStart"
    REDIRECT_END: "redirectEnd"
    REDIRECT_START: "redirectStart"
    REQUEST_START: "requestStart"
    RESPONSE_END: "responseEnd"
    RESPONSE_START: "responseStart"
    SECURE_CONNECTION_START: "secureConnectionStart"
    START_TIME: "startTime"
    UNLOAD_EVENT_END: "unloadEventEnd"
    UNLOAD_EVENT_START: "unloadEventStart"
    +

    Enumeration Members

    CONNECT_END: "connectEnd"
    CONNECT_START: "connectStart"
    DECODED_BODY_SIZE: "decodedBodySize"
    DOM_COMPLETE: "domComplete"
    DOM_CONTENT_LOADED_EVENT_END: "domContentLoadedEventEnd"
    DOM_CONTENT_LOADED_EVENT_START: "domContentLoadedEventStart"
    DOM_INTERACTIVE: "domInteractive"
    DOMAIN_LOOKUP_END: "domainLookupEnd"
    DOMAIN_LOOKUP_START: "domainLookupStart"
    ENCODED_BODY_SIZE: "encodedBodySize"
    FETCH_START: "fetchStart"
    LOAD_EVENT_END: "loadEventEnd"
    LOAD_EVENT_START: "loadEventStart"
    NAVIGATION_START: "navigationStart"
    REDIRECT_END: "redirectEnd"
    REDIRECT_START: "redirectStart"
    REQUEST_START: "requestStart"
    RESPONSE_END: "responseEnd"
    RESPONSE_START: "responseStart"
    SECURE_CONNECTION_START: "secureConnectionStart"
    START_TIME: "startTime"
    UNLOAD_EVENT_END: "unloadEventEnd"
    UNLOAD_EVENT_START: "unloadEventStart"
    diff --git a/functions/_opentelemetry_api._opentelemetry_api.baggageEntryMetadataFromString.html b/functions/_opentelemetry_api._opentelemetry_api.baggageEntryMetadataFromString.html index 3fa32c504..e4b6086c6 100644 --- a/functions/_opentelemetry_api._opentelemetry_api.baggageEntryMetadataFromString.html +++ b/functions/_opentelemetry_api._opentelemetry_api.baggageEntryMetadataFromString.html @@ -1,4 +1,4 @@ baggageEntryMetadataFromString | OpenTelemetry SDK
    • Create a serializable BaggageEntryMetadata object from a string.

      Parameters

      • str: string

        string metadata. Format is currently not defined by the spec and has no special meaning.

      Returns BaggageEntryMetadata

      1.0.0

      -
    +
    diff --git a/functions/_opentelemetry_api._opentelemetry_api.createContextKey.html b/functions/_opentelemetry_api._opentelemetry_api.createContextKey.html index fde3a75f0..26f70bea0 100644 --- a/functions/_opentelemetry_api._opentelemetry_api.createContextKey.html +++ b/functions/_opentelemetry_api._opentelemetry_api.createContextKey.html @@ -1,3 +1,3 @@ createContextKey | OpenTelemetry SDK
    • Get a key to uniquely identify a context value

      Parameters

      • description: string

      Returns symbol

      1.0.0

      -
    +
    diff --git a/functions/_opentelemetry_api._opentelemetry_api.createNoopMeter.html b/functions/_opentelemetry_api._opentelemetry_api.createNoopMeter.html index 850cf2209..d8f4d1272 100644 --- a/functions/_opentelemetry_api._opentelemetry_api.createNoopMeter.html +++ b/functions/_opentelemetry_api._opentelemetry_api.createNoopMeter.html @@ -1,3 +1,3 @@ createNoopMeter | OpenTelemetry SDK
    +
    diff --git a/functions/_opentelemetry_api._opentelemetry_api.createTraceState.html b/functions/_opentelemetry_api._opentelemetry_api.createTraceState.html index f865b4b0d..40278d457 100644 --- a/functions/_opentelemetry_api._opentelemetry_api.createTraceState.html +++ b/functions/_opentelemetry_api._opentelemetry_api.createTraceState.html @@ -1,2 +1,2 @@ createTraceState | OpenTelemetry SDK
    +
    diff --git a/functions/_opentelemetry_api._opentelemetry_api.isSpanContextValid.html b/functions/_opentelemetry_api._opentelemetry_api.isSpanContextValid.html index 2e6ae35af..d12eaac45 100644 --- a/functions/_opentelemetry_api._opentelemetry_api.isSpanContextValid.html +++ b/functions/_opentelemetry_api._opentelemetry_api.isSpanContextValid.html @@ -1,4 +1,4 @@ isSpanContextValid | OpenTelemetry SDK
    +
    diff --git a/functions/_opentelemetry_api._opentelemetry_api.isValidSpanId.html b/functions/_opentelemetry_api._opentelemetry_api.isValidSpanId.html index 402fc7e8e..a5d65f76e 100644 --- a/functions/_opentelemetry_api._opentelemetry_api.isValidSpanId.html +++ b/functions/_opentelemetry_api._opentelemetry_api.isValidSpanId.html @@ -1,2 +1,2 @@ isValidSpanId | OpenTelemetry SDK
    +
    diff --git a/functions/_opentelemetry_api._opentelemetry_api.isValidTraceId.html b/functions/_opentelemetry_api._opentelemetry_api.isValidTraceId.html index 6633d4204..ba853e2fa 100644 --- a/functions/_opentelemetry_api._opentelemetry_api.isValidTraceId.html +++ b/functions/_opentelemetry_api._opentelemetry_api.isValidTraceId.html @@ -1,2 +1,2 @@ isValidTraceId | OpenTelemetry SDK
    +
    diff --git a/functions/_opentelemetry_api._opentelemetry_api_experimental.wrapTracer.html b/functions/_opentelemetry_api._opentelemetry_api_experimental.wrapTracer.html index f52836432..529888851 100644 --- a/functions/_opentelemetry_api._opentelemetry_api_experimental.wrapTracer.html +++ b/functions/_opentelemetry_api._opentelemetry_api_experimental.wrapTracer.html @@ -1,2 +1,2 @@ wrapTracer | OpenTelemetry SDK
    +

    Parameters

    Returns SugaredTracer

    diff --git a/functions/_opentelemetry_core.addHrTimes.html b/functions/_opentelemetry_core.addHrTimes.html index c3a34626a..117b417f0 100644 --- a/functions/_opentelemetry_core.addHrTimes.html +++ b/functions/_opentelemetry_core.addHrTimes.html @@ -1,2 +1,2 @@ addHrTimes | OpenTelemetry SDK
    +

    Parameters

    Returns HrTime

    diff --git a/functions/_opentelemetry_core.callWithTimeout.html b/functions/_opentelemetry_core.callWithTimeout.html index 9351a8faa..d250b00a0 100644 --- a/functions/_opentelemetry_core.callWithTimeout.html +++ b/functions/_opentelemetry_core.callWithTimeout.html @@ -2,4 +2,4 @@ rejects, and resolves if the specified promise resolves.

    NOTE: this operation will continue even after it throws a TimeoutError.

    Type Parameters

    • T

    Parameters

    • promise: Promise<T>

      promise to use with timeout.

    • timeout: number

      the timeout in milliseconds until the returned promise is rejected.

      -

    Returns Promise<T>

    +

    Returns Promise<T>

    diff --git a/functions/_opentelemetry_core.deleteRPCMetadata.html b/functions/_opentelemetry_core.deleteRPCMetadata.html index 3ed28c9a5..3da50eab7 100644 --- a/functions/_opentelemetry_core.deleteRPCMetadata.html +++ b/functions/_opentelemetry_core.deleteRPCMetadata.html @@ -1 +1 @@ -deleteRPCMetadata | OpenTelemetry SDK
    +deleteRPCMetadata | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.diagLogLevelFromString.html b/functions/_opentelemetry_core.diagLogLevelFromString.html index a125ba574..e0aa06855 100644 --- a/functions/_opentelemetry_core.diagLogLevelFromString.html +++ b/functions/_opentelemetry_core.diagLogLevelFromString.html @@ -1,2 +1,2 @@ diagLogLevelFromString | OpenTelemetry SDK
    +

    Parameters

    • value: undefined | string

    Returns undefined | DiagLogLevel

    diff --git a/functions/_opentelemetry_core.getBooleanFromEnv.html b/functions/_opentelemetry_core.getBooleanFromEnv.html index 3163d2aa2..9385a53f9 100644 --- a/functions/_opentelemetry_core.getBooleanFromEnv.html +++ b/functions/_opentelemetry_core.getBooleanFromEnv.html @@ -8,4 +8,4 @@

    Returns boolean

    • The boolean value or false if the environment variable is unset empty, unset, or contains only whitespace.
    -
    +
    diff --git a/functions/_opentelemetry_core.getNumberFromEnv.html b/functions/_opentelemetry_core.getNumberFromEnv.html index cb5791e09..2db92525c 100644 --- a/functions/_opentelemetry_core.getNumberFromEnv.html +++ b/functions/_opentelemetry_core.getNumberFromEnv.html @@ -7,4 +7,4 @@

    Returns undefined | number

    • The number value or undefined.
    -
    +
    diff --git a/functions/_opentelemetry_core.getRPCMetadata.html b/functions/_opentelemetry_core.getRPCMetadata.html index 9a9cbfe37..26bb9ad82 100644 --- a/functions/_opentelemetry_core.getRPCMetadata.html +++ b/functions/_opentelemetry_core.getRPCMetadata.html @@ -1 +1 @@ -getRPCMetadata | OpenTelemetry SDK
    +getRPCMetadata | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.getStringFromEnv.html b/functions/_opentelemetry_core.getStringFromEnv.html index 35cabefb9..f3147c6e0 100644 --- a/functions/_opentelemetry_core.getStringFromEnv.html +++ b/functions/_opentelemetry_core.getStringFromEnv.html @@ -6,4 +6,4 @@

    Returns undefined | string

    • The string value or undefined.
    -
    +
    diff --git a/functions/_opentelemetry_core.getStringListFromEnv.html b/functions/_opentelemetry_core.getStringListFromEnv.html index 2fa0cb161..e85b5ec92 100644 --- a/functions/_opentelemetry_core.getStringListFromEnv.html +++ b/functions/_opentelemetry_core.getStringListFromEnv.html @@ -10,4 +10,4 @@

    Returns undefined | string[]

    • The list of strings or undefined.
    -
    +
    diff --git a/functions/_opentelemetry_core.getTimeOrigin.html b/functions/_opentelemetry_core.getTimeOrigin.html index 934a31d4a..700e4af05 100644 --- a/functions/_opentelemetry_core.getTimeOrigin.html +++ b/functions/_opentelemetry_core.getTimeOrigin.html @@ -1 +1 @@ -getTimeOrigin | OpenTelemetry SDK
    +getTimeOrigin | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.globalErrorHandler.html b/functions/_opentelemetry_core.globalErrorHandler.html index f230f2499..1d9698a51 100644 --- a/functions/_opentelemetry_core.globalErrorHandler.html +++ b/functions/_opentelemetry_core.globalErrorHandler.html @@ -1,2 +1,2 @@ globalErrorHandler | OpenTelemetry SDK
    +

    Parameters

    Returns void

    diff --git a/functions/_opentelemetry_core.hrTime.html b/functions/_opentelemetry_core.hrTime.html index 45bf23a90..3a49315a8 100644 --- a/functions/_opentelemetry_core.hrTime.html +++ b/functions/_opentelemetry_core.hrTime.html @@ -1,2 +1,2 @@ hrTime | OpenTelemetry SDK
    +

    Parameters

    • OptionalperformanceNow: number

    Returns HrTime

    diff --git a/functions/_opentelemetry_core.hrTimeDuration.html b/functions/_opentelemetry_core.hrTimeDuration.html index 4b0ad78fe..fbbfd3d46 100644 --- a/functions/_opentelemetry_core.hrTimeDuration.html +++ b/functions/_opentelemetry_core.hrTimeDuration.html @@ -1,2 +1,2 @@ hrTimeDuration | OpenTelemetry SDK
    +

    Parameters

    Returns HrTime

    diff --git a/functions/_opentelemetry_core.hrTimeToMicroseconds.html b/functions/_opentelemetry_core.hrTimeToMicroseconds.html index 97e15dd3e..7ce1da8b3 100644 --- a/functions/_opentelemetry_core.hrTimeToMicroseconds.html +++ b/functions/_opentelemetry_core.hrTimeToMicroseconds.html @@ -1,2 +1,2 @@ hrTimeToMicroseconds | OpenTelemetry SDK
    +

    Parameters

    Returns number

    diff --git a/functions/_opentelemetry_core.hrTimeToMilliseconds.html b/functions/_opentelemetry_core.hrTimeToMilliseconds.html index 0b2b9e49f..b61b3d074 100644 --- a/functions/_opentelemetry_core.hrTimeToMilliseconds.html +++ b/functions/_opentelemetry_core.hrTimeToMilliseconds.html @@ -1,2 +1,2 @@ hrTimeToMilliseconds | OpenTelemetry SDK
    +

    Parameters

    Returns number

    diff --git a/functions/_opentelemetry_core.hrTimeToNanoseconds.html b/functions/_opentelemetry_core.hrTimeToNanoseconds.html index 09e25828d..15be620cf 100644 --- a/functions/_opentelemetry_core.hrTimeToNanoseconds.html +++ b/functions/_opentelemetry_core.hrTimeToNanoseconds.html @@ -1,2 +1,2 @@ hrTimeToNanoseconds | OpenTelemetry SDK
    +

    Parameters

    Returns number

    diff --git a/functions/_opentelemetry_core.hrTimeToTimeStamp.html b/functions/_opentelemetry_core.hrTimeToTimeStamp.html index c439f5a18..72bf771c0 100644 --- a/functions/_opentelemetry_core.hrTimeToTimeStamp.html +++ b/functions/_opentelemetry_core.hrTimeToTimeStamp.html @@ -1,2 +1,2 @@ hrTimeToTimeStamp | OpenTelemetry SDK
    +

    Parameters

    Returns string

    diff --git a/functions/_opentelemetry_core.isAttributeValue.html b/functions/_opentelemetry_core.isAttributeValue.html index 8f8c6213b..acd6cf5e2 100644 --- a/functions/_opentelemetry_core.isAttributeValue.html +++ b/functions/_opentelemetry_core.isAttributeValue.html @@ -1 +1 @@ -isAttributeValue | OpenTelemetry SDK
    +isAttributeValue | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.isTimeInput.html b/functions/_opentelemetry_core.isTimeInput.html index 3a62d5098..f6cc7bf61 100644 --- a/functions/_opentelemetry_core.isTimeInput.html +++ b/functions/_opentelemetry_core.isTimeInput.html @@ -1,2 +1,2 @@ isTimeInput | OpenTelemetry SDK
    +

    Parameters

    • value: unknown

    Returns value is number | HrTime | Date

    diff --git a/functions/_opentelemetry_core.isTimeInputHrTime.html b/functions/_opentelemetry_core.isTimeInputHrTime.html index a4dfb665a..5ad65ddce 100644 --- a/functions/_opentelemetry_core.isTimeInputHrTime.html +++ b/functions/_opentelemetry_core.isTimeInputHrTime.html @@ -1,2 +1,2 @@ isTimeInputHrTime | OpenTelemetry SDK
    +

    Parameters

    • value: unknown

    Returns value is HrTime

    diff --git a/functions/_opentelemetry_core.isTracingSuppressed.html b/functions/_opentelemetry_core.isTracingSuppressed.html index 6c7e57538..0ead6f486 100644 --- a/functions/_opentelemetry_core.isTracingSuppressed.html +++ b/functions/_opentelemetry_core.isTracingSuppressed.html @@ -1 +1 @@ -isTracingSuppressed | OpenTelemetry SDK
    +isTracingSuppressed | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.isUrlIgnored.html b/functions/_opentelemetry_core.isUrlIgnored.html index 7a932158b..daaefa4f5 100644 --- a/functions/_opentelemetry_core.isUrlIgnored.html +++ b/functions/_opentelemetry_core.isUrlIgnored.html @@ -1,2 +1,2 @@ isUrlIgnored | OpenTelemetry SDK
    • Check if {@param url} should be ignored when comparing against {@param ignoredUrls}

      -

      Parameters

      • url: string
      • OptionalignoredUrls: (string | RegExp)[]

      Returns boolean

    +

    Parameters

    • url: string
    • OptionalignoredUrls: (string | RegExp)[]

    Returns boolean

    diff --git a/functions/_opentelemetry_core.loggingErrorHandler.html b/functions/_opentelemetry_core.loggingErrorHandler.html index f0d111a8d..82e153a97 100644 --- a/functions/_opentelemetry_core.loggingErrorHandler.html +++ b/functions/_opentelemetry_core.loggingErrorHandler.html @@ -1,3 +1,3 @@ loggingErrorHandler | OpenTelemetry SDK
    +

    Returns ErrorHandler

    diff --git a/functions/_opentelemetry_core.merge.html b/functions/_opentelemetry_core.merge.html index 95a42c6b1..effda3226 100644 --- a/functions/_opentelemetry_core.merge.html +++ b/functions/_opentelemetry_core.merge.html @@ -1,3 +1,3 @@ merge | OpenTelemetry SDK
    +

    Returns any

    diff --git a/functions/_opentelemetry_core.millisToHrTime.html b/functions/_opentelemetry_core.millisToHrTime.html index 1dc3d7620..d1b094368 100644 --- a/functions/_opentelemetry_core.millisToHrTime.html +++ b/functions/_opentelemetry_core.millisToHrTime.html @@ -1,2 +1,2 @@ millisToHrTime | OpenTelemetry SDK
    +

    Parameters

    • epochMillis: number

    Returns HrTime

    diff --git a/functions/_opentelemetry_core.parseKeyPairsIntoRecord.html b/functions/_opentelemetry_core.parseKeyPairsIntoRecord.html index fe36807b1..4852bb184 100644 --- a/functions/_opentelemetry_core.parseKeyPairsIntoRecord.html +++ b/functions/_opentelemetry_core.parseKeyPairsIntoRecord.html @@ -1,3 +1,3 @@ parseKeyPairsIntoRecord | OpenTelemetry SDK
    +

    Parameters

    • Optionalvalue: string

    Returns Record<string, string>

    diff --git a/functions/_opentelemetry_core.parseTraceParent.html b/functions/_opentelemetry_core.parseTraceParent.html index db3a74d08..901aad260 100644 --- a/functions/_opentelemetry_core.parseTraceParent.html +++ b/functions/_opentelemetry_core.parseTraceParent.html @@ -6,4 +6,4 @@ and the trace flags to indicate the server's sampling decision (01 = sampled, 00 = not sampled). for example: '{version}-{traceId}-{spanId}-{sampleDecision}' For more information see https://www.w3.org/TR/trace-context/

    -

    Returns null | SpanContext

    +

    Returns null | SpanContext

    diff --git a/functions/_opentelemetry_core.sanitizeAttributes.html b/functions/_opentelemetry_core.sanitizeAttributes.html index b5fdc839d..a630160d1 100644 --- a/functions/_opentelemetry_core.sanitizeAttributes.html +++ b/functions/_opentelemetry_core.sanitizeAttributes.html @@ -1 +1 @@ -sanitizeAttributes | OpenTelemetry SDK
    +sanitizeAttributes | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.setGlobalErrorHandler.html b/functions/_opentelemetry_core.setGlobalErrorHandler.html index 1c7ba7d90..9d1ad531a 100644 --- a/functions/_opentelemetry_core.setGlobalErrorHandler.html +++ b/functions/_opentelemetry_core.setGlobalErrorHandler.html @@ -1,2 +1,2 @@ setGlobalErrorHandler | OpenTelemetry SDK
    +

    Parameters

    Returns void

    diff --git a/functions/_opentelemetry_core.setRPCMetadata.html b/functions/_opentelemetry_core.setRPCMetadata.html index 98335244e..1939ce24b 100644 --- a/functions/_opentelemetry_core.setRPCMetadata.html +++ b/functions/_opentelemetry_core.setRPCMetadata.html @@ -1 +1 @@ -setRPCMetadata | OpenTelemetry SDK
    +setRPCMetadata | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.suppressTracing.html b/functions/_opentelemetry_core.suppressTracing.html index e4172056a..959b7fd2d 100644 --- a/functions/_opentelemetry_core.suppressTracing.html +++ b/functions/_opentelemetry_core.suppressTracing.html @@ -1 +1 @@ -suppressTracing | OpenTelemetry SDK
    +suppressTracing | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.timeInputToHrTime.html b/functions/_opentelemetry_core.timeInputToHrTime.html index 07ed3ac70..ec6de5727 100644 --- a/functions/_opentelemetry_core.timeInputToHrTime.html +++ b/functions/_opentelemetry_core.timeInputToHrTime.html @@ -1,2 +1,2 @@ timeInputToHrTime | OpenTelemetry SDK
    +

    Parameters

    Returns HrTime

    diff --git a/functions/_opentelemetry_core.unrefTimer.html b/functions/_opentelemetry_core.unrefTimer.html index 785691e68..a24cd7e38 100644 --- a/functions/_opentelemetry_core.unrefTimer.html +++ b/functions/_opentelemetry_core.unrefTimer.html @@ -1 +1 @@ -unrefTimer | OpenTelemetry SDK
    +unrefTimer | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.unsuppressTracing.html b/functions/_opentelemetry_core.unsuppressTracing.html index 92b553cba..56646051e 100644 --- a/functions/_opentelemetry_core.unsuppressTracing.html +++ b/functions/_opentelemetry_core.unsuppressTracing.html @@ -1 +1 @@ -unsuppressTracing | OpenTelemetry SDK
    +unsuppressTracing | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_core.urlMatches.html b/functions/_opentelemetry_core.urlMatches.html index cd75b0283..94fbebd71 100644 --- a/functions/_opentelemetry_core.urlMatches.html +++ b/functions/_opentelemetry_core.urlMatches.html @@ -1 +1 @@ -urlMatches | OpenTelemetry SDK
    +urlMatches | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_exporter-metrics-otlp-http.CumulativeTemporalitySelector.html b/functions/_opentelemetry_exporter-metrics-otlp-http.CumulativeTemporalitySelector.html index 397cbaa7c..c8d00bc95 100644 --- a/functions/_opentelemetry_exporter-metrics-otlp-http.CumulativeTemporalitySelector.html +++ b/functions/_opentelemetry_exporter-metrics-otlp-http.CumulativeTemporalitySelector.html @@ -1 +1 @@ -CumulativeTemporalitySelector | OpenTelemetry SDK
    +CumulativeTemporalitySelector | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_exporter-metrics-otlp-http.DeltaTemporalitySelector.html b/functions/_opentelemetry_exporter-metrics-otlp-http.DeltaTemporalitySelector.html index 99a66a5da..c117b2c11 100644 --- a/functions/_opentelemetry_exporter-metrics-otlp-http.DeltaTemporalitySelector.html +++ b/functions/_opentelemetry_exporter-metrics-otlp-http.DeltaTemporalitySelector.html @@ -1 +1 @@ -DeltaTemporalitySelector | OpenTelemetry SDK
    +DeltaTemporalitySelector | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_exporter-metrics-otlp-http.LowMemoryTemporalitySelector.html b/functions/_opentelemetry_exporter-metrics-otlp-http.LowMemoryTemporalitySelector.html index 129ff37cb..4a50b5ed9 100644 --- a/functions/_opentelemetry_exporter-metrics-otlp-http.LowMemoryTemporalitySelector.html +++ b/functions/_opentelemetry_exporter-metrics-otlp-http.LowMemoryTemporalitySelector.html @@ -1 +1 @@ -LowMemoryTemporalitySelector | OpenTelemetry SDK
    +LowMemoryTemporalitySelector | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_exporter-zipkin.prepareSend.html b/functions/_opentelemetry_exporter-zipkin.prepareSend.html index 28ab44d9b..cea504dcc 100644 --- a/functions/_opentelemetry_exporter-zipkin.prepareSend.html +++ b/functions/_opentelemetry_exporter-zipkin.prepareSend.html @@ -2,4 +2,4 @@

    Parameters

    • urlStr: string

      url to send spans

    • Optionalheaders: Record<string, string>

      headers send

      -

    Returns SendFn

    +

    Returns SendFn

    diff --git a/functions/_opentelemetry_instrumentation.isWrapped.html b/functions/_opentelemetry_instrumentation.isWrapped.html index 26b59e976..34494e12c 100644 --- a/functions/_opentelemetry_instrumentation.isWrapped.html +++ b/functions/_opentelemetry_instrumentation.isWrapped.html @@ -1,2 +1,2 @@ isWrapped | OpenTelemetry SDK
    +

    Parameters

    • func: unknown

    Returns func is ShimWrapped

    diff --git a/functions/_opentelemetry_instrumentation.registerInstrumentations.html b/functions/_opentelemetry_instrumentation.registerInstrumentations.html index 0bf784cb2..ade4f97f8 100644 --- a/functions/_opentelemetry_instrumentation.registerInstrumentations.html +++ b/functions/_opentelemetry_instrumentation.registerInstrumentations.html @@ -1,4 +1,4 @@ registerInstrumentations | OpenTelemetry SDK
    +
    diff --git a/functions/_opentelemetry_instrumentation.safeExecuteInTheMiddle.html b/functions/_opentelemetry_instrumentation.safeExecuteInTheMiddle.html index 669ba626a..b63f90f4c 100644 --- a/functions/_opentelemetry_instrumentation.safeExecuteInTheMiddle.html +++ b/functions/_opentelemetry_instrumentation.safeExecuteInTheMiddle.html @@ -1,4 +1,4 @@ safeExecuteInTheMiddle | OpenTelemetry SDK
    • function to execute patched function and being able to catch errors

      Type Parameters

      • T

      Parameters

      • execute: () => T

        function to be executed

      • onFinish: (e: undefined | Error, result: undefined | T) => void

        callback to run when execute finishes

        -
      • OptionalpreventThrowingError: boolean

      Returns T

    +
  • OptionalpreventThrowingError: boolean
  • Returns T

    diff --git a/functions/_opentelemetry_instrumentation.safeExecuteInTheMiddleAsync.html b/functions/_opentelemetry_instrumentation.safeExecuteInTheMiddleAsync.html index 3d5e5aa71..27a55de80 100644 --- a/functions/_opentelemetry_instrumentation.safeExecuteInTheMiddleAsync.html +++ b/functions/_opentelemetry_instrumentation.safeExecuteInTheMiddleAsync.html @@ -1,4 +1,4 @@ safeExecuteInTheMiddleAsync | OpenTelemetry SDK
    • Async function to execute patched function and being able to catch errors

      Type Parameters

      • T

      Parameters

      • execute: () => T

        function to be executed

      • onFinish: (e: undefined | Error, result: undefined | T) => void

        callback to run when execute finishes

        -
      • OptionalpreventThrowingError: boolean

      Returns Promise<T>

    +
  • OptionalpreventThrowingError: boolean
  • Returns Promise<T>

    diff --git a/functions/_opentelemetry_instrumentation.semconvStabilityFromStr.html b/functions/_opentelemetry_instrumentation.semconvStabilityFromStr.html index 9733601eb..fd8f03e44 100644 --- a/functions/_opentelemetry_instrumentation.semconvStabilityFromStr.html +++ b/functions/_opentelemetry_instrumentation.semconvStabilityFromStr.html @@ -37,4 +37,4 @@ if (this._semconvStability & SemconvStability.OLD) { if (this._semconvStability & SemconvStability.STABLE) { // ... }

    -

    Parameters

    • namespace: SemConvStabilityNamespace
    • str: undefined | string

    Returns SemconvStability

    +

    Parameters

    • namespace: SemConvStabilityNamespace
    • str: undefined | string

    Returns SemconvStability

    diff --git a/functions/_opentelemetry_otlp-grpc-exporter-base.convertLegacyOtlpGrpcOptions.html b/functions/_opentelemetry_otlp-grpc-exporter-base.convertLegacyOtlpGrpcOptions.html index 1a1417043..08913cb47 100644 --- a/functions/_opentelemetry_otlp-grpc-exporter-base.convertLegacyOtlpGrpcOptions.html +++ b/functions/_opentelemetry_otlp-grpc-exporter-base.convertLegacyOtlpGrpcOptions.html @@ -1 +1 @@ -convertLegacyOtlpGrpcOptions | OpenTelemetry SDK
    +convertLegacyOtlpGrpcOptions | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_otlp-grpc-exporter-base.createOtlpGrpcExportDelegate.html b/functions/_opentelemetry_otlp-grpc-exporter-base.createOtlpGrpcExportDelegate.html index f4d84e44e..5bedc467c 100644 --- a/functions/_opentelemetry_otlp-grpc-exporter-base.createOtlpGrpcExportDelegate.html +++ b/functions/_opentelemetry_otlp-grpc-exporter-base.createOtlpGrpcExportDelegate.html @@ -1 +1 @@ -createOtlpGrpcExportDelegate | OpenTelemetry SDK
    +createOtlpGrpcExportDelegate | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_resources.defaultResource.html b/functions/_opentelemetry_resources.defaultResource.html index 46f7548e4..652a67a16 100644 --- a/functions/_opentelemetry_resources.defaultResource.html +++ b/functions/_opentelemetry_resources.defaultResource.html @@ -1 +1 @@ -defaultResource | OpenTelemetry SDK
    +defaultResource | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_resources.defaultServiceName.html b/functions/_opentelemetry_resources.defaultServiceName.html index 3e50a6824..5f2afb63c 100644 --- a/functions/_opentelemetry_resources.defaultServiceName.html +++ b/functions/_opentelemetry_resources.defaultServiceName.html @@ -1 +1 @@ -defaultServiceName | OpenTelemetry SDK
    +defaultServiceName | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_resources.detectResources.html b/functions/_opentelemetry_resources.detectResources.html index 82fb29fdd..dd044ef4a 100644 --- a/functions/_opentelemetry_resources.detectResources.html +++ b/functions/_opentelemetry_resources.detectResources.html @@ -1,3 +1,3 @@ detectResources | OpenTelemetry SDK

    Runs all resource detectors and returns the results merged into a single Resource.

    +

    Returns Resource

    diff --git a/functions/_opentelemetry_resources.emptyResource.html b/functions/_opentelemetry_resources.emptyResource.html index fb0656095..f675a6fa8 100644 --- a/functions/_opentelemetry_resources.emptyResource.html +++ b/functions/_opentelemetry_resources.emptyResource.html @@ -1 +1 @@ -emptyResource | OpenTelemetry SDK
    +emptyResource | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_resources.resourceFromAttributes.html b/functions/_opentelemetry_resources.resourceFromAttributes.html index 9d418ba59..3e71f337e 100644 --- a/functions/_opentelemetry_resources.resourceFromAttributes.html +++ b/functions/_opentelemetry_resources.resourceFromAttributes.html @@ -1 +1 @@ -resourceFromAttributes | OpenTelemetry SDK
    +resourceFromAttributes | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_sdk-metrics.createAllowListAttributesProcessor.html b/functions/_opentelemetry_sdk-metrics.createAllowListAttributesProcessor.html index b42f09b2c..74c45f65b 100644 --- a/functions/_opentelemetry_sdk-metrics.createAllowListAttributesProcessor.html +++ b/functions/_opentelemetry_sdk-metrics.createAllowListAttributesProcessor.html @@ -1,3 +1,3 @@ createAllowListAttributesProcessor | OpenTelemetry SDK
    +

    Parameters

    • attributeAllowList: string[]

    Returns IAttributesProcessor

    diff --git a/functions/_opentelemetry_sdk-metrics.createDenyListAttributesProcessor.html b/functions/_opentelemetry_sdk-metrics.createDenyListAttributesProcessor.html index d17295cd2..62c0232a0 100644 --- a/functions/_opentelemetry_sdk-metrics.createDenyListAttributesProcessor.html +++ b/functions/_opentelemetry_sdk-metrics.createDenyListAttributesProcessor.html @@ -1,2 +1,2 @@ createDenyListAttributesProcessor | OpenTelemetry SDK
    +

    Parameters

    • attributeDenyList: string[]

    Returns IAttributesProcessor

    diff --git a/functions/_opentelemetry_sdk-trace-web.addSpanNetworkEvent.html b/functions/_opentelemetry_sdk-trace-web.addSpanNetworkEvent.html index c2c5a7ccb..a1f7b514f 100644 --- a/functions/_opentelemetry_sdk-trace-web.addSpanNetworkEvent.html +++ b/functions/_opentelemetry_sdk-trace-web.addSpanNetworkEvent.html @@ -1,3 +1,3 @@ addSpanNetworkEvent | OpenTelemetry SDK
    +
  • entries: PerformanceEntries
  • ignoreZeros: boolean = true
  • Returns undefined | Span

    diff --git a/functions/_opentelemetry_sdk-trace-web.addSpanNetworkEvents.html b/functions/_opentelemetry_sdk-trace-web.addSpanNetworkEvents.html index ff502a0d8..ae7774c09 100644 --- a/functions/_opentelemetry_sdk-trace-web.addSpanNetworkEvents.html +++ b/functions/_opentelemetry_sdk-trace-web.addSpanNetworkEvents.html @@ -1,2 +1,2 @@ addSpanNetworkEvents | OpenTelemetry SDK
    • Helper function for adding network events and content length attributes.

      -

      Parameters

      • span: Span
      • resource: PerformanceEntries
      • ignoreNetworkEvents: boolean = false
      • OptionalignoreZeros: boolean
      • OptionalskipOldSemconvContentLengthAttrs: boolean

      Returns void

    +

    Parameters

    • span: Span
    • resource: PerformanceEntries
    • ignoreNetworkEvents: boolean = false
    • OptionalignoreZeros: boolean
    • OptionalskipOldSemconvContentLengthAttrs: boolean

    Returns void

    diff --git a/functions/_opentelemetry_sdk-trace-web.getElementXPath.html b/functions/_opentelemetry_sdk-trace-web.getElementXPath.html index 84f6e0734..16c9fb22a 100644 --- a/functions/_opentelemetry_sdk-trace-web.getElementXPath.html +++ b/functions/_opentelemetry_sdk-trace-web.getElementXPath.html @@ -2,4 +2,4 @@

    Parameters

    • target: any

      target element

    • Optionaloptimised: boolean

      when id attribute of element is present the xpath can be simplified to contain id

      -

    Returns string

    +

    Returns string

    diff --git a/functions/_opentelemetry_sdk-trace-web.getResource.html b/functions/_opentelemetry_sdk-trace-web.getResource.html index 97f8e9916..a94f03abc 100644 --- a/functions/_opentelemetry_sdk-trace-web.getResource.html +++ b/functions/_opentelemetry_sdk-trace-web.getResource.html @@ -1,3 +1,3 @@ getResource | OpenTelemetry SDK
    • Get closest performance resource ignoring the resources that have been already used.

      -

      Parameters

      • spanUrl: string
      • startTimeHR: HrTime
      • endTimeHR: HrTime
      • resources: PerformanceResourceTiming[]
      • ignoredResources: WeakSet<PerformanceResourceTiming> = ...
      • OptionalinitiatorType: string

      Returns PerformanceResourceTimingInfo

    +

    Parameters

    • spanUrl: string
    • startTimeHR: HrTime
    • endTimeHR: HrTime
    • resources: PerformanceResourceTiming[]
    • ignoredResources: WeakSet<PerformanceResourceTiming> = ...
    • OptionalinitiatorType: string

    Returns PerformanceResourceTimingInfo

    diff --git a/functions/_opentelemetry_sdk-trace-web.hasKey.html b/functions/_opentelemetry_sdk-trace-web.hasKey.html index 1f0d7ef42..84c763b27 100644 --- a/functions/_opentelemetry_sdk-trace-web.hasKey.html +++ b/functions/_opentelemetry_sdk-trace-web.hasKey.html @@ -1,2 +1,2 @@ hasKey | OpenTelemetry SDK
    • Helper function to be able to use enum as typed key in type and in interface when using forEach

      -

      Type Parameters

      • O extends object

      Parameters

      • obj: O
      • key: PropertyKey

      Returns key is keyof O

    +

    Type Parameters

    • O extends object

    Parameters

    • obj: O
    • key: PropertyKey

    Returns key is keyof O

    diff --git a/functions/_opentelemetry_sdk-trace-web.normalizeUrl.html b/functions/_opentelemetry_sdk-trace-web.normalizeUrl.html index 84ac95b1c..8204b64dd 100644 --- a/functions/_opentelemetry_sdk-trace-web.normalizeUrl.html +++ b/functions/_opentelemetry_sdk-trace-web.normalizeUrl.html @@ -1,4 +1,4 @@ normalizeUrl | OpenTelemetry SDK
    +

    Parameters

    • url: string

    Returns string

    diff --git a/functions/_opentelemetry_sdk-trace-web.parseUrl.html b/functions/_opentelemetry_sdk-trace-web.parseUrl.html index 4b460450d..2bb56febb 100644 --- a/functions/_opentelemetry_sdk-trace-web.parseUrl.html +++ b/functions/_opentelemetry_sdk-trace-web.parseUrl.html @@ -1,2 +1,2 @@ parseUrl | OpenTelemetry SDK
    +

    Parameters

    • url: string

    Returns URLLike

    diff --git a/functions/_opentelemetry_sdk-trace-web.sortResources.html b/functions/_opentelemetry_sdk-trace-web.sortResources.html index 1e095b7a5..b629442da 100644 --- a/functions/_opentelemetry_sdk-trace-web.sortResources.html +++ b/functions/_opentelemetry_sdk-trace-web.sortResources.html @@ -1,2 +1,2 @@ sortResources | OpenTelemetry SDK
    • sort resources by startTime

      -

      Parameters

      • filteredResources: PerformanceResourceTiming[]

      Returns PerformanceResourceTiming[]

    +

    Parameters

    • filteredResources: PerformanceResourceTiming[]

    Returns PerformanceResourceTiming[]

    diff --git a/functions/_opentelemetry_shim-opencensus..installShim.html b/functions/_opentelemetry_shim-opencensus..installShim.html index 5c0f88772..4317b6068 100644 --- a/functions/_opentelemetry_shim-opencensus..installShim.html +++ b/functions/_opentelemetry_shim-opencensus..installShim.html @@ -1,4 +1,4 @@ installShim | OpenTelemetry SDK
    • Patches OpenCensus to redirect all instrumentation to OpenTelemetry. Uses require-in-the-middle to override the implementation of OpenCensus's CoreTracer.

      Use uninstallShim to undo the effects of this function.

      -

      Parameters

      • config: OpenCensusShimConfig = {}

      Returns void

    +

    Parameters

    • config: OpenCensusShimConfig = {}

    Returns void

    diff --git a/functions/_opentelemetry_shim-opencensus..uninstallShim.html b/functions/_opentelemetry_shim-opencensus..uninstallShim.html index 1f7b41f7b..1cde7f28f 100644 --- a/functions/_opentelemetry_shim-opencensus..uninstallShim.html +++ b/functions/_opentelemetry_shim-opencensus..uninstallShim.html @@ -1 +1 @@ -uninstallShim | OpenTelemetry SDK
    • Returns void

    +uninstallShim | OpenTelemetry SDK
    • Returns void

    diff --git a/functions/_opentelemetry_web-common.createSessionLogRecordProcessor.html b/functions/_opentelemetry_web-common.createSessionLogRecordProcessor.html index e1c340b7a..479994e59 100644 --- a/functions/_opentelemetry_web-common.createSessionLogRecordProcessor.html +++ b/functions/_opentelemetry_web-common.createSessionLogRecordProcessor.html @@ -1 +1 @@ -createSessionLogRecordProcessor | OpenTelemetry SDK
    +createSessionLogRecordProcessor | OpenTelemetry SDK
    diff --git a/functions/_opentelemetry_web-common.createSessionSpanProcessor.html b/functions/_opentelemetry_web-common.createSessionSpanProcessor.html index e2f2d9784..254e977bf 100644 --- a/functions/_opentelemetry_web-common.createSessionSpanProcessor.html +++ b/functions/_opentelemetry_web-common.createSessionSpanProcessor.html @@ -1 +1 @@ -createSessionSpanProcessor | OpenTelemetry SDK
    +createSessionSpanProcessor | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_api-events.Event.html b/interfaces/_opentelemetry_api-events.Event.html index 993e190ff..b9a70bf38 100644 --- a/interfaces/_opentelemetry_api-events.Event.html +++ b/interfaces/_opentelemetry_api-events.Event.html @@ -1,14 +1,14 @@ -Event | OpenTelemetry SDK
    interface Event {
        attributes?: Attributes;
        context?: Context;
        data?: AnyValue;
        name: string;
        severityNumber?: SeverityNumber;
        timestamp?: TimeInput;
    }

    Properties

    attributes? +Event | OpenTelemetry SDK
    interface Event {
        attributes?: Attributes;
        context?: Context;
        data?: AnyValue;
        name: string;
        severityNumber?: SeverityNumber;
        timestamp?: TimeInput;
    }

    Properties

    attributes?: Attributes

    Additional attributes that describe the event.

    -
    context?: Context

    The Context associated with the Event.

    -
    data?: AnyValue

    Data that describes the event. +

    context?: Context

    The Context associated with the Event.

    +
    data?: AnyValue

    Data that describes the event. Intended to be used by instrumentation libraries.

    -
    name: string

    The name of the event.

    -
    severityNumber?: SeverityNumber

    Numerical value of the severity.

    -
    timestamp?: TimeInput

    The time when the event occurred as UNIX Epoch time in nanoseconds.

    -
    +
    name: string

    The name of the event.

    +
    severityNumber?: SeverityNumber

    Numerical value of the severity.

    +
    timestamp?: TimeInput

    The time when the event occurred as UNIX Epoch time in nanoseconds.

    +
    diff --git a/interfaces/_opentelemetry_api-events.EventLogger.html b/interfaces/_opentelemetry_api-events.EventLogger.html index 0f5720ea2..213e608ea 100644 --- a/interfaces/_opentelemetry_api-events.EventLogger.html +++ b/interfaces/_opentelemetry_api-events.EventLogger.html @@ -1,3 +1,3 @@ -EventLogger | OpenTelemetry SDK
    interface EventLogger {
        emit(event: Event): void;
    }

    Implemented by

    Methods

    emit +EventLogger | OpenTelemetry SDK
    interface EventLogger {
        emit(event: Event): void;
    }

    Implemented by

    Methods

    Methods

    • Emit an event. This method should only be used by instrumentations emitting events.

      -

      Parameters

      Returns void

    +

    Parameters

    Returns void

    diff --git a/interfaces/_opentelemetry_api-events.EventLoggerOptions.html b/interfaces/_opentelemetry_api-events.EventLoggerOptions.html index 257406b60..037454c45 100644 --- a/interfaces/_opentelemetry_api-events.EventLoggerOptions.html +++ b/interfaces/_opentelemetry_api-events.EventLoggerOptions.html @@ -1,8 +1,8 @@ -EventLoggerOptions | OpenTelemetry SDK
    interface EventLoggerOptions {
        schemaUrl?: string;
        scopeAttributes?: Attributes;
    }

    Properties

    schemaUrl? +EventLoggerOptions | OpenTelemetry SDK
    interface EventLoggerOptions {
        schemaUrl?: string;
        scopeAttributes?: Attributes;
    }

    Properties

    schemaUrl?: string

    The schemaUrl of the tracer or instrumentation library

    ''
     
    -
    scopeAttributes?: Attributes

    The instrumentation scope attributes to associate with emitted telemetry

    -
    +
    scopeAttributes?: Attributes

    The instrumentation scope attributes to associate with emitted telemetry

    +
    diff --git a/interfaces/_opentelemetry_api-events.EventLoggerProvider.html b/interfaces/_opentelemetry_api-events.EventLoggerProvider.html index ca841d871..198654391 100644 --- a/interfaces/_opentelemetry_api-events.EventLoggerProvider.html +++ b/interfaces/_opentelemetry_api-events.EventLoggerProvider.html @@ -1,9 +1,9 @@ EventLoggerProvider | OpenTelemetry SDK

    A registry for creating named EventLoggers.

    -
    interface EventLoggerProvider {
        getEventLogger(
            name: string,
            version?: string,
            options?: EventLoggerOptions,
        ): EventLogger;
    }

    Implemented by

    Methods

    interface EventLoggerProvider {
        getEventLogger(
            name: string,
            version?: string,
            options?: EventLoggerOptions,
        ): EventLogger;
    }

    Implemented by

    Methods

    • Returns an EventLogger, creating one if one with the given name, version, and schemaUrl pair is not already created.

      Parameters

      • name: string

        The name of the event logger or instrumentation library.

      • Optionalversion: string

        The version of the event logger or instrumentation library.

      • Optionaloptions: EventLoggerOptions

        The options of the event logger or instrumentation library.

      Returns EventLogger

      EventLogger An event logger with the given name and version.

      -
    +
    diff --git a/interfaces/_opentelemetry_api-logs.AnyValueMap.html b/interfaces/_opentelemetry_api-logs.AnyValueMap.html index e13b57206..4da0961ae 100644 --- a/interfaces/_opentelemetry_api-logs.AnyValueMap.html +++ b/interfaces/_opentelemetry_api-logs.AnyValueMap.html @@ -1,2 +1,2 @@ AnyValueMap | OpenTelemetry SDK

    AnyValueMap is a map from string to AnyValue (attribute value or a nested map)

    -

    Indexable

    +

    Indexable

    diff --git a/interfaces/_opentelemetry_api-logs.LogRecord.html b/interfaces/_opentelemetry_api-logs.LogRecord.html index 8cce79439..3176b0082 100644 --- a/interfaces/_opentelemetry_api-logs.LogRecord.html +++ b/interfaces/_opentelemetry_api-logs.LogRecord.html @@ -1,4 +1,4 @@ -LogRecord | OpenTelemetry SDK
    interface LogRecord {
        attributes?: AnyValueMap;
        body?: AnyValue;
        context?: Context;
        observedTimestamp?: TimeInput;
        severityNumber?: SeverityNumber;
        severityText?: string;
        timestamp?: TimeInput;
    }

    Properties

    attributes? +LogRecord | OpenTelemetry SDK
    interface LogRecord {
        attributes?: AnyValueMap;
        body?: AnyValue;
        context?: Context;
        observedTimestamp?: TimeInput;
        severityNumber?: SeverityNumber;
        severityText?: string;
        timestamp?: TimeInput;
    }

    Properties

    attributes?: AnyValueMap

    Attributes that define the log record.

    -
    body?: AnyValue

    A value containing the body of the log record.

    -
    context?: Context

    The Context associated with the LogRecord.

    -
    observedTimestamp?: TimeInput

    Time when the event was observed by the collection system.

    -
    severityNumber?: SeverityNumber

    Numerical value of the severity.

    -
    severityText?: string

    The severity text.

    -
    timestamp?: TimeInput

    The time when the log record occurred as UNIX Epoch time in nanoseconds.

    -
    +
    body?: AnyValue

    A value containing the body of the log record.

    +
    context?: Context

    The Context associated with the LogRecord.

    +
    observedTimestamp?: TimeInput

    Time when the event was observed by the collection system.

    +
    severityNumber?: SeverityNumber

    Numerical value of the severity.

    +
    severityText?: string

    The severity text.

    +
    timestamp?: TimeInput

    The time when the log record occurred as UNIX Epoch time in nanoseconds.

    +
    diff --git a/interfaces/_opentelemetry_api-logs.Logger.html b/interfaces/_opentelemetry_api-logs.Logger.html index 190e87d92..e8177da17 100644 --- a/interfaces/_opentelemetry_api-logs.Logger.html +++ b/interfaces/_opentelemetry_api-logs.Logger.html @@ -1,3 +1,3 @@ -Logger | OpenTelemetry SDK
    interface Logger {
        emit(logRecord: LogRecord): void;
    }

    Implemented by

    Methods

    emit +Logger | OpenTelemetry SDK
    interface Logger {
        emit(logRecord: LogRecord): void;
    }

    Implemented by

    Methods

    Methods

    +

    Parameters

    Returns void

    diff --git a/interfaces/_opentelemetry_api-logs.LoggerOptions.html b/interfaces/_opentelemetry_api-logs.LoggerOptions.html index 3977a985d..cfa7fdefb 100644 --- a/interfaces/_opentelemetry_api-logs.LoggerOptions.html +++ b/interfaces/_opentelemetry_api-logs.LoggerOptions.html @@ -1,13 +1,13 @@ -LoggerOptions | OpenTelemetry SDK
    interface LoggerOptions {
        includeTraceContext?: boolean;
        schemaUrl?: string;
        scopeAttributes?: Attributes;
    }

    Properties

    includeTraceContext? +LoggerOptions | OpenTelemetry SDK
    interface LoggerOptions {
        includeTraceContext?: boolean;
        schemaUrl?: string;
        scopeAttributes?: Attributes;
    }

    Properties

    includeTraceContext?: boolean

    Specifies whether the Trace Context should automatically be passed on to the LogRecords emitted by the Logger.

    true
     
    -
    schemaUrl?: string

    The schemaUrl of the tracer or instrumentation library

    +
    schemaUrl?: string

    The schemaUrl of the tracer or instrumentation library

    ''
     
    -
    scopeAttributes?: Attributes

    The instrumentation scope attributes to associate with emitted telemetry

    -
    +
    scopeAttributes?: Attributes

    The instrumentation scope attributes to associate with emitted telemetry

    +
    diff --git a/interfaces/_opentelemetry_api-logs.LoggerProvider.html b/interfaces/_opentelemetry_api-logs.LoggerProvider.html index 189e8d3e7..54c472137 100644 --- a/interfaces/_opentelemetry_api-logs.LoggerProvider.html +++ b/interfaces/_opentelemetry_api-logs.LoggerProvider.html @@ -1,9 +1,9 @@ LoggerProvider | OpenTelemetry SDK

    A registry for creating named Loggers.

    -
    interface LoggerProvider {
        getLogger(
            name: string,
            version?: string,
            options?: LoggerOptions,
        ): Logger;
    }

    Implemented by

    Methods

    interface LoggerProvider {
        getLogger(
            name: string,
            version?: string,
            options?: LoggerOptions,
        ): Logger;
    }

    Implemented by

    Methods

    Methods

    • Returns a Logger, creating one if one with the given name, version, and schemaUrl pair is not already created.

      Parameters

      • name: string

        The name of the logger or instrumentation library.

      • Optionalversion: string

        The version of the logger or instrumentation library.

      • Optionaloptions: LoggerOptions

        The options of the logger or instrumentation library.

      Returns Logger

      Logger A Logger with the given name and version

      -
    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Attributes.html b/interfaces/_opentelemetry_api._opentelemetry_api.Attributes.html index 9046dd17a..e611c4b5c 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Attributes.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Attributes.html @@ -1,4 +1,4 @@ Attributes | OpenTelemetry SDK

    Attributes is a map from string to attribute values.

    Note: only the own enumerable keys are counted as valid attribute keys.

    1.3.0

    -

    Indexable

    +

    Indexable

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Baggage.html b/interfaces/_opentelemetry_api._opentelemetry_api.Baggage.html index fe8b7cbd1..95ca5c061 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Baggage.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Baggage.html @@ -2,21 +2,21 @@ Each key of Baggage is associated with exactly one value. Baggage may be used to annotate and enrich telemetry data.

    1.0.0

    -
    interface Baggage {
        clear(): Baggage;
        getAllEntries(): [string, BaggageEntry][];
        getEntry(key: string): undefined | BaggageEntry;
        removeEntries(...key: string[]): Baggage;
        removeEntry(key: string): Baggage;
        setEntry(key: string, entry: BaggageEntry): Baggage;
    }

    Methods

    interface Baggage {
        clear(): Baggage;
        getAllEntries(): [string, BaggageEntry][];
        getEntry(key: string): undefined | BaggageEntry;
        removeEntries(...key: string[]): Baggage;
        removeEntry(key: string): Baggage;
        setEntry(key: string, entry: BaggageEntry): Baggage;
    }

    Methods

    • Returns a new baggage with the entries from the current bag except the removed entries

      +

    Returns undefined | BaggageEntry

    • Returns a new baggage with the entries from the current bag except the removed entries

      Parameters

      • ...key: string[]

        keys identifying the entries to be removed

        -

      Returns Baggage

    • Returns a new baggage with the entries from the current bag except the removed entry

      +

    Returns Baggage

    • Returns a new baggage with the entries from the current bag except the removed entry

      Parameters

      • key: string

        key identifying the entry to be removed

        -

      Returns Baggage

    • Returns a new baggage with the entries from the current bag and the specified entry

      +

    Returns Baggage

    • Returns a new baggage with the entries from the current bag and the specified entry

      Parameters

      • key: string

        string which identifies the baggage entry

      • entry: BaggageEntry

        BaggageEntry for the given key

        -

      Returns Baggage

    +

    Returns Baggage

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.BaggageEntry.html b/interfaces/_opentelemetry_api._opentelemetry_api.BaggageEntry.html index 27e14870a..f41375f4d 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.BaggageEntry.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.BaggageEntry.html @@ -1,7 +1,7 @@ BaggageEntry | OpenTelemetry SDK

    1.0.0

    -
    interface BaggageEntry {
        metadata?: BaggageEntryMetadata;
        value: string;
    }

    Properties

    interface BaggageEntry {
        metadata?: BaggageEntryMetadata;
        value: string;
    }

    Properties

    Properties

    Metadata is an optional string property defined by the W3C baggage specification. It currently has no special meaning defined by the specification.

    -
    value: string

    String value of the BaggageEntry.

    -
    +
    value: string

    String value of the BaggageEntry.

    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.BatchObservableResult.html b/interfaces/_opentelemetry_api._opentelemetry_api.BatchObservableResult.html index 20c8971d1..37b44a69d 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.BatchObservableResult.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.BatchObservableResult.html @@ -1,9 +1,9 @@ BatchObservableResult | OpenTelemetry SDK

    Interface that is being used in batch observable callback function.

    -
    interface BatchObservableResult<
        AttributesTypes extends MetricAttributes = MetricAttributes,
    > {
        observe(
            this: BatchObservableResult<AttributesTypes>,
            metric: Observable<AttributesTypes>,
            value: number,
            attributes?: AttributesTypes,
        ): void;
    }

    Type Parameters

    Methods

    interface BatchObservableResult<
        AttributesTypes extends MetricAttributes = MetricAttributes,
    > {
        observe(
            this: BatchObservableResult<AttributesTypes>,
            metric: Observable<AttributesTypes>,
            value: number,
            attributes?: AttributesTypes,
        ): void;
    }

    Type Parameters

    Methods

    Methods

    +

    Returns void

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.ComponentLoggerOptions.html b/interfaces/_opentelemetry_api._opentelemetry_api.ComponentLoggerOptions.html index a2ba97521..f787bc20b 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.ComponentLoggerOptions.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.ComponentLoggerOptions.html @@ -1,4 +1,4 @@ ComponentLoggerOptions | OpenTelemetry SDK

    Defines options for ComponentLogger

    1.0.0

    -
    interface ComponentLoggerOptions {
        namespace: string;
    }

    Properties

    Properties

    namespace: string
    +
    interface ComponentLoggerOptions {
        namespace: string;
    }

    Properties

    Properties

    namespace: string
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Context.html b/interfaces/_opentelemetry_api._opentelemetry_api.Context.html index 8055ec15c..968c8b9e2 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Context.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Context.html @@ -1,14 +1,14 @@ Context | OpenTelemetry SDK

    1.0.0

    -
    interface Context {
        deleteValue(key: symbol): Context;
        getValue(key: symbol): unknown;
        setValue(key: symbol, value: unknown): Context;
    }

    Methods

    interface Context {
        deleteValue(key: symbol): Context;
        getValue(key: symbol): unknown;
        setValue(key: symbol, value: unknown): Context;
    }

    Methods

    • Return a new context which inherits from this context but does not contain a value for the given key.

      Parameters

      • key: symbol

        context key for which to clear a value

        -

      Returns Context

    • Get a value from the context.

      +

    Returns Context

    • Get a value from the context.

      Parameters

      • key: symbol

        key which identifies a context value

        -

      Returns unknown

    • Create a new context which inherits from this context and has +

    Returns unknown

    • Create a new context which inherits from this context and has the given key set to the given value.

      Parameters

      • key: symbol

        context key for which to set the value

      • value: unknown

        value to set for the given key

        -

      Returns Context

    +

    Returns Context

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.ContextManager.html b/interfaces/_opentelemetry_api._opentelemetry_api.ContextManager.html index 38ad983aa..7937d41b5 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.ContextManager.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.ContextManager.html @@ -1,18 +1,18 @@ ContextManager | OpenTelemetry SDK

    1.0.0

    -
    interface ContextManager {
        active(): Context;
        bind<T>(context?: Context, target: T): T;
        disable(): this;
        enable(): this;
        with<A extends unknown[], F extends (...args: A) => ReturnType<F>>(
            context: Context,
            fn: F,
            thisArg?: ThisParameterType<F>,
            ...args: A,
        ): ReturnType<F>;
    }

    Implemented by

    Methods

    interface ContextManager {
        active(): Context;
        bind<T>(context?: Context, target: T): T;
        disable(): this;
        enable(): this;
        with<A extends unknown[], F extends (...args: A) => ReturnType<F>>(
            context: Context,
            fn: F,
            thisArg?: ThisParameterType<F>,
            ...args: A,
        ): ReturnType<F>;
    }

    Implemented by

    Methods

    • Bind an object as the current context (or a specific one)

      Type Parameters

      • T

      Parameters

      • Optionalcontext: Context

        Optionally specify the context which you want to assign

      • target: T

        Any object to which a context need to be set

        -

      Returns T

    • Run the fn callback with object set as the current active context

      +

    Returns T

    • Run the fn callback with object set as the current active context

      Type Parameters

      • A extends unknown[]
      • F extends (...args: A) => ReturnType<F>

      Parameters

      • context: Context

        Any object to set as the current active context

      • fn: F

        A callback to be immediately run within a specific context

      • OptionalthisArg: ThisParameterType<F>

        optional receiver to be used for calling fn

      • ...args: A

        optional arguments forwarded to fn

        -

      Returns ReturnType<F>

    +

    Returns ReturnType<F>

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Counter.html b/interfaces/_opentelemetry_api._opentelemetry_api.Counter.html index d87e9b224..705491185 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Counter.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Counter.html @@ -10,6 +10,6 @@ instrument.

  • count the number of checkpoints run.
  • count the number of 5xx errors.
    1. 1.3.0

      -
      interface Counter<AttributesTypes extends MetricAttributes = MetricAttributes> {
          add(
              value: number,
              attributes?: AttributesTypes,
              context?: Context,
          ): void;
      }

      Type Parameters

      Methods

      add +
      interface Counter<AttributesTypes extends MetricAttributes = MetricAttributes> {
          add(
              value: number,
              attributes?: AttributesTypes,
              context?: Context,
          ): void;
      }

      Type Parameters

      Methods

      Methods

      +

      Parameters

      Returns void

      diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.DiagLogger.html b/interfaces/_opentelemetry_api._opentelemetry_api.DiagLogger.html index 0a46a7a69..77ece172f 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.DiagLogger.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.DiagLogger.html @@ -7,7 +7,7 @@ API provided implementations include :-

    2. a general Console DiagConsoleLogger version.
    3. 1.0.0

      -
      interface DiagLogger {
          debug: DiagLogFunction;
          error: DiagLogFunction;
          info: DiagLogFunction;
          verbose: DiagLogFunction;
          warn: DiagLogFunction;
      }

      Implemented by

      Properties

      interface DiagLogger {
          debug: DiagLogFunction;
          error: DiagLogFunction;
          info: DiagLogFunction;
          verbose: DiagLogFunction;
          warn: DiagLogFunction;
      }

      Implemented by

      Properties

      debug error info verbose @@ -16,15 +16,15 @@ API provided implementations include :-

      Information logged at this level may include diagnostic details that would help identify a failure scenario. For example: Logging the order of execution of async operations.

      -

      Log an error scenario that was not expected and caused the requested operation to fail.

      -

      Log a general informational message, this should not affect functionality. +

      Log an error scenario that was not expected and caused the requested operation to fail.

      +

      Log a general informational message, this should not affect functionality. This is also the default logging level so this should NOT be used for logging debugging level information.

      -

      Log a detailed (verbose) trace level logging that can be used to identify failures +

      Log a detailed (verbose) trace level logging that can be used to identify failures where debug level logging would be insufficient, this level of tracing can include input and output parameters and as such may include PII information passing through the API. As such it is recommended that this level of tracing should not be enabled in a production environment.

      -

      Log a warning scenario to inform the developer of an issues that should be investigated. +

      Log a warning scenario to inform the developer of an issues that should be investigated. The requested operation may or may not have succeeded or completed.

      -
      +
      diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.DiagLoggerOptions.html b/interfaces/_opentelemetry_api._opentelemetry_api.DiagLoggerOptions.html index c7bb92add..1b5e63cd1 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.DiagLoggerOptions.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.DiagLoggerOptions.html @@ -1,9 +1,9 @@ DiagLoggerOptions | OpenTelemetry SDK

      1.4.1

      -
      interface DiagLoggerOptions {
          logLevel?: DiagLogLevel;
          suppressOverrideMessage?: boolean;
      }

      Properties

      interface DiagLoggerOptions {
          logLevel?: DiagLogLevel;
          suppressOverrideMessage?: boolean;
      }

      Properties

      logLevel?: DiagLogLevel

      The DiagLogLevel used to filter logs sent to the logger.

      DiagLogLevel.INFO
       
      -
      suppressOverrideMessage?: boolean

      Setting this value to true will suppress the warning message normally emitted when registering a logger when another logger is already registered.

      -
      +
      suppressOverrideMessage?: boolean

      Setting this value to true will suppress the warning message normally emitted when registering a logger when another logger is already registered.

      +
      diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Gauge.html b/interfaces/_opentelemetry_api._opentelemetry_api.Gauge.html index 17e84bfb4..51925c979 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Gauge.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Gauge.html @@ -1,4 +1,4 @@ Gauge | OpenTelemetry SDK

      1.9.0

      -
      interface Gauge<AttributesTypes extends MetricAttributes = MetricAttributes> {
          record(
              value: number,
              attributes?: AttributesTypes,
              context?: Context,
          ): void;
      }

      Type Parameters

      Methods

      interface Gauge<AttributesTypes extends MetricAttributes = MetricAttributes> {
          record(
              value: number,
              attributes?: AttributesTypes,
              context?: Context,
          ): void;
      }

      Type Parameters

      Methods

      Methods

      +

      Parameters

      Returns void

      diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Histogram.html b/interfaces/_opentelemetry_api._opentelemetry_api.Histogram.html index 6396e0556..4aa89c263 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Histogram.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Histogram.html @@ -1,4 +1,4 @@ Histogram | OpenTelemetry SDK

      1.3.0

      -
      interface Histogram<AttributesTypes extends MetricAttributes = MetricAttributes> {
          record(
              value: number,
              attributes?: AttributesTypes,
              context?: Context,
          ): void;
      }

      Type Parameters

      Methods

      interface Histogram<AttributesTypes extends MetricAttributes = MetricAttributes> {
          record(
              value: number,
              attributes?: AttributesTypes,
              context?: Context,
          ): void;
      }

      Type Parameters

      Methods

      Methods

      +

      Parameters

      Returns void

      diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Link.html b/interfaces/_opentelemetry_api._opentelemetry_api.Link.html index 23946aaa9..2e729ab25 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Link.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Link.html @@ -14,10 +14,10 @@ initiated on service provider side so two traces (from Client and from Service Provider) can be correlated.

    1.0.0

    -
    interface Link {
        attributes?: Attributes;
        context: SpanContext;
        droppedAttributesCount?: number;
    }

    Properties

    interface Link {
        attributes?: Attributes;
        context: SpanContext;
        droppedAttributesCount?: number;
    }

    Properties

    attributes?: Attributes

    A set of SpanAttributes on the link.

    -
    context: SpanContext

    The SpanContext of a linked span.

    -
    droppedAttributesCount?: number

    Count of attributes of the link that were dropped due to collection limits

    -
    +
    context: SpanContext

    The SpanContext of a linked span.

    +
    droppedAttributesCount?: number

    Count of attributes of the link that were dropped due to collection limits

    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Meter.html b/interfaces/_opentelemetry_api._opentelemetry_api.Meter.html index b3645b0d9..f7052f83c 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Meter.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Meter.html @@ -3,7 +3,7 @@ or raw values (Histogram) in which the aggregation and attributes for the exported metric are deferred.

    1.3.0

    -
    interface Meter {
        addBatchObservableCallback<
            AttributesTypes extends Attributes = Attributes,
        >(
            callback: BatchObservableCallback<AttributesTypes>,
            observables: Observable<AttributesTypes>[],
        ): void;
        createCounter<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): Counter<AttributesTypes>;
        createGauge<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): Gauge<AttributesTypes>;
        createHistogram<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): Histogram<AttributesTypes>;
        createObservableCounter<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): ObservableCounter<AttributesTypes>;
        createObservableGauge<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): ObservableGauge<AttributesTypes>;
        createObservableUpDownCounter<
            AttributesTypes extends Attributes = Attributes,
        >(
            name: string,
            options?: MetricOptions,
        ): ObservableUpDownCounter<AttributesTypes>;
        createUpDownCounter<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): UpDownCounter<AttributesTypes>;
        removeBatchObservableCallback<
            AttributesTypes extends Attributes = Attributes,
        >(
            callback: BatchObservableCallback<AttributesTypes>,
            observables: Observable<AttributesTypes>[],
        ): void;
    }
    interface Meter {
        addBatchObservableCallback<
            AttributesTypes extends Attributes = Attributes,
        >(
            callback: BatchObservableCallback<AttributesTypes>,
            observables: Observable<AttributesTypes>[],
        ): void;
        createCounter<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): Counter<AttributesTypes>;
        createGauge<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): Gauge<AttributesTypes>;
        createHistogram<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): Histogram<AttributesTypes>;
        createObservableCounter<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): ObservableCounter<AttributesTypes>;
        createObservableGauge<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): ObservableGauge<AttributesTypes>;
        createObservableUpDownCounter<
            AttributesTypes extends Attributes = Attributes,
        >(
            name: string,
            options?: MetricOptions,
        ): ObservableUpDownCounter<AttributesTypes>;
        createUpDownCounter<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): UpDownCounter<AttributesTypes>;
        removeBatchObservableCallback<
            AttributesTypes extends Attributes = Attributes,
        >(
            callback: BatchObservableCallback<AttributesTypes>,
            observables: Observable<AttributesTypes>[],
        ): void;
    }

    Methods

    addBatchObservableCallback createCounter createGauge createHistogram @@ -21,30 +21,30 @@ Measurements of observables that are not associated observed in the callback are dropped.

    Type Parameters

    Parameters

    Returns void

    Returns void

    Returns Counter<AttributesTypes>

    Returns Gauge<AttributesTypes>

    Returns Histogram<AttributesTypes>

    Returns ObservableCounter<AttributesTypes>

    Returns ObservableGauge<AttributesTypes>

    Returns ObservableUpDownCounter<AttributesTypes>

    Returns UpDownCounter<AttributesTypes>

    +

    Returns void

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.MeterOptions.html b/interfaces/_opentelemetry_api._opentelemetry_api.MeterOptions.html index 270935e2f..7eac36e75 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.MeterOptions.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.MeterOptions.html @@ -1,5 +1,5 @@ MeterOptions | OpenTelemetry SDK

    An interface describes additional metadata of a meter.

    1.3.0

    -
    interface MeterOptions {
        schemaUrl?: string;
    }

    Properties

    interface MeterOptions {
        schemaUrl?: string;
    }

    Properties

    Properties

    schemaUrl?: string

    The schemaUrl of the meter or instrumentation library

    -
    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.MeterProvider.html b/interfaces/_opentelemetry_api._opentelemetry_api.MeterProvider.html index c52480fe5..a55cccbc3 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.MeterProvider.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.MeterProvider.html @@ -1,10 +1,10 @@ MeterProvider | OpenTelemetry SDK

    A registry for creating named Meters.

    1.3.0

    -
    interface MeterProvider {
        getMeter(name: string, version?: string, options?: MeterOptions): Meter;
    }

    Implemented by

    Methods

    interface MeterProvider {
        getMeter(name: string, version?: string, options?: MeterOptions): Meter;
    }

    Implemented by

    Methods

    Methods

    • Returns a Meter, creating one if one with the given name, version, and schemaUrl pair is not already created.

      Parameters

      • name: string

        The name of the meter or instrumentation library.

      • Optionalversion: string

        The version of the meter or instrumentation library.

      • Optionaloptions: MeterOptions

        The options of the meter or instrumentation library.

      Returns Meter

      Meter A Meter with the given name and version

      -
    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.MetricAdvice.html b/interfaces/_opentelemetry_api._opentelemetry_api.MetricAdvice.html index a461423b8..552084c0e 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.MetricAdvice.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.MetricAdvice.html @@ -1,6 +1,6 @@ MetricAdvice | OpenTelemetry SDK

    Advisory options influencing aggregation configuration parameters.

    1.7.0

    -
    interface MetricAdvice {
        explicitBucketBoundaries?: number[];
    }
    interface MetricAdvice {
        explicitBucketBoundaries?: number[];
    }

    Properties

    explicitBucketBoundaries?: number[]

    Hint the explicit bucket boundaries for SDK if the metric is been aggregated with a HistogramAggregator.

    -
    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.MetricOptions.html b/interfaces/_opentelemetry_api._opentelemetry_api.MetricOptions.html index 304b4f462..347f83c22 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.MetricOptions.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.MetricOptions.html @@ -1,19 +1,19 @@ MetricOptions | OpenTelemetry SDK

    Options needed for metric creation

    1.3.0

    -
    interface MetricOptions {
        advice?: MetricAdvice;
        description?: string;
        unit?: string;
        valueType?: ValueType;
    }

    Properties

    interface MetricOptions {
        advice?: MetricAdvice;
        description?: string;
        unit?: string;
        valueType?: ValueType;
    }

    Properties

    advice?: MetricAdvice

    The advice influencing aggregation configuration parameters.

    1.7.0

    -
    description?: string

    The description of the Metric.

    +
    description?: string

    The description of the Metric.

    ''
     
    -
    unit?: string

    The unit of the Metric values.

    +
    unit?: string

    The unit of the Metric values.

    ''
     
    -
    valueType?: ValueType

    Indicates the type of the recorded value.

    +
    valueType?: ValueType

    Indicates the type of the recorded value.

    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Observable.html b/interfaces/_opentelemetry_api._opentelemetry_api.Observable.html index bcd610f39..280141a37 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Observable.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Observable.html @@ -1,7 +1,7 @@ Observable | OpenTelemetry SDK

    1.3.0

    -
    interface Observable<
        AttributesTypes extends MetricAttributes = MetricAttributes,
    > {
        addCallback(callback: ObservableCallback<AttributesTypes>): void;
        removeCallback(callback: ObservableCallback<AttributesTypes>): void;
    }

    Type Parameters

    Methods

    interface Observable<
        AttributesTypes extends MetricAttributes = MetricAttributes,
    > {
        addCallback(callback: ObservableCallback<AttributesTypes>): void;
        removeCallback(callback: ObservableCallback<AttributesTypes>): void;
    }

    Type Parameters

    Methods

    +

    Parameters

    Returns void

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.ObservableResult.html b/interfaces/_opentelemetry_api._opentelemetry_api.ObservableResult.html index 4437de83c..69692c9d7 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.ObservableResult.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.ObservableResult.html @@ -1,9 +1,9 @@ ObservableResult | OpenTelemetry SDK

    Interface that is being used in callback function for Observable Metric.

    1.3.0

    -
    interface ObservableResult<
        AttributesTypes extends MetricAttributes = MetricAttributes,
    > {
        observe(
            this: ObservableResult<AttributesTypes>,
            value: number,
            attributes?: AttributesTypes,
        ): void;
    }

    Type Parameters

    Methods

    interface ObservableResult<
        AttributesTypes extends MetricAttributes = MetricAttributes,
    > {
        observe(
            this: ObservableResult<AttributesTypes>,
            value: number,
            attributes?: AttributesTypes,
        ): void;
    }

    Type Parameters

    Methods

    Methods

    +

    Returns void

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Sampler.html b/interfaces/_opentelemetry_api._opentelemetry_api.Sampler.html index 13b898a46..c4e340269 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Sampler.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Sampler.html @@ -3,7 +3,7 @@ This interface represent a sampler. Sampling is a mechanism to control the noise and overhead introduced by OpenTelemetry by reducing the number of samples of traces collected and sent to the backend.

    1.0.0

    -
    interface Sampler {
        shouldSample(
            context: Context,
            traceId: string,
            spanName: string,
            spanKind: SpanKind,
            attributes: Attributes,
            links: Link[],
        ): SamplingResult;
        toString(): string;
    }

    Methods

    interface Sampler {
        shouldSample(
            context: Context,
            traceId: string,
            spanName: string,
            spanKind: SpanKind,
            attributes: Attributes,
            links: Link[],
        ): SamplingResult;
        toString(): string;
    }

    Methods

    • Checks whether span needs to be created and tracked.

      Parameters

      • context: Context

        Parent Context which may contain a span.

        @@ -16,5 +16,5 @@ span to be created starts a new trace.

      • links: Link[]

        Collection of links that will be associated with the Span to be created. Typically useful for batch operations.

      Returns SamplingResult

      a SamplingResult.

      -
    • Returns the sampler name or short description with the configuration.

      -

      Returns string

    +
    • Returns the sampler name or short description with the configuration.

      +

      Returns string

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.SamplingResult.html b/interfaces/_opentelemetry_api._opentelemetry_api.SamplingResult.html index aa4727657..c0da9dcd7 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.SamplingResult.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.SamplingResult.html @@ -2,15 +2,15 @@ A sampling result contains a decision for a Span and additional attributes the sampler would like to added to the Span.

    1.0.0

    -
    interface SamplingResult {
        attributes?: Readonly<Attributes>;
        decision: SamplingDecision;
        traceState?: TraceState;
    }

    Properties

    interface SamplingResult {
        attributes?: Readonly<Attributes>;
        decision: SamplingDecision;
        traceState?: TraceState;
    }

    Properties

    attributes?: Readonly<Attributes>

    The list of attributes returned by SamplingResult MUST be immutable. Caller may call Sampler.shouldSample any number of times and can safely cache the returned value.

    -

    A sampling decision, refer to SamplingDecision for details.

    -
    traceState?: TraceState

    A TraceState that will be associated with the Span through +

    A sampling decision, refer to SamplingDecision for details.

    +
    traceState?: TraceState

    A TraceState that will be associated with the Span through the new SpanContext. Samplers SHOULD return the TraceState from the passed-in Context if they do not intend to change it. Leaving the value undefined will also leave the TraceState unchanged.

    -
    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Span.html b/interfaces/_opentelemetry_api._opentelemetry_api.Span.html index 6cc6f1b78..ce7574972 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Span.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Span.html @@ -5,7 +5,7 @@ in-process function calls to sub-components. A Trace has a single, top-level may have children.

    Spans are created by the Tracer.startSpan method.

    1.0.0

    -
    interface Span {
        addEvent(
            name: string,
            attributesOrStartTime?: Attributes | TimeInput,
            startTime?: TimeInput,
        ): this;
        addLink(link: Link): this;
        addLinks(links: Link[]): this;
        end(endTime?: TimeInput): void;
        isRecording(): boolean;
        recordException(exception: Exception, time?: TimeInput): void;
        setAttribute(key: string, value: AttributeValue): this;
        setAttributes(attributes: Attributes): this;
        setStatus(status: SpanStatus): this;
        spanContext(): SpanContext;
        updateName(name: string): this;
    }

    Methods

    interface Span {
        addEvent(
            name: string,
            attributesOrStartTime?: Attributes | TimeInput,
            startTime?: TimeInput,
        ): this;
        addLink(link: Link): this;
        addLinks(links: Link[]): this;
        end(endTime?: TimeInput): void;
        isRecording(): boolean;
        recordException(exception: Exception, time?: TimeInput): void;
        setAttribute(key: string, value: AttributeValue): this;
        setAttributes(attributes: Attributes): this;
        setStatus(status: SpanStatus): this;
        spanContext(): SpanContext;
        updateName(name: string): this;
    }

    Methods

    addEvent addLink addLinks end @@ -22,49 +22,49 @@ may have children.

    associated with this event. Can be also a start time if type is {@type TimeInput} and 3rd param is undefined

  • OptionalstartTime: TimeInput

    start time of the event.

    -
  • Returns this

    • Adds a single link to the span.

      +

    Returns this

    • Adds a single link to the span.

      Links added after the creation will not affect the sampling decision. It is preferred span links be added at span creation.

      Parameters

      • link: Link

        the link to add.

        -

      Returns this

    • Adds multiple links to the span.

      +

    Returns this

    • Adds multiple links to the span.

      Links added after the creation will not affect the sampling decision. It is preferred span links be added at span creation.

      Parameters

      • links: Link[]

        the links to add.

        -

      Returns this

    • Marks the end of Span execution.

      +

    Returns this

    • Marks the end of Span execution.

      Call to End of a Span MUST not have any effects on child spans. Those may still be running and can be ended later.

      Do not return this. The Span generally should not be used after it is ended so chaining is not desired in this context.

      Parameters

      • OptionalendTime: TimeInput

        the time to set as Span's end time. If not provided, use the current time as the span's end time.

        -

      Returns void

    • Returns the flag whether this span will be recorded.

      +

    Returns void

    • Returns the flag whether this span will be recorded.

      Returns boolean

      true if this Span is active and recording information like events with the AddEvent operation and attributes using setAttributes.

      -
    • Sets exception as a span event

      Parameters

      • exception: Exception

        the exception the only accepted values are string or Error

      • Optionaltime: TimeInput

        the time to set as Span's event time. If not provided, use the current time.

        -

      Returns void

    • Sets an attribute to the span.

      +

    Returns void

    • Sets an attribute to the span.

      Sets a single Attribute with the key and value passed as arguments.

      Parameters

      • key: string

        the key for this attribute.

      • value: AttributeValue

        the value for this attribute. Setting a value null or undefined is invalid and will result in undefined behavior.

        -

      Returns this

    • Sets attributes to the span.

      +

    Returns this

    • Sets attributes to the span.

      Parameters

      • attributes: Attributes

        the attributes that will be added. null or undefined attribute values are invalid and will result in undefined behavior.

        -

      Returns this

    • Sets a status to the span. If used, this will override the default Span +

    Returns this

    • Sets a status to the span. If used, this will override the default Span status. Default is SpanStatusCode.UNSET. SetStatus overrides the value of previous calls to SetStatus on the Span.

      Parameters

      Returns this

    Returns this

    • Returns the SpanContext object associated with this Span.

      Get an immutable, serializable identifier for this span that can be used to create new child spans. Returned SpanContext is usable even after the span ends.

      Returns SpanContext

      the SpanContext object associated with this Span.

      -
    • Updates the Span name.

      +
    • Updates the Span name.

      This will override the name provided via Tracer.startSpan.

      Upon this update, any sampling behavior based on Span name will depend on the implementation.

      Parameters

      • name: string

        the Span name.

        -

      Returns this

    +

    Returns this

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.SpanContext.html b/interfaces/_opentelemetry_api._opentelemetry_api.SpanContext.html index 195651e20..7e6471d2d 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.SpanContext.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.SpanContext.html @@ -1,26 +1,26 @@ SpanContext | OpenTelemetry SDK

    A SpanContext represents the portion of a Span which must be serialized and propagated along side of a Baggage.

    1.0.0

    -
    interface SpanContext {
        isRemote?: boolean;
        spanId: string;
        traceFlags: number;
        traceId: string;
        traceState?: TraceState;
    }

    Properties

    interface SpanContext {
        isRemote?: boolean;
        spanId: string;
        traceFlags: number;
        traceId: string;
        traceState?: TraceState;
    }

    Properties

    isRemote?: boolean

    Only true if the SpanContext was propagated from a remote parent.

    -
    spanId: string

    The ID of the Span. It is globally unique with practically sufficient +

    spanId: string

    The ID of the Span. It is globally unique with practically sufficient probability by being made as 8 randomly generated bytes, encoded as a 16 lowercase hex characters corresponding to 64 bits.

    -
    traceFlags: number

    Trace flags to propagate.

    +
    traceFlags: number

    Trace flags to propagate.

    It is represented as 1 byte (bitmap). Bit to represent whether trace is sampled or not. When set, the least significant bit documents that the caller may have recorded trace data. A caller who does not record trace data out-of-band leaves this flag unset.

    see TraceFlags for valid flag values.

    -
    traceId: string

    The ID of the trace that this span belongs to. It is worldwide unique +

    traceId: string

    The ID of the trace that this span belongs to. It is worldwide unique with practically sufficient probability by being made as 16 randomly generated bytes, encoded as a 32 lowercase hex characters corresponding to 128 bits.

    -
    traceState?: TraceState

    Tracing-system-specific info to propagate.

    +
    traceState?: TraceState

    Tracing-system-specific info to propagate.

    The tracestate field value is a list as defined below. The list is a series of list-members separated by commas ,, and a list-member is a key/value pair separated by an equals sign =. Spaces and horizontal tabs @@ -32,4 +32,4 @@ Single tracing system (generic format): tracestate: rojo=00f067aa0ba902b7 Multiple tracing systems (with different formatting): tracestate: rojo=00f067aa0ba902b7,congo=t61rcWkgMzE

    -
    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.SpanOptions.html b/interfaces/_opentelemetry_api._opentelemetry_api.SpanOptions.html index cf6f788e4..56e2f1fd3 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.SpanOptions.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.SpanOptions.html @@ -1,14 +1,14 @@ SpanOptions | OpenTelemetry SDK

    Options needed for span creation

    1.0.0

    -
    interface SpanOptions {
        attributes?: Attributes;
        kind?: SpanKind;
        links?: Link[];
        root?: boolean;
        startTime?: TimeInput;
    }

    Hierarchy (View Summary)

    Properties

    interface SpanOptions {
        attributes?: Attributes;
        kind?: SpanKind;
        links?: Link[];
        root?: boolean;
        startTime?: TimeInput;
    }

    Hierarchy (View Summary)

    Properties

    attributes?: Attributes

    A span's attributes

    -
    kind?: SpanKind

    The SpanKind of a span

    +
    kind?: SpanKind

    The SpanKind of a span

    links?: Link[]

    Links span to other spans

    -
    root?: boolean

    The new span should be a root span. (Ignore parent from context).

    -
    startTime?: TimeInput

    A manually specified start time for the created Span object.

    -
    +
    links?: Link[]

    Links span to other spans

    +
    root?: boolean

    The new span should be a root span. (Ignore parent from context).

    +
    startTime?: TimeInput

    A manually specified start time for the created Span object.

    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.SpanStatus.html b/interfaces/_opentelemetry_api._opentelemetry_api.SpanStatus.html index 50d25e09e..0a7b78515 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.SpanStatus.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.SpanStatus.html @@ -1,6 +1,6 @@ SpanStatus | OpenTelemetry SDK

    1.0.0

    -
    interface SpanStatus {
        code: SpanStatusCode;
        message?: string;
    }

    Properties

    interface SpanStatus {
        code: SpanStatusCode;
        message?: string;
    }

    Properties

    Properties

    The status code of this message.

    -
    message?: string

    A developer-facing error message.

    -
    +
    message?: string

    A developer-facing error message.

    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.TextMapGetter.html b/interfaces/_opentelemetry_api._opentelemetry_api.TextMapGetter.html index 167c09d20..011ff490e 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.TextMapGetter.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.TextMapGetter.html @@ -1,8 +1,8 @@ TextMapGetter | OpenTelemetry SDK

    A getter is specified by the caller to define a specific method to get the value of a key from a carrier.

    1.0.0

    -
    interface TextMapGetter<Carrier = any> {
        get(carrier: Carrier, key: string): undefined | string | string[];
        keys(carrier: Carrier): string[];
    }

    Type Parameters

    • Carrier = any

    Methods

    get +
    interface TextMapGetter<Carrier = any> {
        get(carrier: Carrier, key: string): undefined | string | string[];
        keys(carrier: Carrier): string[];
    }

    Type Parameters

    • Carrier = any

    Methods

    Methods

    +

    Parameters

    Returns undefined | string | string[]

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.TextMapPropagator.html b/interfaces/_opentelemetry_api._opentelemetry_api.TextMapPropagator.html index 08fb7ae5e..834fd7730 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.TextMapPropagator.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.TextMapPropagator.html @@ -7,7 +7,7 @@ headers.

    usually implemented via library-specific request interceptors, where the client-side injects values and the server-side extracts them.

    1.0.0

    -
    interface TextMapPropagator<Carrier = any> {
        extract(
            context: Context,
            carrier: Carrier,
            getter: TextMapGetter<Carrier>,
        ): Context;
        fields(): string[];
        inject(
            context: Context,
            carrier: Carrier,
            setter: TextMapSetter<Carrier>,
        ): void;
    }

    Type Parameters

    • Carrier = any

    Implemented by

    Methods

    interface TextMapPropagator<Carrier = any> {
        extract(
            context: Context,
            carrier: Carrier,
            getter: TextMapGetter<Carrier>,
        ): Context;
        fields(): string[];
        inject(
            context: Context,
            carrier: Carrier,
            setter: TextMapSetter<Carrier>,
        ): void;
    }

    Type Parameters

    • Carrier = any

    Implemented by

    Methods

    • Given a Context and a carrier, extract context values from a @@ -19,8 +19,8 @@ the wire.

      headers.

    • getter: TextMapGetter<Carrier>

      an optional TextMapGetter. If undefined, keys will be all own properties, and keys will be accessed by direct object access.

      -

    Returns Context

    Returns Context

    +

    Returns void

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.TextMapSetter.html b/interfaces/_opentelemetry_api._opentelemetry_api.TextMapSetter.html index 4b8201111..ce73e34b3 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.TextMapSetter.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.TextMapSetter.html @@ -1,11 +1,11 @@ TextMapSetter | OpenTelemetry SDK

    A setter is specified by the caller to define a specific method to set key/value pairs on the carrier within a propagator

    1.0.0

    -
    interface TextMapSetter<Carrier = any> {
        set(carrier: Carrier, key: string, value: string): void;
    }

    Type Parameters

    • Carrier = any

    Methods

    set +
    interface TextMapSetter<Carrier = any> {
        set(carrier: Carrier, key: string, value: string): void;
    }

    Type Parameters

    • Carrier = any

    Methods

    Methods

    • Callback used to set a key/value pair on an object.

      Should be called by the propagator each time a key/value pair should be set, and should set that key/value pair on the propagator.

      Parameters

      • carrier: Carrier

        object or class which carries key/value pairs

      • key: string

        string key to modify

      • value: string

        value to be set to the key on the carrier

        -

      Returns void

    +

    Returns void

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.TraceState.html b/interfaces/_opentelemetry_api._opentelemetry_api.TraceState.html index 9df0126a4..1e5bd48b4 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.TraceState.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.TraceState.html @@ -1,5 +1,5 @@ TraceState | OpenTelemetry SDK

    1.0.0

    -
    interface TraceState {
        get(key: string): undefined | string;
        serialize(): string;
        set(key: string, value: string): TraceState;
        unset(key: string): TraceState;
    }

    Implemented by

    Methods

    get +
    interface TraceState {
        get(key: string): undefined | string;
        serialize(): string;
        set(key: string, value: string): TraceState;
        unset(key: string): TraceState;
    }

    Implemented by

    Methods

    get serialize set unset @@ -8,18 +8,18 @@ this map contains no mapping for the key.

    Parameters

    • key: string

      with which the specified value is to be associated.

    Returns undefined | string

    the value to which the specified key is mapped, or undefined if this map contains no mapping for the key.

    -
    • Serializes the TraceState to a list as defined below. The list is a +

    • Serializes the TraceState to a list as defined below. The list is a series of list-members separated by commas ,, and a list-member is a key/value pair separated by an equals sign =. Spaces and horizontal tabs surrounding list-members are ignored. There can be a maximum of 32 list-members in a list.

      Returns string

      the serialized string.

      -
    • Create a new TraceState which inherits from this TraceState and has the given key set. The new entry will always be added in the front of the list of states.

      Parameters

      • key: string

        key of the TraceState entry.

      • value: string

        value of the TraceState entry.

        -

      Returns TraceState

    • Return a new TraceState which inherits from this TraceState but does not +

    Returns TraceState

    • Return a new TraceState which inherits from this TraceState but does not contain the given key.

      Parameters

      • key: string

        the key for the TraceState entry to be removed.

        -

      Returns TraceState

    +

    Returns TraceState

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.Tracer.html b/interfaces/_opentelemetry_api._opentelemetry_api.Tracer.html index de3240bea..d8e4f5d83 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.Tracer.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.Tracer.html @@ -1,6 +1,6 @@ Tracer | OpenTelemetry SDK

    Tracer provides an interface for creating Spans.

    1.0.0

    -
    interface Tracer {
        startActiveSpan<F extends (span: Span) => unknown>(
            name: string,
            fn: F,
        ): ReturnType<F>;
        startActiveSpan<F extends (span: Span) => unknown>(
            name: string,
            options: SpanOptions,
            fn: F,
        ): ReturnType<F>;
        startActiveSpan<F extends (span: Span) => unknown>(
            name: string,
            options: SpanOptions,
            context: Context,
            fn: F,
        ): ReturnType<F>;
        startSpan(name: string, options?: SpanOptions, context?: Context): Span;
    }

    Implemented by

    interface Tracer {
        startActiveSpan<F extends (span: Span) => unknown>(
            name: string,
            fn: F,
        ): ReturnType<F>;
        startActiveSpan<F extends (span: Span) => unknown>(
            name: string,
            options: SpanOptions,
            fn: F,
        ): ReturnType<F>;
        startActiveSpan<F extends (span: Span) => unknown>(
            name: string,
            options: SpanOptions,
            context: Context,
            fn: F,
        ): ReturnType<F>;
        startSpan(name: string, options?: SpanOptions, context?: Context): Span;
    }

    Implemented by

    Methods

    • Starts a new Span and calls the given function passing it the created span as first argument. @@ -15,7 +15,7 @@ for the duration of the function call.

      const span = tracer.startActiveSpan('op', span => {
      try {
      do some work
      return span;
      } catch (err) {
      span.setStatus({
      code: SpanStatusCode.ERROR,
      message: err.message,
      });
      throw err;
      }
      });
      do some more work
      span.end();
      -
  • Type Parameters

    • F extends (span: Span) => unknown

    Parameters

    Returns ReturnType<F>

  • Type Parameters

    • F extends (span: Span) => unknown

    Parameters

    Returns ReturnType<F>

  • Type Parameters

    • F extends (span: Span) => unknown

    Parameters

    Returns ReturnType<F>

  • Type Parameters

    • F extends (span: Span) => unknown

    Parameters

    Returns ReturnType<F>

    • Starts a new Span. Start the span without setting it on context.

      This method do NOT modify the current Context.

      Parameters

      • name: string

        The name of the span

      • Optionaloptions: SpanOptions

        SpanOptions used for span creation

        @@ -24,4 +24,4 @@ for the duration of the function call.

        const span = tracer.startSpan('op');
        span.setAttribute('key', 'value');
        span.end();
        -
    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.TracerDelegator.html b/interfaces/_opentelemetry_api._opentelemetry_api.TracerDelegator.html index 989600680..d7c0ff133 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.TracerDelegator.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.TracerDelegator.html @@ -1,3 +1,3 @@ TracerDelegator | OpenTelemetry SDK

    1.0.3

    -
    interface TracerDelegator {
        getDelegateTracer(
            name: string,
            version?: string,
            options?: TracerOptions,
        ): undefined | Tracer;
    }

    Methods

    +
    interface TracerDelegator {
        getDelegateTracer(
            name: string,
            version?: string,
            options?: TracerOptions,
        ): undefined | Tracer;
    }

    Methods

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.TracerOptions.html b/interfaces/_opentelemetry_api._opentelemetry_api.TracerOptions.html index e01567d9b..5fbc5575b 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.TracerOptions.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.TracerOptions.html @@ -1,5 +1,5 @@ TracerOptions | OpenTelemetry SDK

    An interface describes additional metadata of a tracer.

    1.3.0

    -
    interface TracerOptions {
        schemaUrl?: string;
    }

    Properties

    interface TracerOptions {
        schemaUrl?: string;
    }

    Properties

    Properties

    schemaUrl?: string

    The schemaUrl of the tracer or instrumentation library

    -
    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.TracerProvider.html b/interfaces/_opentelemetry_api._opentelemetry_api.TracerProvider.html index 6e94d1ef9..749a5c100 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.TracerProvider.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.TracerProvider.html @@ -1,6 +1,6 @@ TracerProvider | OpenTelemetry SDK

    A registry for creating named Tracers.

    1.0.0

    -
    interface TracerProvider {
        getTracer(
            name: string,
            version?: string,
            options?: TracerOptions,
        ): Tracer;
    }

    Implemented by

    Methods

    interface TracerProvider {
        getTracer(
            name: string,
            version?: string,
            options?: TracerOptions,
        ): Tracer;
    }

    Implemented by

    Methods

    Methods

    • Returns a Tracer, creating one if one with the given name and version is not already created.

      This function may return different Tracer types (e.g. @@ -9,4 +9,4 @@ NoopTracerProvider vs. a functional tracer).

    • Optionalversion: string

      The version of the tracer or instrumentation library.

    • Optionaloptions: TracerOptions

      The options of the tracer or instrumentation library.

    Returns Tracer

    Tracer A Tracer with the given name and version

    -
    +
    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api.UpDownCounter.html b/interfaces/_opentelemetry_api._opentelemetry_api.UpDownCounter.html index bfdf2242a..e3655a55a 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api.UpDownCounter.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api.UpDownCounter.html @@ -1,4 +1,4 @@ UpDownCounter | OpenTelemetry SDK

    1.3.0

    -
    interface UpDownCounter<
        AttributesTypes extends MetricAttributes = MetricAttributes,
    > {
        add(
            value: number,
            attributes?: AttributesTypes,
            context?: Context,
        ): void;
    }

    Type Parameters

    Methods

    add +
    interface UpDownCounter<
        AttributesTypes extends MetricAttributes = MetricAttributes,
    > {
        add(
            value: number,
            attributes?: AttributesTypes,
            context?: Context,
        ): void;
    }

    Type Parameters

    Methods

    Methods

    +

    Parameters

    Returns void

    diff --git a/interfaces/_opentelemetry_api._opentelemetry_api_experimental.SugaredSpanOptions.html b/interfaces/_opentelemetry_api._opentelemetry_api_experimental.SugaredSpanOptions.html index 521a86499..ae8b7ab18 100644 --- a/interfaces/_opentelemetry_api._opentelemetry_api_experimental.SugaredSpanOptions.html +++ b/interfaces/_opentelemetry_api._opentelemetry_api_experimental.SugaredSpanOptions.html @@ -1,17 +1,17 @@ SugaredSpanOptions | OpenTelemetry SDK

    Options needed for span creation

    -
    interface SugaredSpanOptions {
        attributes?: Attributes;
        kind?: SpanKind;
        links?: Link[];
        onException?: (e: Error, span: Span) => void;
        root?: boolean;
        startTime?: TimeInput;
    }

    Hierarchy (View Summary)

    Properties

    interface SugaredSpanOptions {
        attributes?: Attributes;
        kind?: SpanKind;
        links?: Link[];
        onException?: (e: Error, span: Span) => void;
        root?: boolean;
        startTime?: TimeInput;
    }

    Hierarchy (View Summary)

    Properties

    attributes?: Attributes

    A span's attributes

    -
    kind?: SpanKind

    The SpanKind of a span

    +
    kind?: SpanKind

    The SpanKind of a span

    links?: Link[]

    Links span to other spans

    -
    onException?: (e: Error, span: Span) => void

    function to overwrite default exception behavior to record the exception. No exceptions should be thrown in the function.

    +
    links?: Link[]

    Links span to other spans

    +
    onException?: (e: Error, span: Span) => void

    function to overwrite default exception behavior to record the exception. No exceptions should be thrown in the function.

    Type declaration

      • (e: Error, span: Span): void
      • Parameters

        • e: Error

          Error which triggered this exception

        • span: Span

          current span from context

          -

        Returns void

    root?: boolean

    The new span should be a root span. (Ignore parent from context).

    -
    startTime?: TimeInput

    A manually specified start time for the created Span object.

    -
    +

    Returns void

    root?: boolean

    The new span should be a root span. (Ignore parent from context).

    +
    startTime?: TimeInput

    A manually specified start time for the created Span object.

    +
    diff --git a/interfaces/_opentelemetry_context-zone-peer-dep.TargetWithEvents.html b/interfaces/_opentelemetry_context-zone-peer-dep.TargetWithEvents.html index 368d227b8..707d59a25 100644 --- a/interfaces/_opentelemetry_context-zone-peer-dep.TargetWithEvents.html +++ b/interfaces/_opentelemetry_context-zone-peer-dep.TargetWithEvents.html @@ -1,6 +1,6 @@ TargetWithEvents | OpenTelemetry SDK

    Minimum requirements that the object needs to have so that it can bind to the events instead of function this is "addEventListener" and "removeEventListener" - see isListenerObject

    -
    interface TargetWithEvents {
        __ot_listeners?: { [name: string]: WeakMap<Func<void>, Func<void>> };
        addEventListener(
            event: string,
            listener: (...args: unknown[]) => void,
            opts?: { once: boolean },
        ): unknown;
        removeEventListener(
            event: string,
            listener: (...args: unknown[]) => void,
            opts?: { once: boolean },
        ): unknown;
    }

    Properties

    interface TargetWithEvents {
        __ot_listeners?: { [name: string]: WeakMap<Func<void>, Func<void>> };
        addEventListener(
            event: string,
            listener: (...args: unknown[]) => void,
            opts?: { once: boolean },
        ): unknown;
        removeEventListener(
            event: string,
            listener: (...args: unknown[]) => void,
            opts?: { once: boolean },
        ): unknown;
    }

    Properties

    __ot_listeners?: { [name: string]: WeakMap<Func<void>, Func<void>> }

    Methods

    • Parameters

      • event: string
      • listener: (...args: unknown[]) => void
      • Optionalopts: { once: boolean }

      Returns unknown

    • Parameters

      • event: string
      • listener: (...args: unknown[]) => void
      • Optionalopts: { once: boolean }

      Returns unknown

    +

    Properties

    __ot_listeners?: { [name: string]: WeakMap<Func<void>, Func<void>> }

    Methods

    • Parameters

      • event: string
      • listener: (...args: unknown[]) => void
      • Optionalopts: { once: boolean }

      Returns unknown

    • Parameters

      • event: string
      • listener: (...args: unknown[]) => void
      • Optionalopts: { once: boolean }

      Returns unknown

    diff --git a/interfaces/_opentelemetry_core.Clock.html b/interfaces/_opentelemetry_core.Clock.html index 3858bfc75..f31f97f91 100644 --- a/interfaces/_opentelemetry_core.Clock.html +++ b/interfaces/_opentelemetry_core.Clock.html @@ -1,3 +1,3 @@ -Clock | OpenTelemetry SDK
    interface Clock {
        now(): number;
    }

    Implemented by

    Methods

    now +Clock | OpenTelemetry SDK
    interface Clock {
        now(): number;
    }

    Implemented by

    Methods

    Methods

    +

    Returns number

    diff --git a/interfaces/_opentelemetry_core.CompositePropagatorConfig.html b/interfaces/_opentelemetry_core.CompositePropagatorConfig.html index 0534427fb..a4d042884 100644 --- a/interfaces/_opentelemetry_core.CompositePropagatorConfig.html +++ b/interfaces/_opentelemetry_core.CompositePropagatorConfig.html @@ -1,6 +1,6 @@ CompositePropagatorConfig | OpenTelemetry SDK

    Configuration object for composite propagator

    -
    interface CompositePropagatorConfig {
        propagators?: TextMapPropagator<any>[];
    }

    Properties

    interface CompositePropagatorConfig {
        propagators?: TextMapPropagator<any>[];
    }

    Properties

    Properties

    propagators?: TextMapPropagator<any>[]

    List of propagators to run. Propagators run in the list order. If a propagator later in the list writes the same context key as a propagator earlier in the list, the later on will "win".

    -
    +
    diff --git a/interfaces/_opentelemetry_core.ExportResult.html b/interfaces/_opentelemetry_core.ExportResult.html index c6e096c43..2dd3ebe6c 100644 --- a/interfaces/_opentelemetry_core.ExportResult.html +++ b/interfaces/_opentelemetry_core.ExportResult.html @@ -1,3 +1,3 @@ -ExportResult | OpenTelemetry SDK
    interface ExportResult {
        code: ExportResultCode;
        error?: Error;
    }

    Properties

    code +ExportResult | OpenTelemetry SDK
    interface ExportResult {
        code: ExportResultCode;
        error?: Error;
    }

    Properties

    Properties

    error?: Error
    +

    Properties

    error?: Error
    diff --git a/interfaces/_opentelemetry_core.InstrumentationScope.html b/interfaces/_opentelemetry_core.InstrumentationScope.html index b63680b30..9f29711fa 100644 --- a/interfaces/_opentelemetry_core.InstrumentationScope.html +++ b/interfaces/_opentelemetry_core.InstrumentationScope.html @@ -1,7 +1,7 @@ InstrumentationScope | OpenTelemetry SDK

    An instrumentation scope consists of the name and optional version used to obtain a tracer or meter from a provider. This metadata is made available on ReadableSpan and MetricRecord for use by the export pipeline.

    -
    interface InstrumentationScope {
        name: string;
        schemaUrl?: string;
        version?: string;
    }

    Properties

    interface InstrumentationScope {
        name: string;
        schemaUrl?: string;
        version?: string;
    }

    Properties

    name: string
    schemaUrl?: string
    version?: string
    +

    Properties

    name: string
    schemaUrl?: string
    version?: string
    diff --git a/interfaces/_opentelemetry_exporter-jaeger.ExporterConfig.html b/interfaces/_opentelemetry_exporter-jaeger.ExporterConfig.html index 3a7ec184b..63b100a51 100644 --- a/interfaces/_opentelemetry_exporter-jaeger.ExporterConfig.html +++ b/interfaces/_opentelemetry_exporter-jaeger.ExporterConfig.html @@ -1,5 +1,5 @@ ExporterConfig | OpenTelemetry SDK

    Options for Jaeger configuration

    -
    interface ExporterConfig {
        endpoint?: string;
        flushTimeout?: number;
        host?: string;
        maxPacketSize?: number;
        password?: string;
        port?: number;
        tags?: Tag[];
        username?: string;
    }

    Properties

    interface ExporterConfig {
        endpoint?: string;
        flushTimeout?: number;
        host?: string;
        maxPacketSize?: number;
        password?: string;
        port?: number;
        tags?: Tag[];
        username?: string;
    }

    Properties

    endpoint?: string
    flushTimeout?: number

    Time to wait for an onShutdown flush to finish before closing the sender

    -
    host?: string
    maxPacketSize?: number
    password?: string
    port?: number
    tags?: Tag[]
    username?: string
    +

    Properties

    endpoint?: string
    flushTimeout?: number

    Time to wait for an onShutdown flush to finish before closing the sender

    +
    host?: string
    maxPacketSize?: number
    password?: string
    port?: number
    tags?: Tag[]
    username?: string
    diff --git a/interfaces/_opentelemetry_exporter-metrics-otlp-http.OTLPMetricExporterOptions.html b/interfaces/_opentelemetry_exporter-metrics-otlp-http.OTLPMetricExporterOptions.html index 415734988..92a050793 100644 --- a/interfaces/_opentelemetry_exporter-metrics-otlp-http.OTLPMetricExporterOptions.html +++ b/interfaces/_opentelemetry_exporter-metrics-otlp-http.OTLPMetricExporterOptions.html @@ -1,9 +1,9 @@ -OTLPMetricExporterOptions | OpenTelemetry SDK
    interface OTLPMetricExporterOptions {
        aggregationPreference?: metrics.AggregationSelector;
        concurrencyLimit?: number;
        headers?: Record<string, string>;
        temporalityPreference?:
            | AggregationTemporalityPreference
            | metrics.AggregationTemporality;
        timeoutMillis?: number;
        url?: string;
    }

    Hierarchy

    • OTLPExporterConfigBase
      • OTLPMetricExporterOptions

    Properties

    aggregationPreference? +OTLPMetricExporterOptions | OpenTelemetry SDK
    interface OTLPMetricExporterOptions {
        aggregationPreference?: metrics.AggregationSelector;
        concurrencyLimit?: number;
        headers?: Record<string, string>;
        temporalityPreference?:
            | AggregationTemporalityPreference
            | metrics.AggregationTemporality;
        timeoutMillis?: number;
        url?: string;
    }

    Hierarchy

    • OTLPExporterConfigBase
      • OTLPMetricExporterOptions

    Properties

    aggregationPreference?: metrics.AggregationSelector
    concurrencyLimit?: number
    headers?: Record<string, string>
    temporalityPreference?:
        | AggregationTemporalityPreference
        | metrics.AggregationTemporality
    timeoutMillis?: number

    Maximum time the OTLP exporter will wait for each batch export. +

    Properties

    aggregationPreference?: metrics.AggregationSelector
    concurrencyLimit?: number
    headers?: Record<string, string>
    temporalityPreference?:
        | AggregationTemporalityPreference
        | metrics.AggregationTemporality
    timeoutMillis?: number

    Maximum time the OTLP exporter will wait for each batch export. The default value is 10000ms.

    url?: string
    diff --git a/interfaces/_opentelemetry_exporter-prometheus.ExporterConfig.html b/interfaces/_opentelemetry_exporter-prometheus.ExporterConfig.html index 7de68083f..cd058ae93 100644 --- a/interfaces/_opentelemetry_exporter-prometheus.ExporterConfig.html +++ b/interfaces/_opentelemetry_exporter-prometheus.ExporterConfig.html @@ -1,5 +1,5 @@ ExporterConfig | OpenTelemetry SDK

    Configuration interface for prometheus exporter

    -
    interface ExporterConfig {
        appendTimestamp?: boolean;
        endpoint?: string;
        host?: string;
        metricProducers?: metrics.MetricProducer[];
        port?: number;
        prefix?: string;
        preventServerStart?: boolean;
        withResourceConstantLabels?: RegExp;
    }

    Properties

    interface ExporterConfig {
        appendTimestamp?: boolean;
        endpoint?: string;
        host?: string;
        metricProducers?: metrics.MetricProducer[];
        port?: number;
        prefix?: string;
        preventServerStart?: boolean;
        withResourceConstantLabels?: RegExp;
    }

    Properties

    true
     
    -
    endpoint?: string

    Endpoint the metrics should be exposed at with preceding slash

    +
    endpoint?: string

    Endpoint the metrics should be exposed at with preceding slash

    '/metrics'
     
    -
    host?: string
    undefined (all interfaces)
    +
    host?: string
    undefined (all interfaces)
     
    -
    metricProducers?: metrics.MetricProducer[]

    Note, this option is experimental. Additional MetricProducers to use as a source of +

    metricProducers?: metrics.MetricProducer[]

    Note, this option is experimental. Additional MetricProducers to use as a source of aggregated metric data in addition to the SDK's metric data. The resource returned by these MetricProducers is ignored; the SDK's resource will be used instead.

    -
    port?: number

    Port number for Prometheus exporter server

    +
    port?: number

    Port number for Prometheus exporter server

    Default registered port is 9464: https://github.com/prometheus/prometheus/wiki/Default-port-allocations

    9464
     
    -
    prefix?: string

    App prefix for metrics, if needed

    +
    prefix?: string

    App prefix for metrics, if needed

    ''
     
    -
    preventServerStart?: boolean

    Prevent the Prometheus exporter server from starting

    +
    preventServerStart?: boolean

    Prevent the Prometheus exporter server from starting

    false
     
    -
    withResourceConstantLabels?: RegExp

    Regex pattern for defining which resource attributes will be applied +

    withResourceConstantLabels?: RegExp

    Regex pattern for defining which resource attributes will be applied as constant labels to the metrics. e.g. 'telemetry_.+' for all attributes starting with 'telemetry'.

    undefined (no resource attributes are applied)
     
    -
    +
    diff --git a/interfaces/_opentelemetry_exporter-zipkin.ExporterConfig.html b/interfaces/_opentelemetry_exporter-zipkin.ExporterConfig.html index f13b669f2..f16d5c536 100644 --- a/interfaces/_opentelemetry_exporter-zipkin.ExporterConfig.html +++ b/interfaces/_opentelemetry_exporter-zipkin.ExporterConfig.html @@ -1,8 +1,8 @@ ExporterConfig | OpenTelemetry SDK

    Exporter config

    -
    interface ExporterConfig {
        getExportRequestHeaders?: () => undefined | Record<string, string>;
        headers?: Record<string, string>;
        serviceName?: string;
        statusCodeTagName?: string;
        statusDescriptionTagName?: string;
        url?: string;
    }

    Properties

    interface ExporterConfig {
        getExportRequestHeaders?: () => undefined | Record<string, string>;
        headers?: Record<string, string>;
        serviceName?: string;
        statusCodeTagName?: string;
        statusDescriptionTagName?: string;
        url?: string;
    }

    Properties

    getExportRequestHeaders?: () => undefined | Record<string, string>
    headers?: Record<string, string>
    serviceName?: string
    statusCodeTagName?: string
    statusDescriptionTagName?: string
    url?: string
    +

    Properties

    getExportRequestHeaders?: () => undefined | Record<string, string>
    headers?: Record<string, string>
    serviceName?: string
    statusCodeTagName?: string
    statusDescriptionTagName?: string
    url?: string
    diff --git a/interfaces/_opentelemetry_instrumentation-fetch.FetchCustomAttributeFunction.html b/interfaces/_opentelemetry_instrumentation-fetch.FetchCustomAttributeFunction.html index ecca4d6a5..affa6090e 100644 --- a/interfaces/_opentelemetry_instrumentation-fetch.FetchCustomAttributeFunction.html +++ b/interfaces/_opentelemetry_instrumentation-fetch.FetchCustomAttributeFunction.html @@ -1 +1 @@ -FetchCustomAttributeFunction | OpenTelemetry SDK
    +FetchCustomAttributeFunction | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation-fetch.FetchInstrumentationConfig.html b/interfaces/_opentelemetry_instrumentation-fetch.FetchInstrumentationConfig.html index 4206c5e0a..3b4db44dc 100644 --- a/interfaces/_opentelemetry_instrumentation-fetch.FetchInstrumentationConfig.html +++ b/interfaces/_opentelemetry_instrumentation-fetch.FetchInstrumentationConfig.html @@ -1,5 +1,5 @@ FetchInstrumentationConfig | OpenTelemetry SDK

    FetchPlugin Config

    -
    interface FetchInstrumentationConfig {
        applyCustomAttributesOnSpan?: FetchCustomAttributeFunction;
        clearTimingResources?: boolean;
        enabled?: boolean;
        ignoreNetworkEvents?: boolean;
        ignoreUrls?: (string | RegExp)[];
        measureRequestSize?: boolean;
        propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls;
        requestHook?: FetchRequestHookFunction;
        semconvStabilityOptIn?: string;
    }

    Hierarchy (View Summary)

    Properties

    interface FetchInstrumentationConfig {
        applyCustomAttributesOnSpan?: FetchCustomAttributeFunction;
        clearTimingResources?: boolean;
        enabled?: boolean;
        ignoreNetworkEvents?: boolean;
        ignoreUrls?: (string | RegExp)[];
        measureRequestSize?: boolean;
        propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls;
        requestHook?: FetchRequestHookFunction;
        semconvStabilityOptIn?: string;
    }

    Hierarchy (View Summary)

    Properties

    applyCustomAttributesOnSpan?: FetchCustomAttributeFunction

    Function for adding custom attributes on the span

    -
    clearTimingResources?: boolean
    enabled?: boolean

    Whether to enable the plugin.

    +
    clearTimingResources?: boolean
    enabled?: boolean

    Whether to enable the plugin.

    true
     
    -
    ignoreNetworkEvents?: boolean
    ignoreUrls?: (string | RegExp)[]

    URLs that partially match any regex in ignoreUrls will not be traced. +

    ignoreNetworkEvents?: boolean
    ignoreUrls?: (string | RegExp)[]

    URLs that partially match any regex in ignoreUrls will not be traced. In addition, URLs that are exact matches of strings in ignoreUrls will also not be traced.

    -
    measureRequestSize?: boolean

    Measure outgoing request size

    -
    propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls

    Function for adding custom attributes or headers before the request is handled

    -
    semconvStabilityOptIn?: string

    Select the HTTP semantic conventions version(s) used.

    -
    +
    measureRequestSize?: boolean

    Measure outgoing request size

    +
    propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls

    Function for adding custom attributes or headers before the request is handled

    +
    semconvStabilityOptIn?: string

    Select the HTTP semantic conventions version(s) used.

    +
    diff --git a/interfaces/_opentelemetry_instrumentation-fetch.FetchRequestHookFunction.html b/interfaces/_opentelemetry_instrumentation-fetch.FetchRequestHookFunction.html index 7233afa76..8a3d82ca9 100644 --- a/interfaces/_opentelemetry_instrumentation-fetch.FetchRequestHookFunction.html +++ b/interfaces/_opentelemetry_instrumentation-fetch.FetchRequestHookFunction.html @@ -1 +1 @@ -FetchRequestHookFunction | OpenTelemetry SDK
    +FetchRequestHookFunction | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation-grpc.GrpcInstrumentationConfig.html b/interfaces/_opentelemetry_instrumentation-grpc.GrpcInstrumentationConfig.html index 0c7bd4ee4..bb6f8a452 100644 --- a/interfaces/_opentelemetry_instrumentation-grpc.GrpcInstrumentationConfig.html +++ b/interfaces/_opentelemetry_instrumentation-grpc.GrpcInstrumentationConfig.html @@ -2,12 +2,12 @@ This interface can be extended by individual instrumentations to include additional configuration options specific to that instrumentation. All configuration options must be optional.

    -
    interface GrpcInstrumentationConfig {
        enabled?: boolean;
        ignoreGrpcMethods?: IgnoreMatcher[];
        metadataToSpanAttributes?: {
            client?: { requestMetadata?: string[]; responseMetadata?: string[] };
            server?: { requestMetadata?: string[]; responseMetadata?: string[] };
        };
    }

    Hierarchy (View Summary)

    Properties

    interface GrpcInstrumentationConfig {
        enabled?: boolean;
        ignoreGrpcMethods?: IgnoreMatcher[];
        metadataToSpanAttributes?: {
            client?: { requestMetadata?: string[]; responseMetadata?: string[] };
            server?: { requestMetadata?: string[]; responseMetadata?: string[] };
        };
    }

    Hierarchy (View Summary)

    Properties

    enabled?: boolean

    Whether to enable the plugin.

    true
     
    -
    ignoreGrpcMethods?: IgnoreMatcher[]
    metadataToSpanAttributes?: {
        client?: { requestMetadata?: string[]; responseMetadata?: string[] };
        server?: { requestMetadata?: string[]; responseMetadata?: string[] };
    }

    Map the following gRPC metadata to span attributes.

    -
    +
    ignoreGrpcMethods?: IgnoreMatcher[]
    metadataToSpanAttributes?: {
        client?: { requestMetadata?: string[]; responseMetadata?: string[] };
        server?: { requestMetadata?: string[]; responseMetadata?: string[] };
    }

    Map the following gRPC metadata to span attributes.

    +
    diff --git a/interfaces/_opentelemetry_instrumentation-http.HttpCustomAttributeFunction.html b/interfaces/_opentelemetry_instrumentation-http.HttpCustomAttributeFunction.html index def4a18c4..408190e06 100644 --- a/interfaces/_opentelemetry_instrumentation-http.HttpCustomAttributeFunction.html +++ b/interfaces/_opentelemetry_instrumentation-http.HttpCustomAttributeFunction.html @@ -1 +1 @@ -HttpCustomAttributeFunction | OpenTelemetry SDK
    +HttpCustomAttributeFunction | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html b/interfaces/_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html index 5f0c7ac53..efba62233 100644 --- a/interfaces/_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html +++ b/interfaces/_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html @@ -1,5 +1,5 @@ -HttpInstrumentationConfig | OpenTelemetry SDK

    Options available for the HTTP instrumentation (see documentation)

    -
    interface HttpInstrumentationConfig {
        applyCustomAttributesOnSpan?: HttpCustomAttributeFunction;
        disableIncomingRequestInstrumentation?: boolean;
        disableOutgoingRequestInstrumentation?: boolean;
        enabled?: boolean;
        enableSyntheticSourceDetection?: boolean;
        headersToSpanAttributes?: {
            client?: { requestHeaders?: string[]; responseHeaders?: string[] };
            server?: { requestHeaders?: string[]; responseHeaders?: string[] };
        };
        ignoreIncomingRequestHook?: IgnoreIncomingRequestFunction;
        ignoreOutgoingRequestHook?: IgnoreOutgoingRequestFunction;
        requestHook?: HttpRequestCustomAttributeFunction;
        requireParentforIncomingSpans?: boolean;
        requireParentforOutgoingSpans?: boolean;
        responseHook?: HttpResponseCustomAttributeFunction;
        serverName?: string;
        startIncomingSpanHook?: StartIncomingSpanCustomAttributeFunction;
        startOutgoingSpanHook?: StartOutgoingSpanCustomAttributeFunction;
    }

    Hierarchy (View Summary)

    Properties

    applyCustomAttributesOnSpan? +HttpInstrumentationConfig | OpenTelemetry SDK

    Options available for the HTTP instrumentation (see documentation)

    +
    interface HttpInstrumentationConfig {
        applyCustomAttributesOnSpan?: HttpCustomAttributeFunction;
        disableIncomingRequestInstrumentation?: boolean;
        disableOutgoingRequestInstrumentation?: boolean;
        enabled?: boolean;
        enableSyntheticSourceDetection?: boolean;
        headersToSpanAttributes?: {
            client?: { requestHeaders?: string[]; responseHeaders?: string[] };
            server?: { requestHeaders?: string[]; responseHeaders?: string[] };
        };
        ignoreIncomingRequestHook?: IgnoreIncomingRequestFunction;
        ignoreOutgoingRequestHook?: IgnoreOutgoingRequestFunction;
        requestHook?: HttpRequestCustomAttributeFunction;
        requireParentforIncomingSpans?: boolean;
        requireParentforOutgoingSpans?: boolean;
        responseHook?: HttpResponseCustomAttributeFunction;
        serverName?: string;
        startIncomingSpanHook?: StartIncomingSpanCustomAttributeFunction;
        startOutgoingSpanHook?: StartOutgoingSpanCustomAttributeFunction;
    }

    Hierarchy (View Summary)

    Properties

    applyCustomAttributesOnSpan?: HttpCustomAttributeFunction

    Function for adding custom attributes after response is handled

    -
    disableIncomingRequestInstrumentation?: boolean

    If set to true, incoming requests will not be instrumented at all.

    -
    disableOutgoingRequestInstrumentation?: boolean

    If set to true, outgoing requests will not be instrumented at all.

    -
    enabled?: boolean

    Whether to enable the plugin.

    +
    disableIncomingRequestInstrumentation?: boolean

    If set to true, incoming requests will not be instrumented at all.

    +
    disableOutgoingRequestInstrumentation?: boolean

    If set to true, outgoing requests will not be instrumented at all.

    +
    enabled?: boolean

    Whether to enable the plugin.

    true
     
    enableSyntheticSourceDetection?: boolean

    Enable automatic population of synthetic source type based on the user-agent header

    -
    headersToSpanAttributes?: {
        client?: { requestHeaders?: string[]; responseHeaders?: string[] };
        server?: { requestHeaders?: string[]; responseHeaders?: string[] };
    }

    Map the following HTTP headers to span attributes.

    -
    ignoreIncomingRequestHook?: IgnoreIncomingRequestFunction

    Not trace all incoming requests that matched with custom function

    -
    ignoreOutgoingRequestHook?: IgnoreOutgoingRequestFunction

    Not trace all outgoing requests that matched with custom function

    -

    Function for adding custom attributes before request is handled

    -
    requireParentforIncomingSpans?: boolean

    Require parent to create span for incoming requests

    -
    requireParentforOutgoingSpans?: boolean

    Require parent to create span for outgoing requests

    -

    Function for adding custom attributes before response is handled

    -
    serverName?: string

    The primary server name of the matched virtual host.

    -

    Function for adding custom attributes before a span is started in incomingRequest

    -

    Function for adding custom attributes before a span is started in outgoingRequest

    -
    +
    headersToSpanAttributes?: {
        client?: { requestHeaders?: string[]; responseHeaders?: string[] };
        server?: { requestHeaders?: string[]; responseHeaders?: string[] };
    }

    Map the following HTTP headers to span attributes.

    +
    ignoreIncomingRequestHook?: IgnoreIncomingRequestFunction

    Not trace all incoming requests that matched with custom function

    +
    ignoreOutgoingRequestHook?: IgnoreOutgoingRequestFunction

    Not trace all outgoing requests that matched with custom function

    +

    Function for adding custom attributes before request is handled

    +
    requireParentforIncomingSpans?: boolean

    Require parent to create span for incoming requests

    +
    requireParentforOutgoingSpans?: boolean

    Require parent to create span for outgoing requests

    +

    Function for adding custom attributes before response is handled

    +
    serverName?: string

    The primary server name of the matched virtual host.

    +

    Function for adding custom attributes before a span is started in incomingRequest

    +

    Function for adding custom attributes before a span is started in outgoingRequest

    +
    diff --git a/interfaces/_opentelemetry_instrumentation-http.HttpRequestCustomAttributeFunction.html b/interfaces/_opentelemetry_instrumentation-http.HttpRequestCustomAttributeFunction.html index f8d8cf92b..7bfc99049 100644 --- a/interfaces/_opentelemetry_instrumentation-http.HttpRequestCustomAttributeFunction.html +++ b/interfaces/_opentelemetry_instrumentation-http.HttpRequestCustomAttributeFunction.html @@ -1 +1 @@ -HttpRequestCustomAttributeFunction | OpenTelemetry SDK
    +HttpRequestCustomAttributeFunction | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation-http.HttpResponseCustomAttributeFunction.html b/interfaces/_opentelemetry_instrumentation-http.HttpResponseCustomAttributeFunction.html index ee1b2eec2..90b9e9362 100644 --- a/interfaces/_opentelemetry_instrumentation-http.HttpResponseCustomAttributeFunction.html +++ b/interfaces/_opentelemetry_instrumentation-http.HttpResponseCustomAttributeFunction.html @@ -1 +1 @@ -HttpResponseCustomAttributeFunction | OpenTelemetry SDK
    +HttpResponseCustomAttributeFunction | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation-http.IgnoreIncomingRequestFunction.html b/interfaces/_opentelemetry_instrumentation-http.IgnoreIncomingRequestFunction.html index 244977c6d..20fec1687 100644 --- a/interfaces/_opentelemetry_instrumentation-http.IgnoreIncomingRequestFunction.html +++ b/interfaces/_opentelemetry_instrumentation-http.IgnoreIncomingRequestFunction.html @@ -1 +1 @@ -IgnoreIncomingRequestFunction | OpenTelemetry SDK
    +IgnoreIncomingRequestFunction | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation-http.IgnoreOutgoingRequestFunction.html b/interfaces/_opentelemetry_instrumentation-http.IgnoreOutgoingRequestFunction.html index a0a8bea41..bbb318c66 100644 --- a/interfaces/_opentelemetry_instrumentation-http.IgnoreOutgoingRequestFunction.html +++ b/interfaces/_opentelemetry_instrumentation-http.IgnoreOutgoingRequestFunction.html @@ -1 +1 @@ -IgnoreOutgoingRequestFunction | OpenTelemetry SDK
    +IgnoreOutgoingRequestFunction | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation-http.StartIncomingSpanCustomAttributeFunction.html b/interfaces/_opentelemetry_instrumentation-http.StartIncomingSpanCustomAttributeFunction.html index 75938b9ba..84b9ce937 100644 --- a/interfaces/_opentelemetry_instrumentation-http.StartIncomingSpanCustomAttributeFunction.html +++ b/interfaces/_opentelemetry_instrumentation-http.StartIncomingSpanCustomAttributeFunction.html @@ -1 +1 @@ -StartIncomingSpanCustomAttributeFunction | OpenTelemetry SDK
    +StartIncomingSpanCustomAttributeFunction | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation-http.StartOutgoingSpanCustomAttributeFunction.html b/interfaces/_opentelemetry_instrumentation-http.StartOutgoingSpanCustomAttributeFunction.html index 2855bdb13..a3bbdbde5 100644 --- a/interfaces/_opentelemetry_instrumentation-http.StartOutgoingSpanCustomAttributeFunction.html +++ b/interfaces/_opentelemetry_instrumentation-http.StartOutgoingSpanCustomAttributeFunction.html @@ -1 +1 @@ -StartOutgoingSpanCustomAttributeFunction | OpenTelemetry SDK
    +StartOutgoingSpanCustomAttributeFunction | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation-xml-http-request.XMLHttpRequestInstrumentationConfig.html b/interfaces/_opentelemetry_instrumentation-xml-http-request.XMLHttpRequestInstrumentationConfig.html index 75ff65752..0198ae86c 100644 --- a/interfaces/_opentelemetry_instrumentation-xml-http-request.XMLHttpRequestInstrumentationConfig.html +++ b/interfaces/_opentelemetry_instrumentation-xml-http-request.XMLHttpRequestInstrumentationConfig.html @@ -1,5 +1,5 @@ XMLHttpRequestInstrumentationConfig | OpenTelemetry SDK

    XMLHttpRequest config

    -
    interface XMLHttpRequestInstrumentationConfig {
        applyCustomAttributesOnSpan?: XHRCustomAttributeFunction;
        clearTimingResources?: boolean;
        enabled?: boolean;
        ignoreNetworkEvents?: boolean;
        ignoreUrls?: (string | RegExp)[];
        measureRequestSize?: boolean;
        propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls;
        semconvStabilityOptIn?: string;
    }

    Hierarchy (View Summary)

    Properties

    interface XMLHttpRequestInstrumentationConfig {
        applyCustomAttributesOnSpan?: XHRCustomAttributeFunction;
        clearTimingResources?: boolean;
        enabled?: boolean;
        ignoreNetworkEvents?: boolean;
        ignoreUrls?: (string | RegExp)[];
        measureRequestSize?: boolean;
        propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls;
        semconvStabilityOptIn?: string;
    }

    Hierarchy (View Summary)

    Properties

    applyCustomAttributesOnSpan?: XHRCustomAttributeFunction

    Function for adding custom attributes on the span

    -
    clearTimingResources?: boolean

    The number of timing resources is limited, after the limit +

    clearTimingResources?: boolean

    The number of timing resources is limited, after the limit (chrome 250, safari 150) the information is not collected anymore. The only way to prevent that is to regularly clean the resources whenever it is possible. This is needed only when PerformanceObserver is not available

    -
    enabled?: boolean

    Whether to enable the plugin.

    +
    enabled?: boolean

    Whether to enable the plugin.

    true
     
    ignoreNetworkEvents?: boolean

    Ignore adding network events as span events

    -
    ignoreUrls?: (string | RegExp)[]

    URLs that partially match any regex in ignoreUrls will not be traced. +

    ignoreUrls?: (string | RegExp)[]

    URLs that partially match any regex in ignoreUrls will not be traced. In addition, URLs that are exact matches of strings in ignoreUrls will also not be traced.

    -
    measureRequestSize?: boolean

    Measure outgoing request size

    -
    propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls

    URLs which should include trace headers when origin doesn't match

    -
    semconvStabilityOptIn?: string

    Select the HTTP semantic conventions version(s) used.

    -
    +
    measureRequestSize?: boolean

    Measure outgoing request size

    +
    propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls

    URLs which should include trace headers when origin doesn't match

    +
    semconvStabilityOptIn?: string

    Select the HTTP semantic conventions version(s) used.

    +
    diff --git a/interfaces/_opentelemetry_instrumentation.AutoLoaderOptions.html b/interfaces/_opentelemetry_instrumentation.AutoLoaderOptions.html index 710e7090f..5da3b77a1 100644 --- a/interfaces/_opentelemetry_instrumentation.AutoLoaderOptions.html +++ b/interfaces/_opentelemetry_instrumentation.AutoLoaderOptions.html @@ -1,5 +1,5 @@ -AutoLoaderOptions | OpenTelemetry SDK
    interface AutoLoaderOptions {
        instrumentations?: (
            | Instrumentation<InstrumentationConfig>
            | Instrumentation<InstrumentationConfig>[]
        )[];
        loggerProvider?: LoggerProvider;
        meterProvider?: MeterProvider;
        tracerProvider?: TracerProvider;
    }

    Properties

    instrumentations? +AutoLoaderOptions | OpenTelemetry SDK
    +

    Properties

    instrumentations?: (
        | Instrumentation<InstrumentationConfig>
        | Instrumentation<InstrumentationConfig>[]
    )[]
    loggerProvider?: LoggerProvider
    meterProvider?: MeterProvider
    tracerProvider?: TracerProvider
    diff --git a/interfaces/_opentelemetry_instrumentation.AutoLoaderResult.html b/interfaces/_opentelemetry_instrumentation.AutoLoaderResult.html index 1b886de4a..e56555f62 100644 --- a/interfaces/_opentelemetry_instrumentation.AutoLoaderResult.html +++ b/interfaces/_opentelemetry_instrumentation.AutoLoaderResult.html @@ -1,2 +1,2 @@ -AutoLoaderResult | OpenTelemetry SDK
    +AutoLoaderResult | OpenTelemetry SDK
    diff --git a/interfaces/_opentelemetry_instrumentation.Instrumentation.html b/interfaces/_opentelemetry_instrumentation.Instrumentation.html index 099086a25..f486b4ec5 100644 --- a/interfaces/_opentelemetry_instrumentation.Instrumentation.html +++ b/interfaces/_opentelemetry_instrumentation.Instrumentation.html @@ -1,5 +1,5 @@ Instrumentation | OpenTelemetry SDK

    Interface Instrumentation to apply patch.

    -
    interface Instrumentation<
        ConfigType extends InstrumentationConfig = InstrumentationConfig,
    > {
        instrumentationName: string;
        instrumentationVersion: string;
        disable(): void;
        enable(): void;
        getConfig(): ConfigType;
        setConfig(config: ConfigType): void;
        setLoggerProvider(loggerProvider: LoggerProvider): void;
        setMeterProvider(meterProvider: MeterProvider): void;
        setTracerProvider(tracerProvider: TracerProvider): void;
    }

    Type Parameters

    Implemented by

    Properties

    interface Instrumentation<
        ConfigType extends InstrumentationConfig = InstrumentationConfig,
    > {
        instrumentationName: string;
        instrumentationVersion: string;
        disable(): void;
        enable(): void;
        getConfig(): ConfigType;
        setConfig(config: ConfigType): void;
        setLoggerProvider(loggerProvider: LoggerProvider): void;
        setMeterProvider(meterProvider: MeterProvider): void;
        setTracerProvider(tracerProvider: TracerProvider): void;
    }

    Type Parameters

    Implemented by

    Properties

    instrumentationName: string

    Instrumentation Name

    -
    instrumentationVersion: string

    Instrumentation Version

    -

    Methods

    +
    instrumentationVersion: string

    Instrumentation Version

    +

    Methods

    diff --git a/interfaces/_opentelemetry_instrumentation.InstrumentationConfig.html b/interfaces/_opentelemetry_instrumentation.InstrumentationConfig.html index 864fe2c15..f88c8c2a8 100644 --- a/interfaces/_opentelemetry_instrumentation.InstrumentationConfig.html +++ b/interfaces/_opentelemetry_instrumentation.InstrumentationConfig.html @@ -2,9 +2,9 @@ This interface can be extended by individual instrumentations to include additional configuration options specific to that instrumentation. All configuration options must be optional.

    -
    interface InstrumentationConfig {
        enabled?: boolean;
    }

    Hierarchy (View Summary)

    Properties

    interface InstrumentationConfig {
        enabled?: boolean;
    }

    Hierarchy (View Summary)

    Properties

    Properties

    enabled?: boolean

    Whether to enable the plugin.

    true
     
    -
    +
    diff --git a/interfaces/_opentelemetry_instrumentation.InstrumentationModuleDefinition.html b/interfaces/_opentelemetry_instrumentation.InstrumentationModuleDefinition.html index 8254157c8..21b354084 100644 --- a/interfaces/_opentelemetry_instrumentation.InstrumentationModuleDefinition.html +++ b/interfaces/_opentelemetry_instrumentation.InstrumentationModuleDefinition.html @@ -1,4 +1,4 @@ -InstrumentationModuleDefinition | OpenTelemetry SDK
    interface InstrumentationModuleDefinition {
        files: InstrumentationModuleFile[];
        includePrerelease?: boolean;
        moduleExports?: any;
        moduleVersion?: string;
        name: string;
        patch?: (moduleExports: any, moduleVersion?: string) => any;
        supportedVersions: string[];
        unpatch?: (moduleExports: any, moduleVersion?: string) => void;
    }

    Implemented by

    Properties

    files +InstrumentationModuleDefinition | OpenTelemetry SDK
    interface InstrumentationModuleDefinition {
        files: InstrumentationModuleFile[];
        includePrerelease?: boolean;
        moduleExports?: any;
        moduleVersion?: string;
        name: string;
        patch?: (moduleExports: any, moduleVersion?: string) => any;
        supportedVersions: string[];
        unpatch?: (moduleExports: any, moduleVersion?: string) => void;
    }

    Implemented by

    Properties

    Module internal files to be patched

    -
    includePrerelease?: boolean

    If set to true, the includePrerelease check will be included when calling semver.satisfies

    -
    moduleExports?: any
    moduleVersion?: string

    Instrumented module version

    -
    name: string

    Module name or path

    -
    patch?: (moduleExports: any, moduleVersion?: string) => any

    Method to patch the instrumentation

    -
    supportedVersions: string[]

    Supported version of module.

    +
    includePrerelease?: boolean

    If set to true, the includePrerelease check will be included when calling semver.satisfies

    +
    moduleExports?: any
    moduleVersion?: string

    Instrumented module version

    +
    name: string

    Module name or path

    +
    patch?: (moduleExports: any, moduleVersion?: string) => any

    Method to patch the instrumentation

    +
    supportedVersions: string[]

    Supported version of module.

    A module version is supported if one of the supportedVersions in the array satisfies the module version. The syntax of the version is checked with the satisfies function of "The semantic versioner for npm". @@ -20,5 +20,5 @@ If omitted, all versions of the module will be patched.

    It is recommended to always specify a range that is bound to a major version, to avoid breaking changes. New major versions should be reviewed and tested before being added to the supportedVersions array.

    Example: ['>=1.2.3 <3']

    -
    unpatch?: (moduleExports: any, moduleVersion?: string) => void

    Method to unpatch the instrumentation

    -
    +
    unpatch?: (moduleExports: any, moduleVersion?: string) => void

    Method to unpatch the instrumentation

    +
    diff --git a/interfaces/_opentelemetry_instrumentation.InstrumentationModuleFile.html b/interfaces/_opentelemetry_instrumentation.InstrumentationModuleFile.html index 37f4a8413..7a342012a 100644 --- a/interfaces/_opentelemetry_instrumentation.InstrumentationModuleFile.html +++ b/interfaces/_opentelemetry_instrumentation.InstrumentationModuleFile.html @@ -1,10 +1,10 @@ -InstrumentationModuleFile | OpenTelemetry SDK
    interface InstrumentationModuleFile {
        moduleExports?: unknown;
        name: string;
        supportedVersions: string[];
        patch(moduleExports: unknown, moduleVersion?: string): unknown;
        unpatch(moduleExports?: unknown, moduleVersion?: string): void;
    }

    Implemented by

    Properties

    moduleExports? +InstrumentationModuleFile | OpenTelemetry SDK
    interface InstrumentationModuleFile {
        moduleExports?: unknown;
        name: string;
        supportedVersions: string[];
        patch(moduleExports: unknown, moduleVersion?: string): unknown;
        unpatch(moduleExports?: unknown, moduleVersion?: string): void;
    }

    Implemented by

    Properties

    moduleExports?: unknown
    name: string

    Name of file to be patched with relative path

    -
    supportedVersions: string[]

    Supported versions for the file.

    +

    Properties

    moduleExports?: unknown
    name: string

    Name of file to be patched with relative path

    +
    supportedVersions: string[]

    Supported versions for the file.

    A module version is supported if one of the supportedVersions in the array satisfies the module version. The syntax of the version is checked with a function compatible with node-semver's satisfies() function. @@ -13,6 +13,6 @@ If omitted, all versions of the module will be patched.

    It is recommended to always specify a range that is bound to a major version, to avoid breaking changes. New major versions should be reviewed and tested before being added to the supportedVersions array.

    Example: ['>=1.2.3 <3']

    -

    Methods

    +

    Methods

    diff --git a/interfaces/_opentelemetry_instrumentation.ShimWrapped.html b/interfaces/_opentelemetry_instrumentation.ShimWrapped.html index 1aae15534..79e6ed0fa 100644 --- a/interfaces/_opentelemetry_instrumentation.ShimWrapped.html +++ b/interfaces/_opentelemetry_instrumentation.ShimWrapped.html @@ -1,6 +1,6 @@ ShimWrapped | OpenTelemetry SDK

    This interface defines the params that are be added to the wrapped function using the "shimmer.wrap"

    -
    interface ShimWrapped {
        __original: Function;
        __unwrap: Function;
        __wrapped: boolean;
        arguments: any;
        caller: Function;
        length: number;
        name: string;
        prototype: any;
        "[hasInstance]"(value: any): boolean;
        apply(this: Function, thisArg: any, argArray?: any): any;
        bind(this: Function, thisArg: any, ...argArray: any[]): any;
        call(this: Function, thisArg: any, ...argArray: any[]): any;
        toString(): string;
    }

    Hierarchy

    • Function
      • ShimWrapped

    Properties

    interface ShimWrapped {
        __original: Function;
        __unwrap: Function;
        __wrapped: boolean;
        arguments: any;
        caller: Function;
        length: number;
        name: string;
        prototype: any;
        "[hasInstance]"(value: any): boolean;
        apply(this: Function, thisArg: any, argArray?: any): any;
        bind(this: Function, thisArg: any, ...argArray: any[]): any;
        call(this: Function, thisArg: any, ...argArray: any[]): any;
        toString(): string;
    }

    Hierarchy

    • Function
      • ShimWrapped

    Properties

    __original __unwrap __wrapped arguments @@ -13,7 +13,7 @@ using the "shimmer.wrap"

    bind call toString -

    Properties

    __original: Function
    __unwrap: Function
    __wrapped: boolean
    arguments: any
    caller: Function
    length: number
    name: string

    Returns the name of the function. Function names are read-only and can not be changed.

    +

    Properties

    __original: Function
    __unwrap: Function
    __wrapped: boolean
    arguments: any
    caller: Function
    length: number
    name: string

    Returns the name of the function. Function names are read-only and can not be changed.

    prototype: any

    Methods

    • Determines whether the given value inherits from this function if this function was used as a constructor function.

      A constructor function can control which objects are recognized as its instances by diff --git a/interfaces/_opentelemetry_otlp-grpc-exporter-base.OTLPGRPCExporterConfigNode.html b/interfaces/_opentelemetry_otlp-grpc-exporter-base.OTLPGRPCExporterConfigNode.html index adc3e1b2a..dce8b6c4c 100644 --- a/interfaces/_opentelemetry_otlp-grpc-exporter-base.OTLPGRPCExporterConfigNode.html +++ b/interfaces/_opentelemetry_otlp-grpc-exporter-base.OTLPGRPCExporterConfigNode.html @@ -1,11 +1,11 @@ OTLPGRPCExporterConfigNode | OpenTelemetry SDK

      OTLP Exporter Config for Node

      -
      interface OTLPGRPCExporterConfigNode {
          compression?: CompressionAlgorithm;
          concurrencyLimit?: number;
          credentials?: ChannelCredentials;
          headers?: Record<string, string>;
          metadata?: Metadata;
          timeoutMillis?: number;
          url?: string;
      }

      Hierarchy

      • OTLPExporterConfigBase
        • OTLPGRPCExporterConfigNode

      Properties

      interface OTLPGRPCExporterConfigNode {
          compression?: CompressionAlgorithm;
          concurrencyLimit?: number;
          credentials?: ChannelCredentials;
          headers?: Record<string, string>;
          metadata?: Metadata;
          timeoutMillis?: number;
          url?: string;
      }

      Hierarchy

      • OTLPExporterConfigBase
        • OTLPGRPCExporterConfigNode

      Properties

      compression?: CompressionAlgorithm
      concurrencyLimit?: number
      credentials?: ChannelCredentials
      headers?: Record<string, string>
      metadata?: Metadata
      timeoutMillis?: number

      Maximum time the OTLP exporter will wait for each batch export. +

      Properties

      compression?: CompressionAlgorithm
      concurrencyLimit?: number
      credentials?: ChannelCredentials
      headers?: Record<string, string>
      metadata?: Metadata
      timeoutMillis?: number

      Maximum time the OTLP exporter will wait for each batch export. The default value is 10000ms.

      url?: string
      diff --git a/interfaces/_opentelemetry_otlp-transformer.IExportLogsPartialSuccess.html b/interfaces/_opentelemetry_otlp-transformer.IExportLogsPartialSuccess.html index dc6bfabd3..bba030514 100644 --- a/interfaces/_opentelemetry_otlp-transformer.IExportLogsPartialSuccess.html +++ b/interfaces/_opentelemetry_otlp-transformer.IExportLogsPartialSuccess.html @@ -1,5 +1,5 @@ -IExportLogsPartialSuccess | OpenTelemetry SDK
      interface IExportLogsPartialSuccess {
          errorMessage?: string;
          rejectedLogRecords?: number;
      }

      Properties

      errorMessage? +IExportLogsPartialSuccess | OpenTelemetry SDK
      interface IExportLogsPartialSuccess {
          errorMessage?: string;
          rejectedLogRecords?: number;
      }

      Properties

      errorMessage?: string

      ExportLogsPartialSuccess errorMessage

      -
      rejectedLogRecords?: number

      ExportLogsPartialSuccess rejectedLogRecords

      -
      +
      rejectedLogRecords?: number

      ExportLogsPartialSuccess rejectedLogRecords

      +
    diff --git a/interfaces/_opentelemetry_otlp-transformer.IExportLogsServiceResponse.html b/interfaces/_opentelemetry_otlp-transformer.IExportLogsServiceResponse.html index 29d88a5b9..9bcf74095 100644 --- a/interfaces/_opentelemetry_otlp-transformer.IExportLogsServiceResponse.html +++ b/interfaces/_opentelemetry_otlp-transformer.IExportLogsServiceResponse.html @@ -1,3 +1,3 @@ -IExportLogsServiceResponse | OpenTelemetry SDK
    interface IExportLogsServiceResponse {
        partialSuccess?: IExportLogsPartialSuccess;
    }

    Properties

    partialSuccess? +IExportLogsServiceResponse | OpenTelemetry SDK
    interface IExportLogsServiceResponse {
        partialSuccess?: IExportLogsPartialSuccess;
    }

    Properties

    Properties

    partialSuccess?: IExportLogsPartialSuccess

    ExportLogsServiceResponse partialSuccess

    -
    +
    diff --git a/interfaces/_opentelemetry_otlp-transformer.IExportMetricsPartialSuccess.html b/interfaces/_opentelemetry_otlp-transformer.IExportMetricsPartialSuccess.html index 2da1ac6be..407c3099d 100644 --- a/interfaces/_opentelemetry_otlp-transformer.IExportMetricsPartialSuccess.html +++ b/interfaces/_opentelemetry_otlp-transformer.IExportMetricsPartialSuccess.html @@ -1,5 +1,5 @@ -IExportMetricsPartialSuccess | OpenTelemetry SDK
    interface IExportMetricsPartialSuccess {
        errorMessage?: string;
        rejectedDataPoints?: number;
    }

    Properties

    errorMessage? +IExportMetricsPartialSuccess | OpenTelemetry SDK
    interface IExportMetricsPartialSuccess {
        errorMessage?: string;
        rejectedDataPoints?: number;
    }

    Properties

    errorMessage?: string

    ExportMetricsPartialSuccess errorMessage

    -
    rejectedDataPoints?: number

    ExportMetricsPartialSuccess rejectedDataPoints

    -
    +
    rejectedDataPoints?: number

    ExportMetricsPartialSuccess rejectedDataPoints

    +
    diff --git a/interfaces/_opentelemetry_otlp-transformer.IExportMetricsServiceResponse.html b/interfaces/_opentelemetry_otlp-transformer.IExportMetricsServiceResponse.html index 783e12114..9664c38c4 100644 --- a/interfaces/_opentelemetry_otlp-transformer.IExportMetricsServiceResponse.html +++ b/interfaces/_opentelemetry_otlp-transformer.IExportMetricsServiceResponse.html @@ -1,3 +1,3 @@ -IExportMetricsServiceResponse | OpenTelemetry SDK
    interface IExportMetricsServiceResponse {
        partialSuccess?: IExportMetricsPartialSuccess;
    }

    Properties

    partialSuccess? +IExportMetricsServiceResponse | OpenTelemetry SDK
    interface IExportMetricsServiceResponse {
        partialSuccess?: IExportMetricsPartialSuccess;
    }

    Properties

    Properties

    ExportMetricsServiceResponse partialSuccess

    -
    +
    diff --git a/interfaces/_opentelemetry_otlp-transformer.IExportTracePartialSuccess.html b/interfaces/_opentelemetry_otlp-transformer.IExportTracePartialSuccess.html index e75a07ef3..69eac0c06 100644 --- a/interfaces/_opentelemetry_otlp-transformer.IExportTracePartialSuccess.html +++ b/interfaces/_opentelemetry_otlp-transformer.IExportTracePartialSuccess.html @@ -1,5 +1,5 @@ -IExportTracePartialSuccess | OpenTelemetry SDK
    interface IExportTracePartialSuccess {
        errorMessage?: string;
        rejectedSpans?: number;
    }

    Properties

    errorMessage? +IExportTracePartialSuccess | OpenTelemetry SDK
    interface IExportTracePartialSuccess {
        errorMessage?: string;
        rejectedSpans?: number;
    }

    Properties

    errorMessage?: string

    ExportLogsServiceResponse errorMessage

    -
    rejectedSpans?: number

    ExportLogsServiceResponse rejectedLogRecords

    -
    +
    rejectedSpans?: number

    ExportLogsServiceResponse rejectedLogRecords

    +
    diff --git a/interfaces/_opentelemetry_otlp-transformer.IExportTraceServiceResponse.html b/interfaces/_opentelemetry_otlp-transformer.IExportTraceServiceResponse.html index 06629adce..0b606ce90 100644 --- a/interfaces/_opentelemetry_otlp-transformer.IExportTraceServiceResponse.html +++ b/interfaces/_opentelemetry_otlp-transformer.IExportTraceServiceResponse.html @@ -1,3 +1,3 @@ -IExportTraceServiceResponse | OpenTelemetry SDK
    interface IExportTraceServiceResponse {
        partialSuccess?: IExportTracePartialSuccess;
    }

    Properties

    partialSuccess? +IExportTraceServiceResponse | OpenTelemetry SDK
    interface IExportTraceServiceResponse {
        partialSuccess?: IExportTracePartialSuccess;
    }

    Properties

    Properties

    ExportTraceServiceResponse partialSuccess

    -
    +
    diff --git a/interfaces/_opentelemetry_otlp-transformer.ISerializer.html b/interfaces/_opentelemetry_otlp-transformer.ISerializer.html index 355182d37..099391f58 100644 --- a/interfaces/_opentelemetry_otlp-transformer.ISerializer.html +++ b/interfaces/_opentelemetry_otlp-transformer.ISerializer.html @@ -1,4 +1,4 @@ ISerializer | OpenTelemetry SDK

    Interface ISerializer<Request, Response>

    Serializes and deserializes the OTLP request/response to and from Uint8Array

    -
    interface ISerializer<Request, Response> {
        deserializeResponse(data: Uint8Array): Response;
        serializeRequest(request: Request): undefined | Uint8Array;
    }

    Type Parameters

    • Request
    • Response

    Methods

    interface ISerializer<Request, Response> {
        deserializeResponse(data: Uint8Array): Response;
        serializeRequest(request: Request): undefined | Uint8Array;
    }

    Type Parameters

    • Request
    • Response

    Methods

    +

    Methods

    diff --git a/interfaces/_opentelemetry_propagator-b3.B3PropagatorConfig.html b/interfaces/_opentelemetry_propagator-b3.B3PropagatorConfig.html index 8c8fd272c..d661de353 100644 --- a/interfaces/_opentelemetry_propagator-b3.B3PropagatorConfig.html +++ b/interfaces/_opentelemetry_propagator-b3.B3PropagatorConfig.html @@ -1,3 +1,3 @@ B3PropagatorConfig | OpenTelemetry SDK

    Configuration for the B3Propagator

    -
    interface B3PropagatorConfig {
        injectEncoding?: B3InjectEncoding;
    }

    Properties

    Properties

    injectEncoding?: B3InjectEncoding
    +
    interface B3PropagatorConfig {
        injectEncoding?: B3InjectEncoding;
    }

    Properties

    Properties

    injectEncoding?: B3InjectEncoding
    diff --git a/interfaces/_opentelemetry_resources.Resource.html b/interfaces/_opentelemetry_resources.Resource.html index 5d132a427..cd9687d5b 100644 --- a/interfaces/_opentelemetry_resources.Resource.html +++ b/interfaces/_opentelemetry_resources.Resource.html @@ -7,7 +7,7 @@ collected.

  • defaultResource
  • detectResources
  • -
    interface Resource {
        asyncAttributesPending?: boolean;
        attributes: Attributes;
        getRawAttributes(): RawResourceAttribute[];
        merge(other: null | Resource): Resource;
        waitForAsyncAttributes(): Promise<void>;
    }

    Properties

    interface Resource {
        asyncAttributesPending?: boolean;
        attributes: Attributes;
        getRawAttributes(): RawResourceAttribute[];
        merge(other: null | Resource): Resource;
        waitForAsyncAttributes(): Promise<void>;
    }

    Properties

    Methods

    getRawAttributes merge @@ -15,13 +15,13 @@ collected.

    Properties

    asyncAttributesPending?: boolean

    Check if async attributes have resolved. This is useful to avoid awaiting waitForAsyncAttributes (which will introduce asynchronous behavior) when not necessary.

    true if the resource "attributes" property is not yet settled to its final value

    -
    attributes: Attributes

    the Resource's attributes.

    -

    Methods

    attributes: Attributes

    the Resource's attributes.

    +

    Methods

    • Returns a new, merged Resource by merging the current Resource with the other Resource. In case of a collision, other Resource takes precedence.

      Parameters

      • other: null | Resource

        the Resource that will be merged with this.

      Returns Resource

      the newly merged Resource.

      -
    • Returns a promise that will never be rejected. Resolves when all async attributes have finished being added to +

    • Returns a promise that will never be rejected. Resolves when all async attributes have finished being added to this Resource's attributes. This is useful in exporters to block until resource detection has finished.

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/interfaces/_opentelemetry_resources.ResourceDetectionConfig.html b/interfaces/_opentelemetry_resources.ResourceDetectionConfig.html index 922210785..b1b8076c2 100644 --- a/interfaces/_opentelemetry_resources.ResourceDetectionConfig.html +++ b/interfaces/_opentelemetry_resources.ResourceDetectionConfig.html @@ -1,3 +1,3 @@ ResourceDetectionConfig | OpenTelemetry SDK

    ResourceDetectionConfig provides an interface for configuring resource auto-detection.

    -
    interface ResourceDetectionConfig {
        detectors?: ResourceDetector[];
    }

    Properties

    Properties

    detectors?: ResourceDetector[]
    +
    interface ResourceDetectionConfig {
        detectors?: ResourceDetector[];
    }

    Properties

    Properties

    detectors?: ResourceDetector[]
    diff --git a/interfaces/_opentelemetry_resources.ResourceDetector.html b/interfaces/_opentelemetry_resources.ResourceDetector.html index 252ce7b9c..6eeb4a50b 100644 --- a/interfaces/_opentelemetry_resources.ResourceDetector.html +++ b/interfaces/_opentelemetry_resources.ResourceDetector.html @@ -1,7 +1,7 @@ ResourceDetector | OpenTelemetry SDK

    Interface for a Resource Detector. A resource detector returns a set of detected resource attributes. A detected resource attribute may be an AttributeValue or a Promise of an AttributeValue.

    -
    interface ResourceDetector {
        detect(config?: ResourceDetectionConfig): DetectedResource;
    }

    Methods

    interface ResourceDetector {
        detect(config?: ResourceDetectionConfig): DetectedResource;
    }

    Methods

    Methods

    +
    diff --git a/interfaces/_opentelemetry_sampler-jaeger-remote.ProbabilisticSamplingOptions.html b/interfaces/_opentelemetry_sampler-jaeger-remote.ProbabilisticSamplingOptions.html index ef147d519..1d002cc75 100644 --- a/interfaces/_opentelemetry_sampler-jaeger-remote.ProbabilisticSamplingOptions.html +++ b/interfaces/_opentelemetry_sampler-jaeger-remote.ProbabilisticSamplingOptions.html @@ -1,4 +1,4 @@ ProbabilisticSamplingOptions | OpenTelemetry SDK

    Interface for probabilistic sampling options.

    -
    interface ProbabilisticSamplingOptions {
        samplingRate: number;
    }

    Properties

    interface ProbabilisticSamplingOptions {
        samplingRate: number;
    }

    Properties

    Properties

    samplingRate: number

    The sampling rate, typically a number between 0 and 1

    -
    +
    diff --git a/interfaces/_opentelemetry_sdk-logs.BatchLogRecordProcessorBrowserConfig.html b/interfaces/_opentelemetry_sdk-logs.BatchLogRecordProcessorBrowserConfig.html index f7f7213b5..296090220 100644 --- a/interfaces/_opentelemetry_sdk-logs.BatchLogRecordProcessorBrowserConfig.html +++ b/interfaces/_opentelemetry_sdk-logs.BatchLogRecordProcessorBrowserConfig.html @@ -1,17 +1,17 @@ BatchLogRecordProcessorBrowserConfig | OpenTelemetry SDK

    Interface configuration for a buffer.

    -
    interface BatchLogRecordProcessorBrowserConfig {
        disableAutoFlushOnDocumentHide?: boolean;
        exportTimeoutMillis?: number;
        maxExportBatchSize?: number;
        maxQueueSize?: number;
        scheduledDelayMillis?: number;
    }

    Hierarchy (View Summary)

    Properties

    interface BatchLogRecordProcessorBrowserConfig {
        disableAutoFlushOnDocumentHide?: boolean;
        exportTimeoutMillis?: number;
        maxExportBatchSize?: number;
        maxQueueSize?: number;
        scheduledDelayMillis?: number;
    }

    Hierarchy (View Summary)

    Properties

    disableAutoFlushOnDocumentHide?: boolean

    Disable flush when a user navigates to a new page, closes the tab or the browser, or, on mobile, switches to a different app. Auto flush is enabled by default.

    -
    exportTimeoutMillis?: number

    How long the export can run before it is cancelled. +

    exportTimeoutMillis?: number

    How long the export can run before it is cancelled. The default value is 30000ms

    -
    maxExportBatchSize?: number

    The maximum batch size of every export. It must be smaller or equal to +

    maxExportBatchSize?: number

    The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.

    -
    maxQueueSize?: number

    The maximum queue size. After the size is reached log records are dropped. +

    maxQueueSize?: number

    The maximum queue size. After the size is reached log records are dropped. The default value is 2048.

    -
    scheduledDelayMillis?: number

    The delay interval in milliseconds between two consecutive exports. +

    scheduledDelayMillis?: number

    The delay interval in milliseconds between two consecutive exports. The default value is 5000ms.

    -
    +
    diff --git a/interfaces/_opentelemetry_sdk-logs.BufferConfig.html b/interfaces/_opentelemetry_sdk-logs.BufferConfig.html index 95dab83ae..36f17a1c4 100644 --- a/interfaces/_opentelemetry_sdk-logs.BufferConfig.html +++ b/interfaces/_opentelemetry_sdk-logs.BufferConfig.html @@ -1,14 +1,14 @@ BufferConfig | OpenTelemetry SDK

    Interface configuration for a buffer.

    -
    interface BufferConfig {
        exportTimeoutMillis?: number;
        maxExportBatchSize?: number;
        maxQueueSize?: number;
        scheduledDelayMillis?: number;
    }

    Hierarchy (View Summary)

    Properties

    interface BufferConfig {
        exportTimeoutMillis?: number;
        maxExportBatchSize?: number;
        maxQueueSize?: number;
        scheduledDelayMillis?: number;
    }

    Hierarchy (View Summary)

    Properties

    exportTimeoutMillis?: number

    How long the export can run before it is cancelled. The default value is 30000ms

    -
    maxExportBatchSize?: number

    The maximum batch size of every export. It must be smaller or equal to +

    maxExportBatchSize?: number

    The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.

    -
    maxQueueSize?: number

    The maximum queue size. After the size is reached log records are dropped. +

    maxQueueSize?: number

    The maximum queue size. After the size is reached log records are dropped. The default value is 2048.

    -
    scheduledDelayMillis?: number

    The delay interval in milliseconds between two consecutive exports. +

    scheduledDelayMillis?: number

    The delay interval in milliseconds between two consecutive exports. The default value is 5000ms.

    -
    +
    diff --git a/interfaces/_opentelemetry_sdk-logs.LogRecordExporter.html b/interfaces/_opentelemetry_sdk-logs.LogRecordExporter.html index 521653aa0..1b5f0a51a 100644 --- a/interfaces/_opentelemetry_sdk-logs.LogRecordExporter.html +++ b/interfaces/_opentelemetry_sdk-logs.LogRecordExporter.html @@ -1,6 +1,6 @@ -LogRecordExporter | OpenTelemetry SDK
    interface LogRecordExporter {
        export(
            logs: ReadableLogRecord[],
            resultCallback: (result: core.ExportResult) => void,
        ): void;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    export +LogRecordExporter | OpenTelemetry SDK
    interface LogRecordExporter {
        export(
            logs: ReadableLogRecord[],
            resultCallback: (result: core.ExportResult) => void,
        ): void;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    +
  • resultCallback: (result: core.ExportResult) => void
  • Returns void

    diff --git a/interfaces/_opentelemetry_sdk-logs.LogRecordLimits.html b/interfaces/_opentelemetry_sdk-logs.LogRecordLimits.html index f7a5b4b82..a0d6391b8 100644 --- a/interfaces/_opentelemetry_sdk-logs.LogRecordLimits.html +++ b/interfaces/_opentelemetry_sdk-logs.LogRecordLimits.html @@ -1,5 +1,5 @@ -LogRecordLimits | OpenTelemetry SDK
    interface LogRecordLimits {
        attributeCountLimit?: number;
        attributeValueLengthLimit?: number;
    }

    Properties

    attributeCountLimit? +LogRecordLimits | OpenTelemetry SDK
    interface LogRecordLimits {
        attributeCountLimit?: number;
        attributeValueLengthLimit?: number;
    }

    Properties

    attributeCountLimit?: number

    attributeCountLimit is number of attributes per LogRecord

    -
    attributeValueLengthLimit?: number

    attributeValueLengthLimit is maximum allowed attribute value size

    -
    +
    attributeValueLengthLimit?: number

    attributeValueLengthLimit is maximum allowed attribute value size

    +
    diff --git a/interfaces/_opentelemetry_sdk-logs.LogRecordProcessor.html b/interfaces/_opentelemetry_sdk-logs.LogRecordProcessor.html index 9fd3a2008..0f0395a5a 100644 --- a/interfaces/_opentelemetry_sdk-logs.LogRecordProcessor.html +++ b/interfaces/_opentelemetry_sdk-logs.LogRecordProcessor.html @@ -1,10 +1,10 @@ -LogRecordProcessor | OpenTelemetry SDK
    interface LogRecordProcessor {
        forceFlush(): Promise<void>;
        onEmit(logRecord: LogRecord, context?: Context): void;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    forceFlush +LogRecordProcessor | OpenTelemetry SDK
    interface LogRecordProcessor {
        forceFlush(): Promise<void>;
        onEmit(logRecord: LogRecord, context?: Context): void;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    • Forces to export all finished log records

      -

      Returns Promise<void>

    • Called when a LogRecord is emit

      Parameters

      • logRecord: LogRecord

        the ReadWriteLogRecord that just emitted.

      • Optionalcontext: Context

        the current Context, or an empty Context if the Logger was obtained with include_trace_context=false

        -

      Returns void

    • Shuts down the processor. Called when SDK is shut down. This is an +

    Returns void

    • Shuts down the processor. Called when SDK is shut down. This is an opportunity for processor to do any cleanup required.

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/interfaces/_opentelemetry_sdk-logs.LoggerProviderConfig.html b/interfaces/_opentelemetry_sdk-logs.LoggerProviderConfig.html index 730c9d336..c6443d721 100644 --- a/interfaces/_opentelemetry_sdk-logs.LoggerProviderConfig.html +++ b/interfaces/_opentelemetry_sdk-logs.LoggerProviderConfig.html @@ -1,10 +1,10 @@ -LoggerProviderConfig | OpenTelemetry SDK
    interface LoggerProviderConfig {
        forceFlushTimeoutMillis?: number;
        logRecordLimits?: LogRecordLimits;
        processors?: LogRecordProcessor[];
        resource?: resources.Resource;
    }

    Properties

    forceFlushTimeoutMillis? +LoggerProviderConfig | OpenTelemetry SDK
    interface LoggerProviderConfig {
        forceFlushTimeoutMillis?: number;
        logRecordLimits?: LogRecordLimits;
        processors?: LogRecordProcessor[];
        resource?: resources.Resource;
    }

    Properties

    forceFlushTimeoutMillis?: number

    How long the forceFlush can run before it is cancelled. The default value is 30000ms

    -
    logRecordLimits?: LogRecordLimits

    Log Record Limits

    -
    processors?: LogRecordProcessor[]

    Log Record Processors

    -
    resource?: resources.Resource

    Resource associated with trace telemetry

    -
    +
    logRecordLimits?: LogRecordLimits

    Log Record Limits

    +
    processors?: LogRecordProcessor[]

    Log Record Processors

    +
    resource?: resources.Resource

    Resource associated with trace telemetry

    +
    diff --git a/interfaces/_opentelemetry_sdk-logs.ReadableLogRecord.html b/interfaces/_opentelemetry_sdk-logs.ReadableLogRecord.html index fcc052411..50c731dd9 100644 --- a/interfaces/_opentelemetry_sdk-logs.ReadableLogRecord.html +++ b/interfaces/_opentelemetry_sdk-logs.ReadableLogRecord.html @@ -1,4 +1,4 @@ -ReadableLogRecord | OpenTelemetry SDK
    interface ReadableLogRecord {
        attributes: AnyValueMap;
        body?: AnyValue;
        droppedAttributesCount: number;
        hrTime: HrTime;
        hrTimeObserved: HrTime;
        instrumentationScope: core.InstrumentationScope;
        resource: resources.Resource;
        severityNumber?: SeverityNumber;
        severityText?: string;
        spanContext?: SpanContext;
    }

    Implemented by

    Properties

    attributes +ReadableLogRecord | OpenTelemetry SDK
    interface ReadableLogRecord {
        attributes: AnyValueMap;
        body?: AnyValue;
        droppedAttributesCount: number;
        hrTime: HrTime;
        hrTimeObserved: HrTime;
        instrumentationScope: core.InstrumentationScope;
        resource: resources.Resource;
        severityNumber?: SeverityNumber;
        severityText?: string;
        spanContext?: SpanContext;
    }

    Implemented by

    Properties

    attributes: AnyValueMap
    body?: AnyValue
    droppedAttributesCount: number
    hrTime: HrTime
    hrTimeObserved: HrTime
    instrumentationScope: core.InstrumentationScope
    severityNumber?: SeverityNumber
    severityText?: string
    spanContext?: SpanContext
    +

    Properties

    attributes: AnyValueMap
    body?: AnyValue
    droppedAttributesCount: number
    hrTime: HrTime
    hrTimeObserved: HrTime
    instrumentationScope: core.InstrumentationScope
    severityNumber?: SeverityNumber
    severityText?: string
    spanContext?: SpanContext
    diff --git a/interfaces/_opentelemetry_sdk-metrics.CollectionResult.html b/interfaces/_opentelemetry_sdk-metrics.CollectionResult.html index a7f86e9b0..67864f8b6 100644 --- a/interfaces/_opentelemetry_sdk-metrics.CollectionResult.html +++ b/interfaces/_opentelemetry_sdk-metrics.CollectionResult.html @@ -2,8 +2,8 @@ non-critical errors in the collection, like throwing in a single observable callback, these errors are aggregated in the CollectionResult.errors array and other successfully collected metrics are returned.

    -
    interface CollectionResult {
        errors: unknown[];
        resourceMetrics: ResourceMetrics;
    }

    Properties

    interface CollectionResult {
        errors: unknown[];
        resourceMetrics: ResourceMetrics;
    }

    Properties

    errors: unknown[]

    Arbitrary JavaScript exception values.

    -
    resourceMetrics: ResourceMetrics

    Collected metrics.

    -
    +
    resourceMetrics: ResourceMetrics

    Collected metrics.

    +
    diff --git a/interfaces/_opentelemetry_sdk-metrics.DataPoint.html b/interfaces/_opentelemetry_sdk-metrics.DataPoint.html index 9d5c65cac..3d2e67e7c 100644 --- a/interfaces/_opentelemetry_sdk-metrics.DataPoint.html +++ b/interfaces/_opentelemetry_sdk-metrics.DataPoint.html @@ -1,15 +1,15 @@ DataPoint | OpenTelemetry SDK

    Represents an aggregated point data with start time, end time and their associated attributes and points.

    -
    interface DataPoint<T> {
        attributes: Attributes;
        endTime: HrTime;
        startTime: HrTime;
        value: T;
    }

    Type Parameters

    • T

    Properties

    interface DataPoint<T> {
        attributes: Attributes;
        endTime: HrTime;
        startTime: HrTime;
        value: T;
    }

    Type Parameters

    • T

    Properties

    attributes: Attributes

    The attributes associated with this DataPoint.

    -
    endTime: HrTime

    The end epoch timestamp when data were collected, usually it represents +

    endTime: HrTime

    The end epoch timestamp when data were collected, usually it represents the moment when MetricReader.collect was called.

    -
    startTime: HrTime

    The start epoch timestamp of the DataPoint, usually the time when +

    startTime: HrTime

    The start epoch timestamp of the DataPoint, usually the time when the metric was created when the preferred AggregationTemporality is CUMULATIVE, or last collection time otherwise.

    -
    value: T

    The value for this DataPoint. The type of the value is indicated by the +

    value: T

    The value for this DataPoint. The type of the value is indicated by the DataPointType.

    -
    +
    diff --git a/interfaces/_opentelemetry_sdk-metrics.ExponentialHistogram.html b/interfaces/_opentelemetry_sdk-metrics.ExponentialHistogram.html index 4d66cb439..47282a589 100644 --- a/interfaces/_opentelemetry_sdk-metrics.ExponentialHistogram.html +++ b/interfaces/_opentelemetry_sdk-metrics.ExponentialHistogram.html @@ -1,5 +1,5 @@ ExponentialHistogram | OpenTelemetry SDK

    DataPoint value type for ExponentialHistogramAggregation.

    -
    interface ExponentialHistogram {
        count: number;
        max?: number;
        min?: number;
        negative: { bucketCounts: number[]; offset: number };
        positive: { bucketCounts: number[]; offset: number };
        scale: number;
        sum?: number;
        zeroCount: number;
    }

    Properties

    interface ExponentialHistogram {
        count: number;
        max?: number;
        min?: number;
        negative: { bucketCounts: number[]; offset: number };
        positive: { bucketCounts: number[]; offset: number };
        scale: number;
        sum?: number;
        zeroCount: number;
    }

    Properties

    Properties

    count: number
    max?: number
    min?: number
    negative: { bucketCounts: number[]; offset: number }
    positive: { bucketCounts: number[]; offset: number }
    scale: number
    sum?: number
    zeroCount: number
    +

    Properties

    count: number
    max?: number
    min?: number
    negative: { bucketCounts: number[]; offset: number }
    positive: { bucketCounts: number[]; offset: number }
    scale: number
    sum?: number
    zeroCount: number
    diff --git a/interfaces/_opentelemetry_sdk-metrics.ExponentialHistogramMetricData.html b/interfaces/_opentelemetry_sdk-metrics.ExponentialHistogramMetricData.html index 921886862..9dec2bed0 100644 --- a/interfaces/_opentelemetry_sdk-metrics.ExponentialHistogramMetricData.html +++ b/interfaces/_opentelemetry_sdk-metrics.ExponentialHistogramMetricData.html @@ -1,7 +1,7 @@ ExponentialHistogramMetricData | OpenTelemetry SDK

    Represents a metric data aggregated by a ExponentialHistogramAggregation.

    -
    interface ExponentialHistogramMetricData {
        aggregationTemporality: AggregationTemporality;
        dataPoints: DataPoint<ExponentialHistogram>[];
        dataPointType: EXPONENTIAL_HISTOGRAM;
        descriptor: MetricDescriptor;
    }

    Hierarchy

    • BaseMetricData
      • ExponentialHistogramMetricData

    Properties

    interface ExponentialHistogramMetricData {
        aggregationTemporality: AggregationTemporality;
        dataPoints: DataPoint<ExponentialHistogram>[];
        dataPointType: EXPONENTIAL_HISTOGRAM;
        descriptor: MetricDescriptor;
    }

    Hierarchy

    • BaseMetricData
      • ExponentialHistogramMetricData

    Properties

    aggregationTemporality: AggregationTemporality
    dataPointType: EXPONENTIAL_HISTOGRAM

    DataPointType of the metric instrument.

    -
    descriptor: MetricDescriptor
    +

    Properties

    aggregationTemporality: AggregationTemporality
    dataPointType: EXPONENTIAL_HISTOGRAM

    DataPointType of the metric instrument.

    +
    descriptor: MetricDescriptor
    diff --git a/interfaces/_opentelemetry_sdk-metrics.GaugeMetricData.html b/interfaces/_opentelemetry_sdk-metrics.GaugeMetricData.html index 500842708..b6084eb72 100644 --- a/interfaces/_opentelemetry_sdk-metrics.GaugeMetricData.html +++ b/interfaces/_opentelemetry_sdk-metrics.GaugeMetricData.html @@ -1,6 +1,6 @@ -GaugeMetricData | OpenTelemetry SDK
    interface GaugeMetricData {
        aggregationTemporality: AggregationTemporality;
        dataPoints: DataPoint<number>[];
        dataPointType: GAUGE;
        descriptor: MetricDescriptor;
    }

    Hierarchy

    • BaseMetricData
      • GaugeMetricData

    Properties

    aggregationTemporality +GaugeMetricData | OpenTelemetry SDK
    interface GaugeMetricData {
        aggregationTemporality: AggregationTemporality;
        dataPoints: DataPoint<number>[];
        dataPointType: GAUGE;
        descriptor: MetricDescriptor;
    }

    Hierarchy

    • BaseMetricData
      • GaugeMetricData

    Properties

    aggregationTemporality: AggregationTemporality
    dataPoints: DataPoint<number>[]
    dataPointType: GAUGE

    DataPointType of the metric instrument.

    -
    descriptor: MetricDescriptor
    +

    Properties

    aggregationTemporality: AggregationTemporality
    dataPoints: DataPoint<number>[]
    dataPointType: GAUGE

    DataPointType of the metric instrument.

    +
    descriptor: MetricDescriptor
    diff --git a/interfaces/_opentelemetry_sdk-metrics.Histogram.html b/interfaces/_opentelemetry_sdk-metrics.Histogram.html index f9f469a73..5b30f7f18 100644 --- a/interfaces/_opentelemetry_sdk-metrics.Histogram.html +++ b/interfaces/_opentelemetry_sdk-metrics.Histogram.html @@ -1,5 +1,5 @@ Histogram | OpenTelemetry SDK

    DataPoint value type for HistogramAggregation.

    -
    interface Histogram {
        buckets: { boundaries: number[]; counts: number[] };
        count: number;
        max?: number;
        min?: number;
        sum?: number;
    }

    Properties

    interface Histogram {
        buckets: { boundaries: number[]; counts: number[] };
        count: number;
        max?: number;
        min?: number;
        sum?: number;
    }

    Properties

    buckets count max? min? @@ -17,4 +17,4 @@ with the boundaries [ 10, 20, 30 ], we will have the following state:

    boundaries: [10, 20, 30], counts: [3, 3, 2, 1], }

    -
    count: number
    max?: number
    min?: number
    sum?: number
    +
    count: number
    max?: number
    min?: number
    sum?: number
    diff --git a/interfaces/_opentelemetry_sdk-metrics.HistogramMetricData.html b/interfaces/_opentelemetry_sdk-metrics.HistogramMetricData.html index b31d71b8d..6db54b7e9 100644 --- a/interfaces/_opentelemetry_sdk-metrics.HistogramMetricData.html +++ b/interfaces/_opentelemetry_sdk-metrics.HistogramMetricData.html @@ -1,7 +1,7 @@ HistogramMetricData | OpenTelemetry SDK

    Represents a metric data aggregated by a HistogramAggregation.

    -
    interface HistogramMetricData {
        aggregationTemporality: AggregationTemporality;
        dataPoints: DataPoint<Histogram>[];
        dataPointType: HISTOGRAM;
        descriptor: MetricDescriptor;
    }

    Hierarchy

    • BaseMetricData
      • HistogramMetricData

    Properties

    interface HistogramMetricData {
        aggregationTemporality: AggregationTemporality;
        dataPoints: DataPoint<Histogram>[];
        dataPointType: HISTOGRAM;
        descriptor: MetricDescriptor;
    }

    Hierarchy

    • BaseMetricData
      • HistogramMetricData

    Properties

    aggregationTemporality: AggregationTemporality
    dataPoints: DataPoint<Histogram>[]
    dataPointType: HISTOGRAM

    DataPointType of the metric instrument.

    -
    descriptor: MetricDescriptor
    +

    Properties

    aggregationTemporality: AggregationTemporality
    dataPoints: DataPoint<Histogram>[]
    dataPointType: HISTOGRAM

    DataPointType of the metric instrument.

    +
    descriptor: MetricDescriptor
    diff --git a/interfaces/_opentelemetry_sdk-metrics.IAttributesProcessor.html b/interfaces/_opentelemetry_sdk-metrics.IAttributesProcessor.html index 816533c21..394c7c13f 100644 --- a/interfaces/_opentelemetry_sdk-metrics.IAttributesProcessor.html +++ b/interfaces/_opentelemetry_sdk-metrics.IAttributesProcessor.html @@ -1,9 +1,9 @@ IAttributesProcessor | OpenTelemetry SDK

    The AttributesProcessor is responsible for customizing which attribute(s) are to be reported as metrics dimension(s) and adding additional dimension(s) from the Context.

    -
    interface IAttributesProcessor {
        process: (incoming: Attributes, context?: Context) => Attributes;
    }

    Properties

    interface IAttributesProcessor {
        process: (incoming: Attributes, context?: Context) => Attributes;
    }

    Properties

    Properties

    process: (incoming: Attributes, context?: Context) => Attributes

    Process the metric instrument attributes.

    Type declaration

    +

    Returns Attributes

    diff --git a/interfaces/_opentelemetry_sdk-metrics.IMetricReader.html b/interfaces/_opentelemetry_sdk-metrics.IMetricReader.html index 455a1fdf8..ab2cbc427 100644 --- a/interfaces/_opentelemetry_sdk-metrics.IMetricReader.html +++ b/interfaces/_opentelemetry_sdk-metrics.IMetricReader.html @@ -1,7 +1,7 @@ IMetricReader | OpenTelemetry SDK

    Reads metrics from the SDK. Implementations MUST follow the Metric Reader Specification as well as the requirements listed in this interface. Consider extending MetricReader to get a specification-compliant base implementation of this interface

    -
    interface IMetricReader {
        collect(options?: CommonReaderOptions): Promise<CollectionResult>;
        forceFlush(options?: CommonReaderOptions): Promise<void>;
        selectAggregation(instrumentType: InstrumentType): AggregationOption;
        selectAggregationTemporality(
            instrumentType: InstrumentType,
        ): AggregationTemporality;
        selectCardinalityLimit(instrumentType: InstrumentType): number;
        setMetricProducer(metricProducer: MetricProducer): void;
        shutdown(options?: CommonReaderOptions): Promise<void>;
    }

    Implemented by

    Methods

    interface IMetricReader {
        collect(options?: CommonReaderOptions): Promise<CollectionResult>;
        forceFlush(options?: CommonReaderOptions): Promise<void>;
        selectAggregation(instrumentType: InstrumentType): AggregationOption;
        selectAggregationTemporality(
            instrumentType: InstrumentType,
        ): AggregationTemporality;
        selectCardinalityLimit(instrumentType: InstrumentType): number;
        setMetricProducer(metricProducer: MetricProducer): void;
        shutdown(options?: CommonReaderOptions): Promise<void>;
    }

    Implemented by

    Methods

    • Flushes metrics read by this reader, the promise will reject after the optional timeout or resolve after completion.

      NOTE: this operation MAY continue even after the promise rejects due to a timeout.

      Parameters

      • Optionaloptions: CommonReaderOptions

        options with timeout.

        -

      Returns Promise<void>

    Returns Promise<void>

    • Shuts down the metric reader, the promise will reject after the optional timeout or resolve after completion.

      +

      NOTE: implementations MUST throw when called more than once

      Parameters

      Returns void

    • Shuts down the metric reader, the promise will reject after the optional timeout or resolve after completion.

      NOTE: this operation MAY continue even after the promise rejects due to a timeout.

      Parameters

      • Optionaloptions: CommonReaderOptions

        options with timeout.

        -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/interfaces/_opentelemetry_sdk-metrics.MeterProviderOptions.html b/interfaces/_opentelemetry_sdk-metrics.MeterProviderOptions.html index 8fa28fc17..3e1d2d61c 100644 --- a/interfaces/_opentelemetry_sdk-metrics.MeterProviderOptions.html +++ b/interfaces/_opentelemetry_sdk-metrics.MeterProviderOptions.html @@ -1,6 +1,6 @@ MeterProviderOptions | OpenTelemetry SDK

    MeterProviderOptions provides an interface for configuring a MeterProvider.

    -
    interface MeterProviderOptions {
        readers?: IMetricReader[];
        resource?: resources.Resource;
        views?: ViewOptions[];
    }

    Properties

    interface MeterProviderOptions {
        readers?: IMetricReader[];
        resource?: resources.Resource;
        views?: ViewOptions[];
    }

    Properties

    readers?: IMetricReader[]
    resource?: resources.Resource

    Resource associated with metric telemetry

    -
    views?: ViewOptions[]
    +

    Properties

    readers?: IMetricReader[]
    resource?: resources.Resource

    Resource associated with metric telemetry

    +
    views?: ViewOptions[]
    diff --git a/interfaces/_opentelemetry_sdk-metrics.MetricCollectOptions.html b/interfaces/_opentelemetry_sdk-metrics.MetricCollectOptions.html index bff5c5a2c..6fd9b8b60 100644 --- a/interfaces/_opentelemetry_sdk-metrics.MetricCollectOptions.html +++ b/interfaces/_opentelemetry_sdk-metrics.MetricCollectOptions.html @@ -1,7 +1,7 @@ -MetricCollectOptions | OpenTelemetry SDK
    interface MetricCollectOptions {
        timeoutMillis?: number;
    }

    Properties

    timeoutMillis? +MetricCollectOptions | OpenTelemetry SDK
    interface MetricCollectOptions {
        timeoutMillis?: number;
    }

    Properties

    Properties

    timeoutMillis?: number

    Timeout for the SDK to perform the involved asynchronous callback functions.

    If the callback functions failed to finish the observation in time, their results are discarded and an error is appended in the CollectionResult.errors.

    -
    +
    diff --git a/interfaces/_opentelemetry_sdk-metrics.MetricDescriptor.html b/interfaces/_opentelemetry_sdk-metrics.MetricDescriptor.html index 3ec9e6e70..de78e38ed 100644 --- a/interfaces/_opentelemetry_sdk-metrics.MetricDescriptor.html +++ b/interfaces/_opentelemetry_sdk-metrics.MetricDescriptor.html @@ -1,5 +1,5 @@ -MetricDescriptor | OpenTelemetry SDK
    interface MetricDescriptor {
        description: string;
        name: string;
        unit: string;
        valueType: ValueType;
    }

    Properties

    description +MetricDescriptor | OpenTelemetry SDK
    interface MetricDescriptor {
        description: string;
        name: string;
        unit: string;
        valueType: ValueType;
    }

    Properties

    description: string
    name: string
    unit: string
    valueType: ValueType
    +

    Properties

    description: string
    name: string
    unit: string
    valueType: ValueType
    diff --git a/interfaces/_opentelemetry_sdk-metrics.MetricProducer.html b/interfaces/_opentelemetry_sdk-metrics.MetricProducer.html index 74a097d93..358ac8525 100644 --- a/interfaces/_opentelemetry_sdk-metrics.MetricProducer.html +++ b/interfaces/_opentelemetry_sdk-metrics.MetricProducer.html @@ -1,5 +1,5 @@ MetricProducer | OpenTelemetry SDK

    This is a public interface that represent an export state of a IMetricReader.

    -
    interface MetricProducer {
        collect(options?: MetricCollectOptions): Promise<CollectionResult>;
    }

    Methods

    interface MetricProducer {
        collect(options?: MetricCollectOptions): Promise<CollectionResult>;
    }

    Methods

    Methods

    +

    Parameters

    Returns Promise<CollectionResult>

    diff --git a/interfaces/_opentelemetry_sdk-metrics.MetricReaderOptions.html b/interfaces/_opentelemetry_sdk-metrics.MetricReaderOptions.html index 935fbe55c..b6d617ccb 100644 --- a/interfaces/_opentelemetry_sdk-metrics.MetricReaderOptions.html +++ b/interfaces/_opentelemetry_sdk-metrics.MetricReaderOptions.html @@ -1,15 +1,15 @@ -MetricReaderOptions | OpenTelemetry SDK
    interface MetricReaderOptions {
        aggregationSelector?: AggregationSelector;
        aggregationTemporalitySelector?: AggregationTemporalitySelector;
        cardinalitySelector?: CardinalitySelector;
        metricProducers?: MetricProducer[];
    }

    Properties

    aggregationSelector? +MetricReaderOptions | OpenTelemetry SDK
    interface MetricReaderOptions {
        aggregationSelector?: AggregationSelector;
        aggregationTemporalitySelector?: AggregationTemporalitySelector;
        cardinalitySelector?: CardinalitySelector;
        metricProducers?: MetricProducer[];
    }

    Properties

    aggregationSelector?: AggregationSelector

    Aggregation selector based on metric instrument types. If no views are configured for a metric instrument, a per-metric-reader aggregation is selected with this selector.

    -

    NOTE: the provided function MUST be pure

    aggregationTemporalitySelector?: AggregationTemporalitySelector

    Aggregation temporality selector based on metric instrument types. If +

    NOTE: the provided function MUST be pure

    aggregationTemporalitySelector?: AggregationTemporalitySelector

    Aggregation temporality selector based on metric instrument types. If not configured, cumulative is used for all instruments.

    -

    NOTE: the provided function MUST be pure

    cardinalitySelector?: CardinalitySelector

    Cardinality selector based on metric instrument types. If not configured, +

    NOTE: the provided function MUST be pure

    cardinalitySelector?: CardinalitySelector

    Cardinality selector based on metric instrument types. If not configured, a default value is used.

    -

    NOTE: the provided function MUST be pure

    metricProducers?: MetricProducer[]

    Note, this option is experimental. Additional MetricProducers to use as a source of +

    NOTE: the provided function MUST be pure

    metricProducers?: MetricProducer[]

    Note, this option is experimental. Additional MetricProducers to use as a source of aggregated metric data in addition to the SDK's metric data. The resource returned by these MetricProducers is ignored; the SDK's resource will be used instead.

    -
    +
    diff --git a/interfaces/_opentelemetry_sdk-metrics.PushMetricExporter.html b/interfaces/_opentelemetry_sdk-metrics.PushMetricExporter.html index 85202fc12..99a1d6f7a 100644 --- a/interfaces/_opentelemetry_sdk-metrics.PushMetricExporter.html +++ b/interfaces/_opentelemetry_sdk-metrics.PushMetricExporter.html @@ -1,7 +1,7 @@ PushMetricExporter | OpenTelemetry SDK

    An interface that allows different metric services to export recorded data in their own format.

    To export data this MUST be registered to the Metrics SDK with a MetricReader.

    -
    interface PushMetricExporter {
        export(
            metrics: ResourceMetrics,
            resultCallback: (result: core.ExportResult) => void,
        ): void;
        forceFlush(): Promise<void>;
        selectAggregation(instrumentType: InstrumentType): AggregationOption;
        selectAggregationTemporality(
            instrumentType: InstrumentType,
        ): AggregationTemporality;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    interface PushMetricExporter {
        export(
            metrics: ResourceMetrics,
            resultCallback: (result: core.ExportResult) => void,
        ): void;
        forceFlush(): Promise<void>;
        selectAggregation(instrumentType: InstrumentType): AggregationOption;
        selectAggregationTemporality(
            instrumentType: InstrumentType,
        ): AggregationTemporality;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    export forceFlush selectAggregation? selectAggregationTemporality? @@ -9,13 +9,13 @@ in their own format.

    Methods

    • Ensure that the export of any metrics the exporter has received is +

    Returns void

    +

    Returns Promise<void>

    diff --git a/interfaces/_opentelemetry_sdk-metrics.ResourceMetrics.html b/interfaces/_opentelemetry_sdk-metrics.ResourceMetrics.html index c8f1b967b..c42a0cf76 100644 --- a/interfaces/_opentelemetry_sdk-metrics.ResourceMetrics.html +++ b/interfaces/_opentelemetry_sdk-metrics.ResourceMetrics.html @@ -1,3 +1,3 @@ -ResourceMetrics | OpenTelemetry SDK
    interface ResourceMetrics {
        resource: resources.Resource;
        scopeMetrics: ScopeMetrics[];
    }

    Properties

    resource +ResourceMetrics | OpenTelemetry SDK
    interface ResourceMetrics {
        resource: resources.Resource;
        scopeMetrics: ScopeMetrics[];
    }

    Properties

    scopeMetrics: ScopeMetrics[]
    +

    Properties

    scopeMetrics: ScopeMetrics[]
    diff --git a/interfaces/_opentelemetry_sdk-metrics.ScopeMetrics.html b/interfaces/_opentelemetry_sdk-metrics.ScopeMetrics.html index 504843723..f25517578 100644 --- a/interfaces/_opentelemetry_sdk-metrics.ScopeMetrics.html +++ b/interfaces/_opentelemetry_sdk-metrics.ScopeMetrics.html @@ -1,3 +1,3 @@ -ScopeMetrics | OpenTelemetry SDK
    interface ScopeMetrics {
        metrics: MetricData[];
        scope: core.InstrumentationScope;
    }

    Properties

    metrics +ScopeMetrics | OpenTelemetry SDK
    +

    Properties

    metrics: MetricData[]
    diff --git a/interfaces/_opentelemetry_sdk-metrics.SumMetricData.html b/interfaces/_opentelemetry_sdk-metrics.SumMetricData.html index d781d6243..21b22858a 100644 --- a/interfaces/_opentelemetry_sdk-metrics.SumMetricData.html +++ b/interfaces/_opentelemetry_sdk-metrics.SumMetricData.html @@ -1,9 +1,9 @@ SumMetricData | OpenTelemetry SDK

    Represents a metric data aggregated by either a LastValueAggregation or SumAggregation.

    -
    interface SumMetricData {
        aggregationTemporality: AggregationTemporality;
        dataPoints: DataPoint<number>[];
        dataPointType: SUM;
        descriptor: MetricDescriptor;
        isMonotonic: boolean;
    }

    Hierarchy

    • BaseMetricData
      • SumMetricData

    Properties

    interface SumMetricData {
        aggregationTemporality: AggregationTemporality;
        dataPoints: DataPoint<number>[];
        dataPointType: SUM;
        descriptor: MetricDescriptor;
        isMonotonic: boolean;
    }

    Hierarchy

    • BaseMetricData
      • SumMetricData

    Properties

    aggregationTemporality: AggregationTemporality
    dataPoints: DataPoint<number>[]
    dataPointType: SUM

    DataPointType of the metric instrument.

    -
    descriptor: MetricDescriptor
    isMonotonic: boolean
    +

    Properties

    aggregationTemporality: AggregationTemporality
    dataPoints: DataPoint<number>[]
    dataPointType: SUM

    DataPointType of the metric instrument.

    +
    descriptor: MetricDescriptor
    isMonotonic: boolean
    diff --git a/interfaces/_opentelemetry_sdk-node.NodeSDKConfiguration.html b/interfaces/_opentelemetry_sdk-node.NodeSDKConfiguration.html index d1f589a3a..37c57fe34 100644 --- a/interfaces/_opentelemetry_sdk-node.NodeSDKConfiguration.html +++ b/interfaces/_opentelemetry_sdk-node.NodeSDKConfiguration.html @@ -1,4 +1,4 @@ -NodeSDKConfiguration | OpenTelemetry SDK
    interface NodeSDKConfiguration {
        autoDetectResources: boolean;
        contextManager: @opentelemetry/api.ContextManager;
        idGenerator: node.IdGenerator;
        instrumentations: (
            | Instrumentation<InstrumentationConfig>
            | Instrumentation<InstrumentationConfig>[]
        )[];
        logRecordProcessor: logs.LogRecordProcessor;
        logRecordProcessors?: logs.LogRecordProcessor[];
        metricReader: metrics.IMetricReader;
        resource: resources.Resource;
        resourceDetectors: resources.ResourceDetector[];
        sampler: node.Sampler;
        serviceName?: string;
        spanLimits: node.SpanLimits;
        spanProcessor?: node.SpanProcessor;
        spanProcessors?: node.SpanProcessor[];
        textMapPropagator: @opentelemetry/api.TextMapPropagator;
        traceExporter: node.SpanExporter;
        views: metrics.ViewOptions[];
    }

    Properties

    autoDetectResources +NodeSDKConfiguration | OpenTelemetry SDK
    interface NodeSDKConfiguration {
        autoDetectResources: boolean;
        contextManager: @opentelemetry/api.ContextManager;
        idGenerator: node.IdGenerator;
        instrumentations: (
            | Instrumentation<InstrumentationConfig>
            | Instrumentation<InstrumentationConfig>[]
        )[];
        logRecordProcessor: logs.LogRecordProcessor;
        logRecordProcessors?: logs.LogRecordProcessor[];
        metricReader: metrics.IMetricReader;
        resource: resources.Resource;
        resourceDetectors: resources.ResourceDetector[];
        sampler: node.Sampler;
        serviceName?: string;
        spanLimits: node.SpanLimits;
        spanProcessor?: node.SpanProcessor;
        spanProcessors?: node.SpanProcessor[];
        textMapPropagator: @opentelemetry/api.TextMapPropagator;
        traceExporter: node.SpanExporter;
        views: metrics.ViewOptions[];
    }

    Properties

    autoDetectResources: boolean
    idGenerator: node.IdGenerator
    instrumentations: (
        | Instrumentation<InstrumentationConfig>
        | Instrumentation<InstrumentationConfig>[]
    )[]
    logRecordProcessor: logs.LogRecordProcessor

    use logRecordProcessors instead

    -
    logRecordProcessors?: logs.LogRecordProcessor[]
    metricReader: metrics.IMetricReader
    resourceDetectors: resources.ResourceDetector[]
    sampler: node.Sampler
    serviceName?: string
    spanLimits: node.SpanLimits
    spanProcessor?: node.SpanProcessor

    use spanProcessors instead

    -
    spanProcessors?: node.SpanProcessor[]
    traceExporter: node.SpanExporter
    +

    Properties

    autoDetectResources: boolean
    idGenerator: node.IdGenerator
    instrumentations: (
        | Instrumentation<InstrumentationConfig>
        | Instrumentation<InstrumentationConfig>[]
    )[]
    logRecordProcessor: logs.LogRecordProcessor

    use logRecordProcessors instead

    +
    logRecordProcessors?: logs.LogRecordProcessor[]
    metricReader: metrics.IMetricReader
    resourceDetectors: resources.ResourceDetector[]
    sampler: node.Sampler
    serviceName?: string
    spanLimits: node.SpanLimits
    spanProcessor?: node.SpanProcessor

    use spanProcessors instead

    +
    spanProcessors?: node.SpanProcessor[]
    traceExporter: node.SpanExporter
    diff --git a/interfaces/_opentelemetry_sdk-trace-base.BatchSpanProcessorBrowserConfig.html b/interfaces/_opentelemetry_sdk-trace-base.BatchSpanProcessorBrowserConfig.html index 9db7ce00c..713402eea 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.BatchSpanProcessorBrowserConfig.html +++ b/interfaces/_opentelemetry_sdk-trace-base.BatchSpanProcessorBrowserConfig.html @@ -1,17 +1,17 @@ BatchSpanProcessorBrowserConfig | OpenTelemetry SDK

    Interface configuration for BatchSpanProcessor on browser

    -
    interface BatchSpanProcessorBrowserConfig {
        disableAutoFlushOnDocumentHide?: boolean;
        exportTimeoutMillis?: number;
        maxExportBatchSize?: number;
        maxQueueSize?: number;
        scheduledDelayMillis?: number;
    }

    Hierarchy (View Summary)

    Properties

    interface BatchSpanProcessorBrowserConfig {
        disableAutoFlushOnDocumentHide?: boolean;
        exportTimeoutMillis?: number;
        maxExportBatchSize?: number;
        maxQueueSize?: number;
        scheduledDelayMillis?: number;
    }

    Hierarchy (View Summary)

    Properties

    disableAutoFlushOnDocumentHide?: boolean

    Disable flush when a user navigates to a new page, closes the tab or the browser, or, on mobile, switches to a different app. Auto flush is enabled by default.

    -
    exportTimeoutMillis?: number

    How long the export can run before it is cancelled. +

    exportTimeoutMillis?: number

    How long the export can run before it is cancelled. The default value is 30000ms

    -
    maxExportBatchSize?: number

    The maximum batch size of every export. It must be smaller or equal to +

    maxExportBatchSize?: number

    The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.

    -
    maxQueueSize?: number

    The maximum queue size. After the size is reached spans are dropped. +

    maxQueueSize?: number

    The maximum queue size. After the size is reached spans are dropped. The default value is 2048.

    -
    scheduledDelayMillis?: number

    The delay interval in milliseconds between two consecutive exports. +

    scheduledDelayMillis?: number

    The delay interval in milliseconds between two consecutive exports. The default value is 5000ms.

    -
    +
    diff --git a/interfaces/_opentelemetry_sdk-trace-base.BufferConfig.html b/interfaces/_opentelemetry_sdk-trace-base.BufferConfig.html index 9522f2d7e..058bda26d 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.BufferConfig.html +++ b/interfaces/_opentelemetry_sdk-trace-base.BufferConfig.html @@ -1,14 +1,14 @@ BufferConfig | OpenTelemetry SDK

    Interface configuration for a buffer.

    -
    interface BufferConfig {
        exportTimeoutMillis?: number;
        maxExportBatchSize?: number;
        maxQueueSize?: number;
        scheduledDelayMillis?: number;
    }

    Hierarchy (View Summary)

    Properties

    interface BufferConfig {
        exportTimeoutMillis?: number;
        maxExportBatchSize?: number;
        maxQueueSize?: number;
        scheduledDelayMillis?: number;
    }

    Hierarchy (View Summary)

    Properties

    exportTimeoutMillis?: number

    How long the export can run before it is cancelled. The default value is 30000ms

    -
    maxExportBatchSize?: number

    The maximum batch size of every export. It must be smaller or equal to +

    maxExportBatchSize?: number

    The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.

    -
    maxQueueSize?: number

    The maximum queue size. After the size is reached spans are dropped. +

    maxQueueSize?: number

    The maximum queue size. After the size is reached spans are dropped. The default value is 2048.

    -
    scheduledDelayMillis?: number

    The delay interval in milliseconds between two consecutive exports. +

    scheduledDelayMillis?: number

    The delay interval in milliseconds between two consecutive exports. The default value is 5000ms.

    -
    +
    diff --git a/interfaces/_opentelemetry_sdk-trace-base.GeneralLimits.html b/interfaces/_opentelemetry_sdk-trace-base.GeneralLimits.html index fd885fc03..2ee7527d0 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.GeneralLimits.html +++ b/interfaces/_opentelemetry_sdk-trace-base.GeneralLimits.html @@ -1,6 +1,6 @@ GeneralLimits | OpenTelemetry SDK

    Global configuration limits of trace service

    -
    interface GeneralLimits {
        attributeCountLimit?: number;
        attributeValueLengthLimit?: number;
    }

    Properties

    interface GeneralLimits {
        attributeCountLimit?: number;
        attributeValueLengthLimit?: number;
    }

    Properties

    attributeCountLimit?: number

    attributeCountLimit is number of attributes per trace

    -
    attributeValueLengthLimit?: number

    attributeValueLengthLimit is maximum allowed attribute value size

    -
    +
    attributeValueLengthLimit?: number

    attributeValueLengthLimit is maximum allowed attribute value size

    +
    diff --git a/interfaces/_opentelemetry_sdk-trace-base.IdGenerator.html b/interfaces/_opentelemetry_sdk-trace-base.IdGenerator.html index 7613a0aa5..3c2a80a35 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.IdGenerator.html +++ b/interfaces/_opentelemetry_sdk-trace-base.IdGenerator.html @@ -1,6 +1,6 @@ IdGenerator | OpenTelemetry SDK

    IdGenerator provides an interface for generating Trace Id and Span Id

    -
    interface IdGenerator {
        generateSpanId(): string;
        generateTraceId(): string;
    }

    Implemented by

    Methods

    interface IdGenerator {
        generateSpanId(): string;
        generateTraceId(): string;
    }

    Implemented by

    Methods

    • Returns a span ID composed of 16 lowercase hex characters.

      -

      Returns string

    • Returns a trace ID composed of 32 lowercase hex characters.

      -

      Returns string

    +

    Returns string

    • Returns a trace ID composed of 32 lowercase hex characters.

      +

      Returns string

    diff --git a/interfaces/_opentelemetry_sdk-trace-base.ReadableSpan.html b/interfaces/_opentelemetry_sdk-trace-base.ReadableSpan.html index c99ebe7a8..b09bd10b8 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.ReadableSpan.html +++ b/interfaces/_opentelemetry_sdk-trace-base.ReadableSpan.html @@ -1,4 +1,4 @@ -ReadableSpan | OpenTelemetry SDK
    interface ReadableSpan {
        attributes: Attributes;
        droppedAttributesCount: number;
        droppedEventsCount: number;
        droppedLinksCount: number;
        duration: HrTime;
        ended: boolean;
        endTime: HrTime;
        events: TimedEvent[];
        instrumentationScope: core.InstrumentationScope;
        kind: SpanKind;
        links: Link[];
        name: string;
        parentSpanContext?: SpanContext;
        resource: resources.Resource;
        spanContext: () => SpanContext;
        startTime: HrTime;
        status: SpanStatus;
    }

    Properties

    attributes +ReadableSpan | OpenTelemetry SDK
    interface ReadableSpan {
        attributes: Attributes;
        droppedAttributesCount: number;
        droppedEventsCount: number;
        droppedLinksCount: number;
        duration: HrTime;
        ended: boolean;
        endTime: HrTime;
        events: TimedEvent[];
        instrumentationScope: core.InstrumentationScope;
        kind: SpanKind;
        links: Link[];
        name: string;
        parentSpanContext?: SpanContext;
        resource: resources.Resource;
        spanContext: () => SpanContext;
        startTime: HrTime;
        status: SpanStatus;
    }

    Properties

    attributes: Attributes
    droppedAttributesCount: number
    droppedEventsCount: number
    droppedLinksCount: number
    duration: HrTime
    ended: boolean
    endTime: HrTime
    events: TimedEvent[]
    instrumentationScope: core.InstrumentationScope
    kind: SpanKind
    links: Link[]
    name: string
    parentSpanContext?: SpanContext
    spanContext: () => SpanContext
    startTime: HrTime
    status: SpanStatus
    +

    Properties

    attributes: Attributes
    droppedAttributesCount: number
    droppedEventsCount: number
    droppedLinksCount: number
    duration: HrTime
    ended: boolean
    endTime: HrTime
    events: TimedEvent[]
    instrumentationScope: core.InstrumentationScope
    kind: SpanKind
    links: Link[]
    name: string
    parentSpanContext?: SpanContext
    spanContext: () => SpanContext
    startTime: HrTime
    status: SpanStatus
    diff --git a/interfaces/_opentelemetry_sdk-trace-base.SDKRegistrationConfig.html b/interfaces/_opentelemetry_sdk-trace-base.SDKRegistrationConfig.html index a255e0aac..c96e54d24 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.SDKRegistrationConfig.html +++ b/interfaces/_opentelemetry_sdk-trace-base.SDKRegistrationConfig.html @@ -1,8 +1,8 @@ SDKRegistrationConfig | OpenTelemetry SDK

    Configuration options for registering the API with the SDK. Undefined values may be substituted for defaults, and null values will not be registered.

    -
    interface SDKRegistrationConfig {
        contextManager?: null | ContextManager;
        propagator?: null | TextMapPropagator<any>;
    }

    Properties

    interface SDKRegistrationConfig {
        contextManager?: null | ContextManager;
        propagator?: null | TextMapPropagator<any>;
    }

    Properties

    contextManager?: null | ContextManager

    Context manager to register as the global context manager

    -
    propagator?: null | TextMapPropagator<any>

    Propagator to register as the global propagator

    -
    +
    propagator?: null | TextMapPropagator<any>

    Propagator to register as the global propagator

    +
    diff --git a/interfaces/_opentelemetry_sdk-trace-base.Sampler.html b/interfaces/_opentelemetry_sdk-trace-base.Sampler.html index fe1e77097..29cfb96f7 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.Sampler.html +++ b/interfaces/_opentelemetry_sdk-trace-base.Sampler.html @@ -1,7 +1,7 @@ Sampler | OpenTelemetry SDK

    This interface represent a sampler. Sampling is a mechanism to control the noise and overhead introduced by OpenTelemetry by reducing the number of samples of traces collected and sent to the backend.

    -
    interface Sampler {
        shouldSample(
            context: Context,
            traceId: string,
            spanName: string,
            spanKind: SpanKind,
            attributes: Attributes,
            links: Link[],
        ): SamplingResult;
        toString(): string;
    }

    Implemented by

    Methods

    interface Sampler {
        shouldSample(
            context: Context,
            traceId: string,
            spanName: string,
            spanKind: SpanKind,
            attributes: Attributes,
            links: Link[],
        ): SamplingResult;
        toString(): string;
    }

    Implemented by

    Methods

    • Checks whether span needs to be created and tracked.

      Parameters

      • context: Context

        Parent Context which may contain a span.

        @@ -14,5 +14,5 @@ span to be created starts a new trace.

      • links: Link[]

        Collection of links that will be associated with the Span to be created. Typically useful for batch operations.

      Returns SamplingResult

      a SamplingResult.

      -
    • Returns the sampler name or short description with the configuration.

      -

      Returns string

    +
    • Returns the sampler name or short description with the configuration.

      +

      Returns string

    diff --git a/interfaces/_opentelemetry_sdk-trace-base.SamplingResult.html b/interfaces/_opentelemetry_sdk-trace-base.SamplingResult.html index ace0173b2..ce16988ba 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.SamplingResult.html +++ b/interfaces/_opentelemetry_sdk-trace-base.SamplingResult.html @@ -1,14 +1,14 @@ SamplingResult | OpenTelemetry SDK

    A sampling result contains a decision for a Span and additional attributes the sampler would like to added to the Span.

    -
    interface SamplingResult {
        attributes?: Readonly<Attributes>;
        decision: SamplingDecision;
        traceState?: TraceState;
    }

    Properties

    interface SamplingResult {
        attributes?: Readonly<Attributes>;
        decision: SamplingDecision;
        traceState?: TraceState;
    }

    Properties

    attributes?: Readonly<Attributes>

    The list of attributes returned by SamplingResult MUST be immutable. Caller may call Sampler.shouldSample any number of times and can safely cache the returned value.

    -

    A sampling decision, refer to SamplingDecision for details.

    -
    traceState?: TraceState

    A TraceState that will be associated with the Span through +

    A sampling decision, refer to SamplingDecision for details.

    +
    traceState?: TraceState

    A TraceState that will be associated with the Span through the new SpanContext. Samplers SHOULD return the TraceState from the passed-in Context if they do not intend to change it. Leaving the value undefined will also leave the TraceState unchanged.

    -
    +
    diff --git a/interfaces/_opentelemetry_sdk-trace-base.SpanExporter.html b/interfaces/_opentelemetry_sdk-trace-base.SpanExporter.html index 5282b251c..54d03b047 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.SpanExporter.html +++ b/interfaces/_opentelemetry_sdk-trace-base.SpanExporter.html @@ -2,11 +2,11 @@ for sampled spans in their own format.

    To export data this MUST be register to the Tracer SDK using a optional config.

    -
    interface SpanExporter {
        export(
            spans: ReadableSpan[],
            resultCallback: (result: core.ExportResult) => void,
        ): void;
        forceFlush(): Promise<void>;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    interface SpanExporter {
        export(
            spans: ReadableSpan[],
            resultCallback: (result: core.ExportResult) => void,
        ): void;
        forceFlush(): Promise<void>;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    +
  • resultCallback: (result: core.ExportResult) => void
  • Returns void

    diff --git a/interfaces/_opentelemetry_sdk-trace-base.SpanLimits.html b/interfaces/_opentelemetry_sdk-trace-base.SpanLimits.html index b25962c11..cd8a06dfb 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.SpanLimits.html +++ b/interfaces/_opentelemetry_sdk-trace-base.SpanLimits.html @@ -1,14 +1,14 @@ SpanLimits | OpenTelemetry SDK

    Global configuration of trace service

    -
    interface SpanLimits {
        attributeCountLimit?: number;
        attributePerEventCountLimit?: number;
        attributePerLinkCountLimit?: number;
        attributeValueLengthLimit?: number;
        eventCountLimit?: number;
        linkCountLimit?: number;
    }

    Properties

    interface SpanLimits {
        attributeCountLimit?: number;
        attributePerEventCountLimit?: number;
        attributePerLinkCountLimit?: number;
        attributeValueLengthLimit?: number;
        eventCountLimit?: number;
        linkCountLimit?: number;
    }

    Properties

    attributeCountLimit?: number

    attributeCountLimit is number of attributes per span

    -
    attributePerEventCountLimit?: number

    attributePerEventCountLimit is the maximum number of attributes allowed per span event

    -
    attributePerLinkCountLimit?: number

    attributePerLinkCountLimit is the maximum number of attributes allowed per span link

    -
    attributeValueLengthLimit?: number

    attributeValueLengthLimit is maximum allowed attribute value size

    -
    eventCountLimit?: number

    eventCountLimit is number of message events per span

    -
    linkCountLimit?: number

    linkCountLimit is number of links per span

    -
    +
    attributePerEventCountLimit?: number

    attributePerEventCountLimit is the maximum number of attributes allowed per span event

    +
    attributePerLinkCountLimit?: number

    attributePerLinkCountLimit is the maximum number of attributes allowed per span link

    +
    attributeValueLengthLimit?: number

    attributeValueLengthLimit is maximum allowed attribute value size

    +
    eventCountLimit?: number

    eventCountLimit is number of message events per span

    +
    linkCountLimit?: number

    linkCountLimit is number of links per span

    +
    diff --git a/interfaces/_opentelemetry_sdk-trace-base.SpanProcessor.html b/interfaces/_opentelemetry_sdk-trace-base.SpanProcessor.html index 598f72051..e3a7d31ea 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.SpanProcessor.html +++ b/interfaces/_opentelemetry_sdk-trace-base.SpanProcessor.html @@ -1,16 +1,16 @@ SpanProcessor | OpenTelemetry SDK

    SpanProcessor is the interface Tracer SDK uses to allow synchronous hooks for when a Span is started or when a Span is ended.

    -
    interface SpanProcessor {
        forceFlush(): Promise<void>;
        onEnd(span: ReadableSpan): void;
        onStart(span: Span, parentContext: Context): void;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    interface SpanProcessor {
        forceFlush(): Promise<void>;
        onEnd(span: ReadableSpan): void;
        onStart(span: Span, parentContext: Context): void;
        shutdown(): Promise<void>;
    }

    Implemented by

    Methods

    • Forces to export all finished spans

      -

      Returns Promise<void>

    • Called when a Span is started, if the span.isRecording() +

    Returns void

    • Called when a Span is started, if the span.isRecording() returns true.

      Parameters

      • span: Span

        the Span that just started.

        -
      • parentContext: Context

      Returns void

    • Shuts down the processor. Called when SDK is shut down. This is an +

    • parentContext: Context

    Returns void

    • Shuts down the processor. Called when SDK is shut down. This is an opportunity for processor to do any cleanup required.

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/interfaces/_opentelemetry_sdk-trace-base.TimedEvent.html b/interfaces/_opentelemetry_sdk-trace-base.TimedEvent.html index 4ef78225f..3c409ce4e 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.TimedEvent.html +++ b/interfaces/_opentelemetry_sdk-trace-base.TimedEvent.html @@ -1,10 +1,10 @@ TimedEvent | OpenTelemetry SDK

    Represents a timed event. A timed event is an event with a timestamp.

    -
    interface TimedEvent {
        attributes?: Attributes;
        droppedAttributesCount?: number;
        name: string;
        time: HrTime;
    }

    Properties

    interface TimedEvent {
        attributes?: Attributes;
        droppedAttributesCount?: number;
        name: string;
        time: HrTime;
    }

    Properties

    attributes?: Attributes

    The attributes of the event.

    -
    droppedAttributesCount?: number

    Count of attributes of the event that were dropped due to collection limits

    -
    name: string

    The name of the event.

    -
    time: HrTime
    +
    droppedAttributesCount?: number

    Count of attributes of the event that were dropped due to collection limits

    +
    name: string

    The name of the event.

    +
    time: HrTime
    diff --git a/interfaces/_opentelemetry_sdk-trace-base.TracerConfig.html b/interfaces/_opentelemetry_sdk-trace-base.TracerConfig.html index b0bf59d37..5399bfcca 100644 --- a/interfaces/_opentelemetry_sdk-trace-base.TracerConfig.html +++ b/interfaces/_opentelemetry_sdk-trace-base.TracerConfig.html @@ -1,5 +1,5 @@ TracerConfig | OpenTelemetry SDK

    TracerConfig provides an interface for configuring a Basic Tracer.

    -
    interface TracerConfig {
        forceFlushTimeoutMillis?: number;
        generalLimits?: GeneralLimits;
        idGenerator?: IdGenerator;
        resource?: resources.Resource;
        sampler?: Sampler;
        spanLimits?: SpanLimits;
        spanProcessors?: SpanProcessor[];
    }

    Properties

    interface TracerConfig {
        forceFlushTimeoutMillis?: number;
        generalLimits?: GeneralLimits;
        idGenerator?: IdGenerator;
        resource?: resources.Resource;
        sampler?: Sampler;
        spanLimits?: SpanLimits;
        spanProcessors?: SpanProcessor[];
    }

    Properties

    forceFlushTimeoutMillis?: number

    How long the forceFlush can run before it is cancelled. The default value is 30000ms

    -
    generalLimits?: GeneralLimits

    General Limits

    -
    idGenerator?: IdGenerator

    Generator of trace and span IDs +

    generalLimits?: GeneralLimits

    General Limits

    +
    idGenerator?: IdGenerator

    Generator of trace and span IDs The default idGenerator generates random ids

    -
    resource?: resources.Resource

    Resource associated with trace telemetry

    -
    sampler?: Sampler

    Sampler determines if a span should be recorded or should be a NoopSpan.

    -
    spanLimits?: SpanLimits

    Span Limits

    -
    spanProcessors?: SpanProcessor[]

    List of SpanProcessor for the tracer

    -
    +
    resource?: resources.Resource

    Resource associated with trace telemetry

    +
    sampler?: Sampler

    Sampler determines if a span should be recorded or should be a NoopSpan.

    +
    spanLimits?: SpanLimits

    Span Limits

    +
    spanProcessors?: SpanProcessor[]

    List of SpanProcessor for the tracer

    +
    diff --git a/interfaces/_opentelemetry_sdk-trace-web.PerformanceLegacy.html b/interfaces/_opentelemetry_sdk-trace-web.PerformanceLegacy.html index 5df813315..26cab2196 100644 --- a/interfaces/_opentelemetry_sdk-trace-web.PerformanceLegacy.html +++ b/interfaces/_opentelemetry_sdk-trace-web.PerformanceLegacy.html @@ -1,4 +1,4 @@ PerformanceLegacy | OpenTelemetry SDK

    This interface defines a fallback to read performance metrics, this happens for example on Safari Mac

    -
    interface PerformanceLegacy {
        timing?: PerformanceEntries;
    }

    Properties

    Properties

    +
    interface PerformanceLegacy {
        timing?: PerformanceEntries;
    }

    Properties

    Properties

    diff --git a/interfaces/_opentelemetry_sdk-trace-web.PerformanceResourceTimingInfo.html b/interfaces/_opentelemetry_sdk-trace-web.PerformanceResourceTimingInfo.html index eff53c514..8f8621a6b 100644 --- a/interfaces/_opentelemetry_sdk-trace-web.PerformanceResourceTimingInfo.html +++ b/interfaces/_opentelemetry_sdk-trace-web.PerformanceResourceTimingInfo.html @@ -1,5 +1,5 @@ PerformanceResourceTimingInfo | OpenTelemetry SDK

    This interface is used in getResource function to return main request and it's corresponding PreFlight request

    -
    interface PerformanceResourceTimingInfo {
        corsPreFlightRequest?: PerformanceResourceTiming;
        mainRequest?: PerformanceResourceTiming;
    }

    Properties

    interface PerformanceResourceTimingInfo {
        corsPreFlightRequest?: PerformanceResourceTiming;
        mainRequest?: PerformanceResourceTiming;
    }

    Properties

    corsPreFlightRequest?: PerformanceResourceTiming
    mainRequest?: PerformanceResourceTiming
    +

    Properties

    corsPreFlightRequest?: PerformanceResourceTiming
    mainRequest?: PerformanceResourceTiming
    diff --git a/interfaces/_opentelemetry_sdk-trace-web.URLLike.html b/interfaces/_opentelemetry_sdk-trace-web.URLLike.html index 7b629a5bd..04923afd0 100644 --- a/interfaces/_opentelemetry_sdk-trace-web.URLLike.html +++ b/interfaces/_opentelemetry_sdk-trace-web.URLLike.html @@ -1,5 +1,5 @@ URLLike | OpenTelemetry SDK

    The URLLike interface represents an URL and HTMLAnchorElement compatible fields.

    -
    interface URLLike {
        hash: string;
        host: string;
        hostname: string;
        href: string;
        origin: string;
        password: string;
        pathname: string;
        port: string;
        protocol: string;
        search: string;
        username: string;
    }

    Properties

    interface URLLike {
        hash: string;
        host: string;
        hostname: string;
        href: string;
        origin: string;
        password: string;
        pathname: string;
        port: string;
        protocol: string;
        search: string;
        username: string;
    }

    Properties

    Properties

    hash: string
    host: string
    hostname: string
    href: string
    origin: string
    password: string
    pathname: string
    port: string
    protocol: string
    search: string
    username: string
    +

    Properties

    hash: string
    host: string
    hostname: string
    href: string
    origin: string
    password: string
    pathname: string
    port: string
    protocol: string
    search: string
    username: string
    diff --git a/interfaces/_opentelemetry_web-common.SessionProvider.html b/interfaces/_opentelemetry_web-common.SessionProvider.html index 9177edfe7..f63738b37 100644 --- a/interfaces/_opentelemetry_web-common.SessionProvider.html +++ b/interfaces/_opentelemetry_web-common.SessionProvider.html @@ -1,2 +1,2 @@ -SessionProvider | OpenTelemetry SDK
    interface SessionProvider {
        getSessionId(): null | string;
    }

    Methods

    Methods

    +SessionProvider | OpenTelemetry SDK
    interface SessionProvider {
        getSessionId(): null | string;
    }

    Methods

    Methods

    diff --git a/media/experimental_attributes.ts b/media/experimental_attributes.ts index 4439a8902..75319db6f 100644 --- a/media/experimental_attributes.ts +++ b/media/experimental_attributes.ts @@ -2938,6 +2938,191 @@ export const DB_SYSTEM_VALUE_TRINO = "trino" as const; */ export const DB_SYSTEM_VALUE_VERTICA = "vertica" as const; +/** + * Enum value "actian.ingres" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_ACTIAN_INGRES = "actian.ingres" as const; + +/** + * Enum value "aws.dynamodb" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_AWS_DYNAMODB = "aws.dynamodb" as const; + +/** + * Enum value "aws.redshift" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_AWS_REDSHIFT = "aws.redshift" as const; + +/** + * Enum value "azure.cosmosdb" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_AZURE_COSMOSDB = "azure.cosmosdb" as const; + +/** + * Enum value "cassandra" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_CASSANDRA = "cassandra" as const; + +/** + * Enum value "clickhouse" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_CLICKHOUSE = "clickhouse" as const; + +/** + * Enum value "cockroachdb" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_COCKROACHDB = "cockroachdb" as const; + +/** + * Enum value "couchbase" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_COUCHBASE = "couchbase" as const; + +/** + * Enum value "couchdb" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_COUCHDB = "couchdb" as const; + +/** + * Enum value "derby" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_DERBY = "derby" as const; + +/** + * Enum value "elasticsearch" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_ELASTICSEARCH = "elasticsearch" as const; + +/** + * Enum value "firebirdsql" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_FIREBIRDSQL = "firebirdsql" as const; + +/** + * Enum value "gcp.spanner" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_GCP_SPANNER = "gcp.spanner" as const; + +/** + * Enum value "geode" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_GEODE = "geode" as const; + +/** + * Enum value "h2database" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_H2DATABASE = "h2database" as const; + +/** + * Enum value "hbase" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_HBASE = "hbase" as const; + +/** + * Enum value "hive" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_HIVE = "hive" as const; + +/** + * Enum value "hsqldb" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_HSQLDB = "hsqldb" as const; + +/** + * Enum value "ibm.db2" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_IBM_DB2 = "ibm.db2" as const; + +/** + * Enum value "ibm.informix" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_IBM_INFORMIX = "ibm.informix" as const; + +/** + * Enum value "ibm.netezza" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_IBM_NETEZZA = "ibm.netezza" as const; + +/** + * Enum value "influxdb" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_INFLUXDB = "influxdb" as const; + +/** + * Enum value "instantdb" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_INSTANTDB = "instantdb" as const; + +/** + * Enum value "intersystems.cache" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_INTERSYSTEMS_CACHE = "intersystems.cache" as const; + +/** + * Enum value "memcached" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_MEMCACHED = "memcached" as const; + +/** + * Enum value "mongodb" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_MONGODB = "mongodb" as const; + +/** + * Enum value "neo4j" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_NEO4J = "neo4j" as const; + +/** + * Enum value "opensearch" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_OPENSEARCH = "opensearch" as const; + +/** + * Enum value "oracle.db" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_ORACLE_DB = "oracle.db" as const; + +/** + * Enum value "other_sql" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_OTHER_SQL = "other_sql" as const; + +/** + * Enum value "redis" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_REDIS = "redis" as const; + +/** + * Enum value "sap.hana" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_SAP_HANA = "sap.hana" as const; + +/** + * Enum value "sap.maxdb" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_SAP_MAXDB = "sap.maxdb" as const; + +/** + * Enum value "softwareag.adabas" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_SOFTWAREAG_ADABAS = "softwareag.adabas" as const; + +/** + * Enum value "sqlite" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_SQLITE = "sqlite" as const; + +/** + * Enum value "teradata" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_TERADATA = "teradata" as const; + +/** + * Enum value "trino" for attribute {@link ATTR_DB_SYSTEM_NAME}. + */ +export const DB_SYSTEM_NAME_VALUE_TRINO = "trino" as const; + /** * Deprecated, no replacement at this time. * diff --git a/types/_opentelemetry_api-logs.AnyValue.html b/types/_opentelemetry_api-logs.AnyValue.html index 31fece1bb..adbf9e626 100644 --- a/types/_opentelemetry_api-logs.AnyValue.html +++ b/types/_opentelemetry_api-logs.AnyValue.html @@ -6,4 +6,4 @@
  • map from string to any value
  • empty value
  • -
    +
    diff --git a/types/_opentelemetry_api-logs.LogAttributes.html b/types/_opentelemetry_api-logs.LogAttributes.html index d6a47734a..822a20bb2 100644 --- a/types/_opentelemetry_api-logs.LogAttributes.html +++ b/types/_opentelemetry_api-logs.LogAttributes.html @@ -1 +1 @@ -LogAttributes | OpenTelemetry SDK
    +LogAttributes | OpenTelemetry SDK
    diff --git a/types/_opentelemetry_api-logs.LogBody.html b/types/_opentelemetry_api-logs.LogBody.html index 2f09bc99b..bffd68c4a 100644 --- a/types/_opentelemetry_api-logs.LogBody.html +++ b/types/_opentelemetry_api-logs.LogBody.html @@ -1 +1 @@ -LogBody | OpenTelemetry SDK
    +LogBody | OpenTelemetry SDK
    diff --git a/types/_opentelemetry_api._opentelemetry_api.AttributeValue.html b/types/_opentelemetry_api._opentelemetry_api.AttributeValue.html index 5199d98f1..5c7bdcf49 100644 --- a/types/_opentelemetry_api._opentelemetry_api.AttributeValue.html +++ b/types/_opentelemetry_api._opentelemetry_api.AttributeValue.html @@ -1,4 +1,4 @@ AttributeValue | OpenTelemetry SDK
    AttributeValue:
        | string
        | number
        | boolean
        | (null | undefined | string)[]
        | (null | undefined | number)[]
        | (null | undefined | boolean)[]

    Attribute values may be any non-nullish primitive value except an object.

    null or undefined attribute values are invalid and will result in undefined behavior.

    1.3.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.BaggageEntryMetadata.html b/types/_opentelemetry_api._opentelemetry_api.BaggageEntryMetadata.html index d4b42669c..a0f12b7af 100644 --- a/types/_opentelemetry_api._opentelemetry_api.BaggageEntryMetadata.html +++ b/types/_opentelemetry_api._opentelemetry_api.BaggageEntryMetadata.html @@ -1,4 +1,4 @@ BaggageEntryMetadata | OpenTelemetry SDK
    BaggageEntryMetadata: { toString(): string } & {
        __TYPE__: typeof baggageEntryMetadataSymbol;
    }

    Serializable Metadata defined by the W3C baggage specification. It currently has no special meaning defined by the OpenTelemetry or W3C.

    1.0.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.BatchObservableCallback.html b/types/_opentelemetry_api._opentelemetry_api.BatchObservableCallback.html index b16967dbd..a32466aa9 100644 --- a/types/_opentelemetry_api._opentelemetry_api.BatchObservableCallback.html +++ b/types/_opentelemetry_api._opentelemetry_api.BatchObservableCallback.html @@ -1,3 +1,3 @@ BatchObservableCallback | OpenTelemetry SDK

    Type Alias BatchObservableCallback<AttributesTypes>

    BatchObservableCallback: (
        observableResult: BatchObservableResult<AttributesTypes>,
    ) => void | Promise<void>

    The observable callback for a batch of Observable instruments.

    Type Parameters

    Type declaration

    1.3.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.DiagLogFunction.html b/types/_opentelemetry_api._opentelemetry_api.DiagLogFunction.html index 71a267f17..9d0163b9d 100644 --- a/types/_opentelemetry_api._opentelemetry_api.DiagLogFunction.html +++ b/types/_opentelemetry_api._opentelemetry_api.DiagLogFunction.html @@ -1,2 +1,2 @@ DiagLogFunction | OpenTelemetry SDK
    DiagLogFunction: (message: string, ...args: unknown[]) => void

    Type declaration

      • (message: string, ...args: unknown[]): void
      • Parameters

        • message: string
        • ...args: unknown[]

        Returns void

    1.0.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.Exception.html b/types/_opentelemetry_api._opentelemetry_api.Exception.html index 14cd9b675..3cf523a4e 100644 --- a/types/_opentelemetry_api._opentelemetry_api.Exception.html +++ b/types/_opentelemetry_api._opentelemetry_api.Exception.html @@ -1,4 +1,4 @@ Exception | OpenTelemetry SDK
    Exception: ExceptionWithCode | ExceptionWithMessage | ExceptionWithName | string

    Defines Exception.

    string or an object with one of (message or name or code) and optional stack

    1.0.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.HrTime.html b/types/_opentelemetry_api._opentelemetry_api.HrTime.html index e16c683e6..97a35af70 100644 --- a/types/_opentelemetry_api._opentelemetry_api.HrTime.html +++ b/types/_opentelemetry_api._opentelemetry_api.HrTime.html @@ -8,4 +8,4 @@ The second number is calculated by converting the digits after the decimal point HrTime[1] = Number((1609504210.150 - HrTime[0]).toFixed(9)) * 1e9 = 150000000. This is represented in HrTime format as [1609504210, 150000000].

    1.0.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.MetricAttributeValue.html b/types/_opentelemetry_api._opentelemetry_api.MetricAttributeValue.html index d01b40b5f..3402079ee 100644 --- a/types/_opentelemetry_api._opentelemetry_api.MetricAttributeValue.html +++ b/types/_opentelemetry_api._opentelemetry_api.MetricAttributeValue.html @@ -1,3 +1,3 @@ MetricAttributeValue | OpenTelemetry SDK
    MetricAttributeValue: AttributeValue

    please use AttributeValue

    1.3.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.MetricAttributes.html b/types/_opentelemetry_api._opentelemetry_api.MetricAttributes.html index 99e48f5e5..039ee7cb4 100644 --- a/types/_opentelemetry_api._opentelemetry_api.MetricAttributes.html +++ b/types/_opentelemetry_api._opentelemetry_api.MetricAttributes.html @@ -1,3 +1,3 @@ MetricAttributes | OpenTelemetry SDK
    MetricAttributes: Attributes

    please use Attributes

    1.3.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.ObservableCallback.html b/types/_opentelemetry_api._opentelemetry_api.ObservableCallback.html index 35ff02dda..f8bbeb4c5 100644 --- a/types/_opentelemetry_api._opentelemetry_api.ObservableCallback.html +++ b/types/_opentelemetry_api._opentelemetry_api.ObservableCallback.html @@ -1,3 +1,3 @@ ObservableCallback | OpenTelemetry SDK
    ObservableCallback: (
        observableResult: ObservableResult<AttributesTypes>,
    ) => void | Promise<void>

    The observable callback for Observable instruments.

    Type Parameters

    Type declaration

    1.3.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.ObservableCounter.html b/types/_opentelemetry_api._opentelemetry_api.ObservableCounter.html index 7fe2f4f8c..7f9a68f01 100644 --- a/types/_opentelemetry_api._opentelemetry_api.ObservableCounter.html +++ b/types/_opentelemetry_api._opentelemetry_api.ObservableCounter.html @@ -1,2 +1,2 @@ ObservableCounter | OpenTelemetry SDK
    ObservableCounter: Observable<AttributesTypes>

    Type Parameters

    1.3.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.ObservableGauge.html b/types/_opentelemetry_api._opentelemetry_api.ObservableGauge.html index 7df35ca28..14c80ff0e 100644 --- a/types/_opentelemetry_api._opentelemetry_api.ObservableGauge.html +++ b/types/_opentelemetry_api._opentelemetry_api.ObservableGauge.html @@ -1,2 +1,2 @@ ObservableGauge | OpenTelemetry SDK
    ObservableGauge: Observable<AttributesTypes>

    Type Parameters

    1.3.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.ObservableUpDownCounter.html b/types/_opentelemetry_api._opentelemetry_api.ObservableUpDownCounter.html index 44d02fa48..e1cb7a6b5 100644 --- a/types/_opentelemetry_api._opentelemetry_api.ObservableUpDownCounter.html +++ b/types/_opentelemetry_api._opentelemetry_api.ObservableUpDownCounter.html @@ -1,2 +1,2 @@ ObservableUpDownCounter | OpenTelemetry SDK

    Type Alias ObservableUpDownCounter<AttributesTypes>

    ObservableUpDownCounter: Observable<AttributesTypes>

    Type Parameters

    1.3.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.SpanAttributeValue.html b/types/_opentelemetry_api._opentelemetry_api.SpanAttributeValue.html index f7a553675..10e20a7b7 100644 --- a/types/_opentelemetry_api._opentelemetry_api.SpanAttributeValue.html +++ b/types/_opentelemetry_api._opentelemetry_api.SpanAttributeValue.html @@ -1,3 +1,3 @@ SpanAttributeValue | OpenTelemetry SDK
    SpanAttributeValue: AttributeValue

    please use AttributeValue

    1.0.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.SpanAttributes.html b/types/_opentelemetry_api._opentelemetry_api.SpanAttributes.html index 6a110e233..b9289efb8 100644 --- a/types/_opentelemetry_api._opentelemetry_api.SpanAttributes.html +++ b/types/_opentelemetry_api._opentelemetry_api.SpanAttributes.html @@ -1,3 +1,3 @@ SpanAttributes | OpenTelemetry SDK
    SpanAttributes: Attributes

    please use Attributes

    1.0.0

    -
    +
    diff --git a/types/_opentelemetry_api._opentelemetry_api.TimeInput.html b/types/_opentelemetry_api._opentelemetry_api.TimeInput.html index cc06825d0..161de7a62 100644 --- a/types/_opentelemetry_api._opentelemetry_api.TimeInput.html +++ b/types/_opentelemetry_api._opentelemetry_api.TimeInput.html @@ -1,4 +1,4 @@ TimeInput | OpenTelemetry SDK
    TimeInput: HrTime | number | Date

    Defines TimeInput.

    hrtime, epoch milliseconds, performance.now() or Date

    1.0.0

    -
    +
    diff --git a/types/_opentelemetry_context-zone-peer-dep.Func.html b/types/_opentelemetry_context-zone-peer-dep.Func.html index 5028acad7..f3675e117 100644 --- a/types/_opentelemetry_context-zone-peer-dep.Func.html +++ b/types/_opentelemetry_context-zone-peer-dep.Func.html @@ -1 +1 @@ -Func | OpenTelemetry SDK
    Func: (...args: unknown[]) => T

    Type Parameters

    • T

    Type declaration

      • (...args: unknown[]): T
      • Parameters

        • ...args: unknown[]

        Returns T

    +Func | OpenTelemetry SDK
    Func: (...args: unknown[]) => T

    Type Parameters

    • T

    Type declaration

      • (...args: unknown[]): T
      • Parameters

        • ...args: unknown[]

        Returns T

    diff --git a/types/_opentelemetry_core.ErrorHandler.html b/types/_opentelemetry_core.ErrorHandler.html index af0f9b531..637bcb275 100644 --- a/types/_opentelemetry_core.ErrorHandler.html +++ b/types/_opentelemetry_core.ErrorHandler.html @@ -1,2 +1,2 @@ ErrorHandler | OpenTelemetry SDK
    ErrorHandler: (ex: Exception) => void

    Defines an error handler function

    -

    Type declaration

    +

    Type declaration

    diff --git a/types/_opentelemetry_core.RPCMetadata.html b/types/_opentelemetry_core.RPCMetadata.html index a2b7481b3..9706cbc69 100644 --- a/types/_opentelemetry_core.RPCMetadata.html +++ b/types/_opentelemetry_core.RPCMetadata.html @@ -1,2 +1,2 @@ RPCMetadata | OpenTelemetry SDK
    RPCMetadata: HTTPMetadata

    Allows for future rpc metadata to be used with this mechanism

    -
    +
    diff --git a/types/_opentelemetry_instrumentation-xml-http-request.XHRCustomAttributeFunction.html b/types/_opentelemetry_instrumentation-xml-http-request.XHRCustomAttributeFunction.html index 352bfc64d..ad618ca4b 100644 --- a/types/_opentelemetry_instrumentation-xml-http-request.XHRCustomAttributeFunction.html +++ b/types/_opentelemetry_instrumentation-xml-http-request.XHRCustomAttributeFunction.html @@ -1 +1 @@ -XHRCustomAttributeFunction | OpenTelemetry SDK
    XHRCustomAttributeFunction: (span: Span, xhr: XMLHttpRequest) => void

    Type declaration

      • (span: Span, xhr: XMLHttpRequest): void
      • Parameters

        • span: Span
        • xhr: XMLHttpRequest

        Returns void

    +XHRCustomAttributeFunction | OpenTelemetry SDK
    XHRCustomAttributeFunction: (span: Span, xhr: XMLHttpRequest) => void

    Type declaration

      • (span: Span, xhr: XMLHttpRequest): void
      • Parameters

        • span: Span
        • xhr: XMLHttpRequest

        Returns void

    diff --git a/types/_opentelemetry_instrumentation.SpanCustomizationHook.html b/types/_opentelemetry_instrumentation.SpanCustomizationHook.html index 8a50d492b..8986fdf1b 100644 --- a/types/_opentelemetry_instrumentation.SpanCustomizationHook.html +++ b/types/_opentelemetry_instrumentation.SpanCustomizationHook.html @@ -9,4 +9,4 @@ when the event is emitted.

    in the info argument, is specific to each instrumentation and life-cycle event and should be documented where it is used.

    Instrumentation may define multiple hooks, for different spans, or different span life-cycle events.

    -

    Type Parameters

    • SpanCustomizationInfoType

    Type declaration

    +

    Type Parameters

    • SpanCustomizationInfoType

    Type declaration

    diff --git a/types/_opentelemetry_resources.DetectedResource.html b/types/_opentelemetry_resources.DetectedResource.html index bc77b8045..2cf55314c 100644 --- a/types/_opentelemetry_resources.DetectedResource.html +++ b/types/_opentelemetry_resources.DetectedResource.html @@ -1,2 +1,2 @@ DetectedResource | OpenTelemetry SDK
    DetectedResource: { attributes?: DetectedResourceAttributes }

    Type declaration

    +
    diff --git a/types/_opentelemetry_resources.DetectedResourceAttributes.html b/types/_opentelemetry_resources.DetectedResourceAttributes.html index f7cae1b56..c77557b8e 100644 --- a/types/_opentelemetry_resources.DetectedResourceAttributes.html +++ b/types/_opentelemetry_resources.DetectedResourceAttributes.html @@ -1,3 +1,3 @@ DetectedResourceAttributes | OpenTelemetry SDK
    DetectedResourceAttributes: Record<string, DetectedResourceAttributeValue>

    An object representing detected resource attributes. Values may be AttributeValues or a promise to an AttributeValue.

    -
    +
    diff --git a/types/_opentelemetry_resources.MaybePromise.html b/types/_opentelemetry_resources.MaybePromise.html index 9130d9c2b..830dadd02 100644 --- a/types/_opentelemetry_resources.MaybePromise.html +++ b/types/_opentelemetry_resources.MaybePromise.html @@ -1 +1 @@ -MaybePromise | OpenTelemetry SDK
    MaybePromise: T | Promise<T>

    Type Parameters

    • T
    +MaybePromise | OpenTelemetry SDK
    MaybePromise: T | Promise<T>

    Type Parameters

    • T
    diff --git a/types/_opentelemetry_resources.RawResourceAttribute.html b/types/_opentelemetry_resources.RawResourceAttribute.html index 83efbfaea..496e0519f 100644 --- a/types/_opentelemetry_resources.RawResourceAttribute.html +++ b/types/_opentelemetry_resources.RawResourceAttribute.html @@ -1 +1 @@ -RawResourceAttribute | OpenTelemetry SDK
    RawResourceAttribute: [string, MaybePromise<AttributeValue | undefined>]
    +RawResourceAttribute | OpenTelemetry SDK
    RawResourceAttribute: [string, MaybePromise<AttributeValue | undefined>]
    diff --git a/types/_opentelemetry_sdk-metrics.AggregationOption.html b/types/_opentelemetry_sdk-metrics.AggregationOption.html index dca0f54c0..a6f5c755d 100644 --- a/types/_opentelemetry_sdk-metrics.AggregationOption.html +++ b/types/_opentelemetry_sdk-metrics.AggregationOption.html @@ -1 +1 @@ -AggregationOption | OpenTelemetry SDK
    AggregationOption:
        | ExponentialHistogramAggregationOption
        | HistogramAggregationOption
        | SumAggregationOption
        | DropAggregationOption
        | DefaultAggregationOption
        | LastValueAggregationOption
    +AggregationOption | OpenTelemetry SDK
    AggregationOption:
        | ExponentialHistogramAggregationOption
        | HistogramAggregationOption
        | SumAggregationOption
        | DropAggregationOption
        | DefaultAggregationOption
        | LastValueAggregationOption
    diff --git a/types/_opentelemetry_sdk-metrics.AggregationSelector.html b/types/_opentelemetry_sdk-metrics.AggregationSelector.html index 0b08a73e4..3a585417f 100644 --- a/types/_opentelemetry_sdk-metrics.AggregationSelector.html +++ b/types/_opentelemetry_sdk-metrics.AggregationSelector.html @@ -1,2 +1,2 @@ AggregationSelector | OpenTelemetry SDK
    AggregationSelector: (instrumentType: InstrumentType) => AggregationOption

    Aggregation selector based on metric instrument types.

    -

    Type declaration

    +

    Type declaration

    diff --git a/types/_opentelemetry_sdk-metrics.AggregationTemporalitySelector.html b/types/_opentelemetry_sdk-metrics.AggregationTemporalitySelector.html index 76546ad85..d32394bae 100644 --- a/types/_opentelemetry_sdk-metrics.AggregationTemporalitySelector.html +++ b/types/_opentelemetry_sdk-metrics.AggregationTemporalitySelector.html @@ -1,2 +1,2 @@ AggregationTemporalitySelector | OpenTelemetry SDK
    AggregationTemporalitySelector: (
        instrumentType: InstrumentType,
    ) => AggregationTemporality

    Aggregation temporality selector based on metric instrument types.

    -

    Type declaration

    +

    Type declaration

    diff --git a/types/_opentelemetry_sdk-metrics.LastValue.html b/types/_opentelemetry_sdk-metrics.LastValue.html index 88c268e81..6ab013e4e 100644 --- a/types/_opentelemetry_sdk-metrics.LastValue.html +++ b/types/_opentelemetry_sdk-metrics.LastValue.html @@ -1,2 +1,2 @@ LastValue | OpenTelemetry SDK
    LastValue: number

    DataPoint value type for LastValueAggregation.

    -
    +
    diff --git a/types/_opentelemetry_sdk-metrics.MetricData.html b/types/_opentelemetry_sdk-metrics.MetricData.html index 6ee5e468e..0bc294c4d 100644 --- a/types/_opentelemetry_sdk-metrics.MetricData.html +++ b/types/_opentelemetry_sdk-metrics.MetricData.html @@ -1,2 +1,2 @@ MetricData | OpenTelemetry SDK
    MetricData:
        | SumMetricData
        | GaugeMetricData
        | HistogramMetricData
        | ExponentialHistogramMetricData

    Represents an aggregated metric data.

    -
    +
    diff --git a/types/_opentelemetry_sdk-metrics.PeriodicExportingMetricReaderOptions.html b/types/_opentelemetry_sdk-metrics.PeriodicExportingMetricReaderOptions.html index 08372a779..483609c7f 100644 --- a/types/_opentelemetry_sdk-metrics.PeriodicExportingMetricReaderOptions.html +++ b/types/_opentelemetry_sdk-metrics.PeriodicExportingMetricReaderOptions.html @@ -5,4 +5,4 @@ collection.

  • Optional ExperimentalmetricProducers?: MetricProducer[]

    Note, this option is experimental. Additional MetricProducers to use as a source of aggregated metric data in addition to the SDK's metric data. The resource returned by these MetricProducers is ignored; the SDK's resource will be used instead.

    -
  • +
    diff --git a/types/_opentelemetry_sdk-metrics.Sum.html b/types/_opentelemetry_sdk-metrics.Sum.html index 8866ea0f5..5e837c6a4 100644 --- a/types/_opentelemetry_sdk-metrics.Sum.html +++ b/types/_opentelemetry_sdk-metrics.Sum.html @@ -1,2 +1,2 @@ Sum | OpenTelemetry SDK
    Sum: number

    DataPoint value type for SumAggregation.

    -
    +
    diff --git a/types/_opentelemetry_sdk-metrics.ViewOptions.html b/types/_opentelemetry_sdk-metrics.ViewOptions.html index 2b3746d0e..77e32f115 100644 --- a/types/_opentelemetry_sdk-metrics.ViewOptions.html +++ b/types/_opentelemetry_sdk-metrics.ViewOptions.html @@ -73,4 +73,4 @@ The version of the Meter. No wildcard support, version must match exactly.

  • Optionalname?: string

    Alters the metric stream: This will be used as the name of the metrics stream. If not provided, the original Instrument name will be used.

    -
  • +
    diff --git a/types/_opentelemetry_sdk-node.LoggerProviderConfig.html b/types/_opentelemetry_sdk-node.LoggerProviderConfig.html index 78a4bfd11..1f38c6db6 100644 --- a/types/_opentelemetry_sdk-node.LoggerProviderConfig.html +++ b/types/_opentelemetry_sdk-node.LoggerProviderConfig.html @@ -1,2 +1,2 @@ LoggerProviderConfig | OpenTelemetry SDK
    LoggerProviderConfig: { logRecordProcessors: logs.LogRecordProcessor[] }

    Type declaration

    • logRecordProcessors: logs.LogRecordProcessor[]

      Reference to the LoggerRecordProcessor instance by the NodeSDK

      -
    +
    diff --git a/types/_opentelemetry_sdk-node.MeterProviderConfig.html b/types/_opentelemetry_sdk-node.MeterProviderConfig.html index 002d11c63..ab0abffb5 100644 --- a/types/_opentelemetry_sdk-node.MeterProviderConfig.html +++ b/types/_opentelemetry_sdk-node.MeterProviderConfig.html @@ -1,4 +1,4 @@ MeterProviderConfig | OpenTelemetry SDK
    MeterProviderConfig: {
        reader?: metrics.IMetricReader;
        views?: metrics.ViewOptions[];
    }

    This class represents everything needed to register a fully configured OpenTelemetry Node.js SDK

    Type declaration

    +
    diff --git a/types/_opentelemetry_sdk-trace-base.Span.html b/types/_opentelemetry_sdk-trace-base.Span.html index c42fad0ea..7fb487254 100644 --- a/types/_opentelemetry_sdk-trace-base.Span.html +++ b/types/_opentelemetry_sdk-trace-base.Span.html @@ -1,3 +1,3 @@ Span | OpenTelemetry SDK

    This type provides the properties of @link{ReadableSpan} at the same time of the Span API

    -
    +
    diff --git a/types/_opentelemetry_sdk-trace-node.NodeTracerConfig.html b/types/_opentelemetry_sdk-trace-node.NodeTracerConfig.html index bd133c72d..b0c6d5f3e 100644 --- a/types/_opentelemetry_sdk-trace-node.NodeTracerConfig.html +++ b/types/_opentelemetry_sdk-trace-node.NodeTracerConfig.html @@ -1,2 +1,2 @@ NodeTracerConfig | OpenTelemetry SDK
    NodeTracerConfig: TracerConfig

    NodeTracerConfig provides an interface for configuring a Node Tracer.

    -
    +
    diff --git a/types/_opentelemetry_sdk-trace-web.PerformanceEntries.html b/types/_opentelemetry_sdk-trace-web.PerformanceEntries.html index 4ec6a5200..95580bee9 100644 --- a/types/_opentelemetry_sdk-trace-web.PerformanceEntries.html +++ b/types/_opentelemetry_sdk-trace-web.PerformanceEntries.html @@ -1 +1 @@ -PerformanceEntries | OpenTelemetry SDK
    PerformanceEntries: {
        connectEnd?: number;
        connectStart?: number;
        decodedBodySize?: number;
        domainLookupEnd?: number;
        domainLookupStart?: number;
        domComplete?: number;
        domContentLoadedEventEnd?: number;
        domContentLoadedEventStart?: number;
        domInteractive?: number;
        encodedBodySize?: number;
        fetchStart?: number;
        loadEventEnd?: number;
        loadEventStart?: number;
        redirectEnd?: number;
        redirectStart?: number;
        requestStart?: number;
        responseEnd?: number;
        responseStart?: number;
        secureConnectionStart?: number;
        startTime?: number;
        unloadEventEnd?: number;
        unloadEventStart?: number;
    }

    Type declaration

    • OptionalconnectEnd?: number
    • OptionalconnectStart?: number
    • OptionaldecodedBodySize?: number
    • OptionaldomainLookupEnd?: number
    • OptionaldomainLookupStart?: number
    • OptionaldomComplete?: number
    • OptionaldomContentLoadedEventEnd?: number
    • OptionaldomContentLoadedEventStart?: number
    • OptionaldomInteractive?: number
    • OptionalencodedBodySize?: number
    • OptionalfetchStart?: number
    • OptionalloadEventEnd?: number
    • OptionalloadEventStart?: number
    • OptionalredirectEnd?: number
    • OptionalredirectStart?: number
    • OptionalrequestStart?: number
    • OptionalresponseEnd?: number
    • OptionalresponseStart?: number
    • OptionalsecureConnectionStart?: number
    • OptionalstartTime?: number
    • OptionalunloadEventEnd?: number
    • OptionalunloadEventStart?: number
    +PerformanceEntries | OpenTelemetry SDK
    PerformanceEntries: {
        connectEnd?: number;
        connectStart?: number;
        decodedBodySize?: number;
        domainLookupEnd?: number;
        domainLookupStart?: number;
        domComplete?: number;
        domContentLoadedEventEnd?: number;
        domContentLoadedEventStart?: number;
        domInteractive?: number;
        encodedBodySize?: number;
        fetchStart?: number;
        loadEventEnd?: number;
        loadEventStart?: number;
        redirectEnd?: number;
        redirectStart?: number;
        requestStart?: number;
        responseEnd?: number;
        responseStart?: number;
        secureConnectionStart?: number;
        startTime?: number;
        unloadEventEnd?: number;
        unloadEventStart?: number;
    }

    Type declaration

    • OptionalconnectEnd?: number
    • OptionalconnectStart?: number
    • OptionaldecodedBodySize?: number
    • OptionaldomainLookupEnd?: number
    • OptionaldomainLookupStart?: number
    • OptionaldomComplete?: number
    • OptionaldomContentLoadedEventEnd?: number
    • OptionaldomContentLoadedEventStart?: number
    • OptionaldomInteractive?: number
    • OptionalencodedBodySize?: number
    • OptionalfetchStart?: number
    • OptionalloadEventEnd?: number
    • OptionalloadEventStart?: number
    • OptionalredirectEnd?: number
    • OptionalredirectStart?: number
    • OptionalrequestStart?: number
    • OptionalresponseEnd?: number
    • OptionalresponseStart?: number
    • OptionalsecureConnectionStart?: number
    • OptionalstartTime?: number
    • OptionalunloadEventEnd?: number
    • OptionalunloadEventStart?: number
    diff --git a/types/_opentelemetry_sdk-trace-web.PropagateTraceHeaderCorsUrls.html b/types/_opentelemetry_sdk-trace-web.PropagateTraceHeaderCorsUrls.html index fb12e16b3..f5176dbf4 100644 --- a/types/_opentelemetry_sdk-trace-web.PropagateTraceHeaderCorsUrls.html +++ b/types/_opentelemetry_sdk-trace-web.PropagateTraceHeaderCorsUrls.html @@ -1,2 +1,2 @@ PropagateTraceHeaderCorsUrls | OpenTelemetry SDK
    PropagateTraceHeaderCorsUrls:
        | PropagateTraceHeaderCorsUrl
        | PropagateTraceHeaderCorsUrl[]

    urls which should include trace headers when origin doesn't match

    -
    +
    diff --git a/types/_opentelemetry_sdk-trace-web.WebTracerConfig.html b/types/_opentelemetry_sdk-trace-web.WebTracerConfig.html index 7935419b2..1c902ab42 100644 --- a/types/_opentelemetry_sdk-trace-web.WebTracerConfig.html +++ b/types/_opentelemetry_sdk-trace-web.WebTracerConfig.html @@ -1,2 +1,2 @@ WebTracerConfig | OpenTelemetry SDK
    WebTracerConfig: TracerConfig

    WebTracerConfig provides an interface for configuring a Web Tracer.

    -
    +
    diff --git a/variables/_opentelemetry_api-events.events.html b/variables/_opentelemetry_api-events.events.html index 531f67862..af40c2f99 100644 --- a/variables/_opentelemetry_api-events.events.html +++ b/variables/_opentelemetry_api-events.events.html @@ -1 +1 @@ -events | OpenTelemetry SDK
    events: EventsAPI = ...
    +events | OpenTelemetry SDK
    events: EventsAPI = ...
    diff --git a/variables/_opentelemetry_api-logs.NOOP_LOGGER.html b/variables/_opentelemetry_api-logs.NOOP_LOGGER.html index 675e683a8..6321e76d2 100644 --- a/variables/_opentelemetry_api-logs.NOOP_LOGGER.html +++ b/variables/_opentelemetry_api-logs.NOOP_LOGGER.html @@ -1 +1 @@ -NOOP_LOGGER | OpenTelemetry SDK
    NOOP_LOGGER: NoopLogger = ...
    +NOOP_LOGGER | OpenTelemetry SDK
    NOOP_LOGGER: NoopLogger = ...
    diff --git a/variables/_opentelemetry_api-logs.NOOP_LOGGER_PROVIDER.html b/variables/_opentelemetry_api-logs.NOOP_LOGGER_PROVIDER.html index fd6cec126..59f44455d 100644 --- a/variables/_opentelemetry_api-logs.NOOP_LOGGER_PROVIDER.html +++ b/variables/_opentelemetry_api-logs.NOOP_LOGGER_PROVIDER.html @@ -1 +1 @@ -NOOP_LOGGER_PROVIDER | OpenTelemetry SDK
    NOOP_LOGGER_PROVIDER: NoopLoggerProvider = ...
    +NOOP_LOGGER_PROVIDER | OpenTelemetry SDK
    NOOP_LOGGER_PROVIDER: NoopLoggerProvider = ...
    diff --git a/variables/_opentelemetry_api-logs.logs.html b/variables/_opentelemetry_api-logs.logs.html index e77acf639..ef74f5889 100644 --- a/variables/_opentelemetry_api-logs.logs.html +++ b/variables/_opentelemetry_api-logs.logs.html @@ -1 +1 @@ -logs | OpenTelemetry SDK
    logs: LogsAPI = ...
    +logs | OpenTelemetry SDK
    logs: LogsAPI = ...
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.INVALID_SPANID.html b/variables/_opentelemetry_api._opentelemetry_api.INVALID_SPANID.html index 7d7cd6067..ba4e3ed88 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.INVALID_SPANID.html +++ b/variables/_opentelemetry_api._opentelemetry_api.INVALID_SPANID.html @@ -1,2 +1,2 @@ INVALID_SPANID | OpenTelemetry SDK
    INVALID_SPANID: "0000000000000000" = '0000000000000000'

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.INVALID_SPAN_CONTEXT.html b/variables/_opentelemetry_api._opentelemetry_api.INVALID_SPAN_CONTEXT.html index 967e9720e..998e8375d 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.INVALID_SPAN_CONTEXT.html +++ b/variables/_opentelemetry_api._opentelemetry_api.INVALID_SPAN_CONTEXT.html @@ -1,2 +1,2 @@ INVALID_SPAN_CONTEXT | OpenTelemetry SDK
    INVALID_SPAN_CONTEXT: SpanContext = ...

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.INVALID_TRACEID.html b/variables/_opentelemetry_api._opentelemetry_api.INVALID_TRACEID.html index 5e8f9839b..2b31070ec 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.INVALID_TRACEID.html +++ b/variables/_opentelemetry_api._opentelemetry_api.INVALID_TRACEID.html @@ -1,2 +1,2 @@ INVALID_TRACEID | OpenTelemetry SDK
    INVALID_TRACEID: "00000000000000000000000000000000" = '00000000000000000000000000000000'

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.ROOT_CONTEXT.html b/variables/_opentelemetry_api._opentelemetry_api.ROOT_CONTEXT.html index 270bb4f87..4183bb4ca 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.ROOT_CONTEXT.html +++ b/variables/_opentelemetry_api._opentelemetry_api.ROOT_CONTEXT.html @@ -1,3 +1,3 @@ ROOT_CONTEXT | OpenTelemetry SDK
    ROOT_CONTEXT: Context = ...

    The root context is used as the default parent context when there is no active context

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.context-1.html b/variables/_opentelemetry_api._opentelemetry_api.context-1.html index b261b7a03..55386c5b2 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.context-1.html +++ b/variables/_opentelemetry_api._opentelemetry_api.context-1.html @@ -1,3 +1,3 @@ context | OpenTelemetry SDK
    context: ContextAPI = ...

    Entrypoint for context API

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.default.html b/variables/_opentelemetry_api._opentelemetry_api.default.html index 1f4e35645..feae9e9c8 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.default.html +++ b/variables/_opentelemetry_api._opentelemetry_api.default.html @@ -1 +1 @@ -default | OpenTelemetry SDK
    default: {
        context: ContextAPI;
        diag: DiagAPI;
        metrics: MetricsAPI;
        propagation: PropagationAPI;
        trace: TraceAPI;
    }

    Type declaration

    +default | OpenTelemetry SDK
    default: {
        context: ContextAPI;
        diag: DiagAPI;
        metrics: MetricsAPI;
        propagation: PropagationAPI;
        trace: TraceAPI;
    }

    Type declaration

    diff --git a/variables/_opentelemetry_api._opentelemetry_api.defaultTextMapGetter.html b/variables/_opentelemetry_api._opentelemetry_api.defaultTextMapGetter.html index 2c3a470f1..fb8c8d24d 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.defaultTextMapGetter.html +++ b/variables/_opentelemetry_api._opentelemetry_api.defaultTextMapGetter.html @@ -1,2 +1,2 @@ defaultTextMapGetter | OpenTelemetry SDK
    defaultTextMapGetter: TextMapGetter = ...

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.defaultTextMapSetter.html b/variables/_opentelemetry_api._opentelemetry_api.defaultTextMapSetter.html index eb3345e0e..c64af9eda 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.defaultTextMapSetter.html +++ b/variables/_opentelemetry_api._opentelemetry_api.defaultTextMapSetter.html @@ -1,2 +1,2 @@ defaultTextMapSetter | OpenTelemetry SDK
    defaultTextMapSetter: TextMapSetter = ...

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.diag.html b/variables/_opentelemetry_api._opentelemetry_api.diag.html index 3db263a0d..c271cfd43 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.diag.html +++ b/variables/_opentelemetry_api._opentelemetry_api.diag.html @@ -3,4 +3,4 @@ Defines Diagnostic handler used for internal diagnostic logging operations. The default provides a Noop DiagLogger implementation which may be changed via the diag.setLogger(logger: DiagLogger) function.

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.metrics.html b/variables/_opentelemetry_api._opentelemetry_api.metrics.html index e304f0ff0..6e604bb77 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.metrics.html +++ b/variables/_opentelemetry_api._opentelemetry_api.metrics.html @@ -1,3 +1,3 @@ metrics | OpenTelemetry SDK
    metrics: MetricsAPI = ...

    Entrypoint for metrics API

    1.3.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.propagation.html b/variables/_opentelemetry_api._opentelemetry_api.propagation.html index 28374c79c..5ef043d9a 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.propagation.html +++ b/variables/_opentelemetry_api._opentelemetry_api.propagation.html @@ -1,3 +1,3 @@ propagation | OpenTelemetry SDK
    propagation: PropagationAPI = ...

    Entrypoint for propagation API

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_api._opentelemetry_api.trace.html b/variables/_opentelemetry_api._opentelemetry_api.trace.html index 2b82bc3e8..30432ace6 100644 --- a/variables/_opentelemetry_api._opentelemetry_api.trace.html +++ b/variables/_opentelemetry_api._opentelemetry_api.trace.html @@ -1,3 +1,3 @@ trace | OpenTelemetry SDK
    trace: TraceAPI = ...

    Entrypoint for trace API

    1.0.0

    -
    +
    diff --git a/variables/_opentelemetry_core.SDK_INFO.html b/variables/_opentelemetry_core.SDK_INFO.html index 532210866..5879e9f9c 100644 --- a/variables/_opentelemetry_core.SDK_INFO.html +++ b/variables/_opentelemetry_core.SDK_INFO.html @@ -1,2 +1,2 @@ SDK_INFO | OpenTelemetry SDK
    SDK_INFO: {
        "process.runtime.name": string;
        "telemetry.sdk.language": "nodejs";
        "telemetry.sdk.name": string;
        "telemetry.sdk.version": string;
    } = ...

    Constants describing the SDK in use

    -

    Type declaration

    • process.runtime.name: string
    • telemetry.sdk.language: "nodejs"
    • telemetry.sdk.name: string
    • telemetry.sdk.version: string
    +

    Type declaration

    • process.runtime.name: string
    • telemetry.sdk.language: "nodejs"
    • telemetry.sdk.name: string
    • telemetry.sdk.version: string
    diff --git a/variables/_opentelemetry_core.TRACE_PARENT_HEADER.html b/variables/_opentelemetry_core.TRACE_PARENT_HEADER.html index 3a447352b..78409fe3c 100644 --- a/variables/_opentelemetry_core.TRACE_PARENT_HEADER.html +++ b/variables/_opentelemetry_core.TRACE_PARENT_HEADER.html @@ -1 +1 @@ -TRACE_PARENT_HEADER | OpenTelemetry SDK
    TRACE_PARENT_HEADER: "traceparent" = 'traceparent'
    +TRACE_PARENT_HEADER | OpenTelemetry SDK
    TRACE_PARENT_HEADER: "traceparent" = 'traceparent'
    diff --git a/variables/_opentelemetry_core.TRACE_STATE_HEADER.html b/variables/_opentelemetry_core.TRACE_STATE_HEADER.html index d92859a16..d9a7184dd 100644 --- a/variables/_opentelemetry_core.TRACE_STATE_HEADER.html +++ b/variables/_opentelemetry_core.TRACE_STATE_HEADER.html @@ -1 +1 @@ -TRACE_STATE_HEADER | OpenTelemetry SDK
    TRACE_STATE_HEADER: "tracestate" = 'tracestate'
    +TRACE_STATE_HEADER | OpenTelemetry SDK
    TRACE_STATE_HEADER: "tracestate" = 'tracestate'
    diff --git a/variables/_opentelemetry_core._globalThis.html b/variables/_opentelemetry_core._globalThis.html index 46fa62d6c..47a8d4603 100644 --- a/variables/_opentelemetry_core._globalThis.html +++ b/variables/_opentelemetry_core._globalThis.html @@ -1,2 +1,2 @@ _globalThis | OpenTelemetry SDK
    _globalThis: typeof globalThis = ...

    only globals that common to node and browsers are allowed

    -
    +
    diff --git a/variables/_opentelemetry_core.internal.html b/variables/_opentelemetry_core.internal.html index 4bc08b487..65660c0bf 100644 --- a/variables/_opentelemetry_core.internal.html +++ b/variables/_opentelemetry_core.internal.html @@ -1 +1 @@ -internal | OpenTelemetry SDK
    internal: {
        _export: <T>(exporter: Exporter<T>, arg: T) => Promise<ExportResult>;
    } = ...

    Type declaration

    +internal | OpenTelemetry SDK
    internal: {
        _export: <T>(exporter: Exporter<T>, arg: T) => Promise<ExportResult>;
    } = ...

    Type declaration

    diff --git a/variables/_opentelemetry_core.otperformance.html b/variables/_opentelemetry_core.otperformance.html index d653ff809..813a175b7 100644 --- a/variables/_opentelemetry_core.otperformance.html +++ b/variables/_opentelemetry_core.otperformance.html @@ -1 +1 @@ -otperformance | OpenTelemetry SDK
    otperformance: Performance = performance
    +otperformance | OpenTelemetry SDK
    otperformance: Performance = performance
    diff --git a/variables/_opentelemetry_opentelemetry-browser-detector.browserDetector.html b/variables/_opentelemetry_opentelemetry-browser-detector.browserDetector.html index 5c6f88d4d..2404db2a9 100644 --- a/variables/_opentelemetry_opentelemetry-browser-detector.browserDetector.html +++ b/variables/_opentelemetry_opentelemetry-browser-detector.browserDetector.html @@ -1 +1 @@ -browserDetector | OpenTelemetry SDK
    browserDetector: BrowserDetector = ...
    +browserDetector | OpenTelemetry SDK
    browserDetector: BrowserDetector = ...
    diff --git a/variables/_opentelemetry_otlp-transformer.JsonLogsSerializer.html b/variables/_opentelemetry_otlp-transformer.JsonLogsSerializer.html index d0b6e0e6b..4c0b45bea 100644 --- a/variables/_opentelemetry_otlp-transformer.JsonLogsSerializer.html +++ b/variables/_opentelemetry_otlp-transformer.JsonLogsSerializer.html @@ -1 +1 @@ -JsonLogsSerializer | OpenTelemetry SDK
    JsonLogsSerializer: ISerializer<
        logs.ReadableLogRecord[],
        IExportLogsServiceResponse,
    > = ...
    +JsonLogsSerializer | OpenTelemetry SDK
    JsonLogsSerializer: ISerializer<
        logs.ReadableLogRecord[],
        IExportLogsServiceResponse,
    > = ...
    diff --git a/variables/_opentelemetry_otlp-transformer.JsonMetricsSerializer.html b/variables/_opentelemetry_otlp-transformer.JsonMetricsSerializer.html index 38c9d40c5..3d06e3ed8 100644 --- a/variables/_opentelemetry_otlp-transformer.JsonMetricsSerializer.html +++ b/variables/_opentelemetry_otlp-transformer.JsonMetricsSerializer.html @@ -1 +1 @@ -JsonMetricsSerializer | OpenTelemetry SDK
    JsonMetricsSerializer: ISerializer<
        metrics.ResourceMetrics,
        IExportMetricsServiceResponse,
    > = ...
    +JsonMetricsSerializer | OpenTelemetry SDK
    JsonMetricsSerializer: ISerializer<
        metrics.ResourceMetrics,
        IExportMetricsServiceResponse,
    > = ...
    diff --git a/variables/_opentelemetry_otlp-transformer.JsonTraceSerializer.html b/variables/_opentelemetry_otlp-transformer.JsonTraceSerializer.html index b14860e26..f04d4089f 100644 --- a/variables/_opentelemetry_otlp-transformer.JsonTraceSerializer.html +++ b/variables/_opentelemetry_otlp-transformer.JsonTraceSerializer.html @@ -1 +1 @@ -JsonTraceSerializer | OpenTelemetry SDK
    JsonTraceSerializer: ISerializer<
        node.ReadableSpan[],
        IExportTraceServiceResponse,
    > = ...
    +JsonTraceSerializer | OpenTelemetry SDK
    JsonTraceSerializer: ISerializer<
        node.ReadableSpan[],
        IExportTraceServiceResponse,
    > = ...
    diff --git a/variables/_opentelemetry_otlp-transformer.ProtobufLogsSerializer.html b/variables/_opentelemetry_otlp-transformer.ProtobufLogsSerializer.html index 6268135de..6d7891c19 100644 --- a/variables/_opentelemetry_otlp-transformer.ProtobufLogsSerializer.html +++ b/variables/_opentelemetry_otlp-transformer.ProtobufLogsSerializer.html @@ -1 +1 @@ -ProtobufLogsSerializer | OpenTelemetry SDK
    ProtobufLogsSerializer: ISerializer<
        logs.ReadableLogRecord[],
        IExportLogsServiceResponse,
    > = ...
    +ProtobufLogsSerializer | OpenTelemetry SDK
    ProtobufLogsSerializer: ISerializer<
        logs.ReadableLogRecord[],
        IExportLogsServiceResponse,
    > = ...
    diff --git a/variables/_opentelemetry_otlp-transformer.ProtobufMetricsSerializer.html b/variables/_opentelemetry_otlp-transformer.ProtobufMetricsSerializer.html index b1880348e..d8f4d6179 100644 --- a/variables/_opentelemetry_otlp-transformer.ProtobufMetricsSerializer.html +++ b/variables/_opentelemetry_otlp-transformer.ProtobufMetricsSerializer.html @@ -1 +1 @@ -ProtobufMetricsSerializer | OpenTelemetry SDK
    ProtobufMetricsSerializer: ISerializer<
        metrics.ResourceMetrics,
        IExportMetricsServiceResponse,
    > = ...
    +ProtobufMetricsSerializer | OpenTelemetry SDK
    ProtobufMetricsSerializer: ISerializer<
        metrics.ResourceMetrics,
        IExportMetricsServiceResponse,
    > = ...
    diff --git a/variables/_opentelemetry_otlp-transformer.ProtobufTraceSerializer.html b/variables/_opentelemetry_otlp-transformer.ProtobufTraceSerializer.html index 538873536..b7652b3c0 100644 --- a/variables/_opentelemetry_otlp-transformer.ProtobufTraceSerializer.html +++ b/variables/_opentelemetry_otlp-transformer.ProtobufTraceSerializer.html @@ -1 +1 @@ -ProtobufTraceSerializer | OpenTelemetry SDK
    ProtobufTraceSerializer: ISerializer<
        node.ReadableSpan[],
        IExportTraceServiceResponse,
    > = ...
    +ProtobufTraceSerializer | OpenTelemetry SDK
    ProtobufTraceSerializer: ISerializer<
        node.ReadableSpan[],
        IExportTraceServiceResponse,
    > = ...
    diff --git a/variables/_opentelemetry_propagator-b3.B3_CONTEXT_HEADER.html b/variables/_opentelemetry_propagator-b3.B3_CONTEXT_HEADER.html index 2b83b2994..ef3e0bcd9 100644 --- a/variables/_opentelemetry_propagator-b3.B3_CONTEXT_HEADER.html +++ b/variables/_opentelemetry_propagator-b3.B3_CONTEXT_HEADER.html @@ -1,2 +1,2 @@ B3_CONTEXT_HEADER | OpenTelemetry SDK
    B3_CONTEXT_HEADER: "b3" = 'b3'

    B3 single-header key

    -
    +
    diff --git a/variables/_opentelemetry_propagator-b3.X_B3_FLAGS.html b/variables/_opentelemetry_propagator-b3.X_B3_FLAGS.html index 00efcf3e4..c45972363 100644 --- a/variables/_opentelemetry_propagator-b3.X_B3_FLAGS.html +++ b/variables/_opentelemetry_propagator-b3.X_B3_FLAGS.html @@ -1 +1 @@ -X_B3_FLAGS | OpenTelemetry SDK
    X_B3_FLAGS: "x-b3-flags" = 'x-b3-flags'
    +X_B3_FLAGS | OpenTelemetry SDK
    X_B3_FLAGS: "x-b3-flags" = 'x-b3-flags'
    diff --git a/variables/_opentelemetry_propagator-b3.X_B3_PARENT_SPAN_ID.html b/variables/_opentelemetry_propagator-b3.X_B3_PARENT_SPAN_ID.html index 9c761e939..cb1fbf274 100644 --- a/variables/_opentelemetry_propagator-b3.X_B3_PARENT_SPAN_ID.html +++ b/variables/_opentelemetry_propagator-b3.X_B3_PARENT_SPAN_ID.html @@ -1 +1 @@ -X_B3_PARENT_SPAN_ID | OpenTelemetry SDK
    X_B3_PARENT_SPAN_ID: "x-b3-parentspanid" = 'x-b3-parentspanid'
    +X_B3_PARENT_SPAN_ID | OpenTelemetry SDK
    X_B3_PARENT_SPAN_ID: "x-b3-parentspanid" = 'x-b3-parentspanid'
    diff --git a/variables/_opentelemetry_propagator-b3.X_B3_SAMPLED.html b/variables/_opentelemetry_propagator-b3.X_B3_SAMPLED.html index 6c3cd47a3..be753ca9a 100644 --- a/variables/_opentelemetry_propagator-b3.X_B3_SAMPLED.html +++ b/variables/_opentelemetry_propagator-b3.X_B3_SAMPLED.html @@ -1 +1 @@ -X_B3_SAMPLED | OpenTelemetry SDK
    X_B3_SAMPLED: "x-b3-sampled" = 'x-b3-sampled'
    +X_B3_SAMPLED | OpenTelemetry SDK
    X_B3_SAMPLED: "x-b3-sampled" = 'x-b3-sampled'
    diff --git a/variables/_opentelemetry_propagator-b3.X_B3_SPAN_ID.html b/variables/_opentelemetry_propagator-b3.X_B3_SPAN_ID.html index ebef123a4..7835e38fe 100644 --- a/variables/_opentelemetry_propagator-b3.X_B3_SPAN_ID.html +++ b/variables/_opentelemetry_propagator-b3.X_B3_SPAN_ID.html @@ -1 +1 @@ -X_B3_SPAN_ID | OpenTelemetry SDK
    X_B3_SPAN_ID: "x-b3-spanid" = 'x-b3-spanid'
    +X_B3_SPAN_ID | OpenTelemetry SDK
    X_B3_SPAN_ID: "x-b3-spanid" = 'x-b3-spanid'
    diff --git a/variables/_opentelemetry_propagator-b3.X_B3_TRACE_ID.html b/variables/_opentelemetry_propagator-b3.X_B3_TRACE_ID.html index 97fe51e30..b8342bc58 100644 --- a/variables/_opentelemetry_propagator-b3.X_B3_TRACE_ID.html +++ b/variables/_opentelemetry_propagator-b3.X_B3_TRACE_ID.html @@ -1 +1 @@ -X_B3_TRACE_ID | OpenTelemetry SDK
    X_B3_TRACE_ID: "x-b3-traceid" = 'x-b3-traceid'
    +X_B3_TRACE_ID | OpenTelemetry SDK
    X_B3_TRACE_ID: "x-b3-traceid" = 'x-b3-traceid'
    diff --git a/variables/_opentelemetry_propagator-jaeger.UBER_BAGGAGE_HEADER_PREFIX.html b/variables/_opentelemetry_propagator-jaeger.UBER_BAGGAGE_HEADER_PREFIX.html index 0d6a689d9..4da2524aa 100644 --- a/variables/_opentelemetry_propagator-jaeger.UBER_BAGGAGE_HEADER_PREFIX.html +++ b/variables/_opentelemetry_propagator-jaeger.UBER_BAGGAGE_HEADER_PREFIX.html @@ -1 +1 @@ -UBER_BAGGAGE_HEADER_PREFIX | OpenTelemetry SDK
    UBER_BAGGAGE_HEADER_PREFIX: "uberctx" = 'uberctx'
    +UBER_BAGGAGE_HEADER_PREFIX | OpenTelemetry SDK
    UBER_BAGGAGE_HEADER_PREFIX: "uberctx" = 'uberctx'
    diff --git a/variables/_opentelemetry_propagator-jaeger.UBER_TRACE_ID_HEADER.html b/variables/_opentelemetry_propagator-jaeger.UBER_TRACE_ID_HEADER.html index 379fd46eb..4fd9e6d2c 100644 --- a/variables/_opentelemetry_propagator-jaeger.UBER_TRACE_ID_HEADER.html +++ b/variables/_opentelemetry_propagator-jaeger.UBER_TRACE_ID_HEADER.html @@ -1 +1 @@ -UBER_TRACE_ID_HEADER | OpenTelemetry SDK
    UBER_TRACE_ID_HEADER: "uber-trace-id" = 'uber-trace-id'
    +UBER_TRACE_ID_HEADER | OpenTelemetry SDK
    UBER_TRACE_ID_HEADER: "uber-trace-id" = 'uber-trace-id'
    diff --git a/variables/_opentelemetry_resources.envDetector.html b/variables/_opentelemetry_resources.envDetector.html index e576f0c4a..fa1137802 100644 --- a/variables/_opentelemetry_resources.envDetector.html +++ b/variables/_opentelemetry_resources.envDetector.html @@ -1 +1 @@ -envDetector | OpenTelemetry SDK
    envDetector: EnvDetector = ...
    +envDetector | OpenTelemetry SDK
    envDetector: EnvDetector = ...
    diff --git a/variables/_opentelemetry_resources.hostDetector.html b/variables/_opentelemetry_resources.hostDetector.html index 8eabf8f8d..06dcd6155 100644 --- a/variables/_opentelemetry_resources.hostDetector.html +++ b/variables/_opentelemetry_resources.hostDetector.html @@ -1 +1 @@ -hostDetector | OpenTelemetry SDK
    hostDetector: HostDetector = ...
    +hostDetector | OpenTelemetry SDK
    hostDetector: HostDetector = ...
    diff --git a/variables/_opentelemetry_resources.osDetector.html b/variables/_opentelemetry_resources.osDetector.html index c1dde83bf..53a8ce3ff 100644 --- a/variables/_opentelemetry_resources.osDetector.html +++ b/variables/_opentelemetry_resources.osDetector.html @@ -1 +1 @@ -osDetector | OpenTelemetry SDK
    osDetector: OSDetector = ...
    +osDetector | OpenTelemetry SDK
    osDetector: OSDetector = ...
    diff --git a/variables/_opentelemetry_resources.processDetector.html b/variables/_opentelemetry_resources.processDetector.html index cb115fa99..32fa6fcfd 100644 --- a/variables/_opentelemetry_resources.processDetector.html +++ b/variables/_opentelemetry_resources.processDetector.html @@ -1 +1 @@ -processDetector | OpenTelemetry SDK
    processDetector: ProcessDetector = ...
    +processDetector | OpenTelemetry SDK
    processDetector: ProcessDetector = ...
    diff --git a/variables/_opentelemetry_resources.serviceInstanceIdDetector.html b/variables/_opentelemetry_resources.serviceInstanceIdDetector.html index 43529b5bf..fede855d4 100644 --- a/variables/_opentelemetry_resources.serviceInstanceIdDetector.html +++ b/variables/_opentelemetry_resources.serviceInstanceIdDetector.html @@ -1 +1 @@ -serviceInstanceIdDetector | OpenTelemetry SDK

    Variable serviceInstanceIdDetectorConst Experimental

    serviceInstanceIdDetector: ServiceInstanceIdDetector = ...
    +serviceInstanceIdDetector | OpenTelemetry SDK

    Variable serviceInstanceIdDetectorConst Experimental

    serviceInstanceIdDetector: ServiceInstanceIdDetector = ...