From b9d4e3dfd955d1d044e0a7b083f5087c4f61e322 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 26 Nov 2025 17:36:27 +0000 Subject: [PATCH 1/4] ci: release package --- .changeset/add-versioning-policy.md | 5 ----- .changeset/updated-otel-deps.md | 5 ----- CHANGELOG.md | 8 ++++++++ package.json | 2 +- 4 files changed, 9 insertions(+), 11 deletions(-) delete mode 100644 .changeset/add-versioning-policy.md delete mode 100644 .changeset/updated-otel-deps.md diff --git a/.changeset/add-versioning-policy.md b/.changeset/add-versioning-policy.md deleted file mode 100644 index b2d5c30..0000000 --- a/.changeset/add-versioning-policy.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@adobe/aio-lib-telemetry": patch ---- - -Add [versioning policy](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) to the README. diff --git a/.changeset/updated-otel-deps.md b/.changeset/updated-otel-deps.md deleted file mode 100644 index de90b06..0000000 --- a/.changeset/updated-otel-deps.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@adobe/aio-lib-telemetry": patch ---- - -[[BREAKING]](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) Update OpenTelemetry dependencies (see the [Renovate PR](https://github.com/adobe/aio-lib-telemetry/pull/62) for the full list). The `otel` entrypoint no longer re-exports the `NoopLogRecordProcessor` class, as it's no longer exported by the OpenTelemetry Logs SDK. If you were using it, removing it should be safe, as it basically does nothing and it's the same as not using the processor at all. diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b9a290..ab6278d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # @adobe/aio-lib-telemetry +## 1.1.1 + +### Patch Changes + +- [`f1a95e9`](https://github.com/adobe/aio-lib-telemetry/commit/f1a95e9a1190b1aa135c5f419fae7f8ae61977c3) Thanks [@iivvaannxx](https://github.com/iivvaannxx)! - Add [versioning policy](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) to the README. + +- [`4b63239`](https://github.com/adobe/aio-lib-telemetry/commit/4b6323945cee3ab5ffb63e2fe081a79590da9a97) Thanks [@iivvaannxx](https://github.com/iivvaannxx)! - [[BREAKING]](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) Update OpenTelemetry dependencies (see the [Renovate PR](https://github.com/adobe/aio-lib-telemetry/pull/62) for the full list). The `otel` entrypoint no longer re-exports the `NoopLogRecordProcessor` class, as it's no longer exported by the OpenTelemetry Logs SDK. If you were using it, removing it should be safe, as it basically does nothing and it's the same as not using the processor at all. + ## 1.1.0 ### Minor Changes diff --git a/package.json b/package.json index 84421a5..7a79853 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@adobe/aio-lib-telemetry", - "version": "1.1.0", + "version": "1.1.1", "author": "Adobe Inc.", "type": "module", "license": "Apache-2.0", From 317842f77a9a2210592cfbae768ca97d536e39af Mon Sep 17 00:00:00 2001 From: Ivan Porto Date: Wed, 26 Nov 2025 18:40:06 +0100 Subject: [PATCH 2/4] chore: patch changelog --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ab6278d..635a181 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,9 +4,9 @@ ### Patch Changes -- [`f1a95e9`](https://github.com/adobe/aio-lib-telemetry/commit/f1a95e9a1190b1aa135c5f419fae7f8ae61977c3) Thanks [@iivvaannxx](https://github.com/iivvaannxx)! - Add [versioning policy](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) to the README. +- [`5542c99`](https://github.com/adobe/aio-lib-telemetry/commit/5542c993df9f8328e36fe67c0a16f0e17b9a9b1f) Thanks [@iivvaannxx](https://github.com/iivvaannxx)! - Add [versioning policy](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) to the README. -- [`4b63239`](https://github.com/adobe/aio-lib-telemetry/commit/4b6323945cee3ab5ffb63e2fe081a79590da9a97) Thanks [@iivvaannxx](https://github.com/iivvaannxx)! - [[BREAKING]](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) Update OpenTelemetry dependencies (see the [Renovate PR](https://github.com/adobe/aio-lib-telemetry/pull/62) for the full list). The `otel` entrypoint no longer re-exports the `NoopLogRecordProcessor` class, as it's no longer exported by the OpenTelemetry Logs SDK. If you were using it, removing it should be safe, as it basically does nothing and it's the same as not using the processor at all. +- [`d9b3f27`](https://github.com/adobe/aio-lib-telemetry/commit/d9b3f273af3b1ea79aae1aa34d237a0804b84fcb) Thanks [@iivvaannxx](https://github.com/iivvaannxx)! - [[BREAKING]](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) Update OpenTelemetry dependencies (see the [Renovate PR](https://github.com/adobe/aio-lib-telemetry/pull/62) for the full list). The `otel` entrypoint no longer re-exports the `NoopLogRecordProcessor` class, as it's no longer exported by the OpenTelemetry Logs SDK. If you were using it, removing it should be safe, as it basically does nothing and it's the same as not using the processor at all. ## 1.1.0 From 1f53e52b3c00b4b48e865d25d6951b2d594b23f5 Mon Sep 17 00:00:00 2001 From: Ivan Porto Date: Wed, 26 Nov 2025 18:41:09 +0100 Subject: [PATCH 3/4] docs: regenerate api reference --- docs/api-reference/README.md | 2 +- docs/api-reference/_media/otel.ts | 69 +++++++++++++++++++ .../functions/addEventToActiveSpan.md | 2 +- docs/api-reference/functions/defineMetrics.md | 2 +- .../functions/defineTelemetryConfig.md | 2 +- .../deserializeContextFromCarrier.md | 2 +- docs/api-reference/functions/getActiveSpan.md | 2 +- .../functions/getAioRuntimeAttributes.md | 2 +- .../functions/getAioRuntimeResource.md | 2 +- .../getAioRuntimeResourceWithAttributes.md | 2 +- .../functions/getGlobalTelemetryApi.md | 2 +- .../functions/getInstrumentationHelpers.md | 2 +- docs/api-reference/functions/getLogger.md | 2 +- .../functions/getPresetInstrumentations.md | 2 +- docs/api-reference/functions/instrument.md | 2 +- .../functions/instrumentEntrypoint.md | 2 +- .../functions/serializeContextIntoCarrier.md | 2 +- .../functions/tryAddEventToActiveSpan.md | 2 +- .../functions/tryGetActiveSpan.md | 2 +- .../EntrypointInstrumentationConfig.md | 14 ++-- .../interfaces/TelemetryConfig.md | 12 ++-- .../type-aliases/DiagnosticsLogLevel.md | 2 +- .../type-aliases/EntrypointFunction.md | 2 +- .../type-aliases/InstrumentationConfig.md | 8 +-- .../type-aliases/InstrumentationContext.md | 12 ++-- .../type-aliases/TelemetryApi.md | 6 +- .../TelemetryDiagnosticsConfig.md | 8 +-- .../TelemetryInstrumentationPreset.md | 2 +- .../type-aliases/TelemetryIntegration.md | 6 +- .../TelemetryPropagationConfig.md | 6 +- 30 files changed, 126 insertions(+), 57 deletions(-) create mode 100644 docs/api-reference/_media/otel.ts diff --git a/docs/api-reference/README.md b/docs/api-reference/README.md index 0cda8cd..b160013 100644 --- a/docs/api-reference/README.md +++ b/docs/api-reference/README.md @@ -40,7 +40,7 @@ import { ### OpenTelemetry API -OpenTelemetry features a modular architecture consisting of over 25 packages, which can make importing specific APIs rather complex. To streamline this process, our library offers a convenient "meta-package" import path. This allows you to import all the necessary OpenTelemetry APIs from a single source, simplifying the setup. +OpenTelemetry features a modular architecture consisting of over 25 packages, which can make importing specific APIs rather complex. To streamline this process, our library offers a convenient "meta-package" [`otel` import path](_media/otel.ts). This allows you to import all the necessary OpenTelemetry APIs from a single source, simplifying the setup. While this does not include every OpenTelemetry API, it covers the most common ones you will need in your code. If you find any essential APIs missing, feel free to open an issue or submit a PR. You can also import the APIs you need from the individual OpenTelemetry packages, but this is a convenient way to import all the APIs you need in a single import. diff --git a/docs/api-reference/_media/otel.ts b/docs/api-reference/_media/otel.ts new file mode 100644 index 0000000..be7e306 --- /dev/null +++ b/docs/api-reference/_media/otel.ts @@ -0,0 +1,69 @@ +/* + * Copyright 2025 Adobe. All rights reserved. + * This file is licensed to you under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. You may obtain a copy + * of the License at http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under + * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS + * OF ANY KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. + */ + +// This file re-exports the most commonly used OpenTelemetry components. +// It provides core APIs, SDKs, exporters, and resources while omitting +// specialized packages like individual instrumentations and similar utilities. + +/** biome-ignore-all lint/performance/noBarrelFile: This is the import entrypoint for the public API. */ + +export * from "@opentelemetry/api"; +export * from "@opentelemetry/api-logs"; +export { OTLPLogExporter as OTLPLogExporterGrpc } from "@opentelemetry/exporter-logs-otlp-grpc"; +export { OTLPLogExporter as OTLPLogExporterHttp } from "@opentelemetry/exporter-logs-otlp-http"; +export { OTLPLogExporter as OTLPLogExporterProto } from "@opentelemetry/exporter-logs-otlp-proto"; +export { OTLPMetricExporter as OTLPMetricExporterGrpc } from "@opentelemetry/exporter-metrics-otlp-grpc"; +export { OTLPMetricExporter as OTLPMetricExporterHttp } from "@opentelemetry/exporter-metrics-otlp-http"; +export { OTLPMetricExporter as OTLPMetricExporterProto } from "@opentelemetry/exporter-metrics-otlp-proto"; +export { OTLPTraceExporter as OTLPTraceExporterGrpc } from "@opentelemetry/exporter-trace-otlp-grpc"; +export { OTLPTraceExporter as OTLPTraceExporterHttp } from "@opentelemetry/exporter-trace-otlp-http"; +export { OTLPTraceExporter as OTLPTraceExporterProto } from "@opentelemetry/exporter-trace-otlp-proto"; +export * from "@opentelemetry/otlp-exporter-base"; +export * from "@opentelemetry/otlp-grpc-exporter-base"; +export * from "@opentelemetry/resources"; +export { + BatchLogRecordProcessor, + ConsoleLogRecordExporter, + InMemoryLogRecordExporter, + LoggerProvider, + type SdkLogRecord, + SimpleLogRecordProcessor, +} from "@opentelemetry/sdk-logs"; +export { + AggregationType, + ConsoleMetricExporter, + createAllowListAttributesProcessor, + createDenyListAttributesProcessor, + DataPointType, + InMemoryMetricExporter, + InstrumentType, + MeterProvider, + MetricReader, + PeriodicExportingMetricReader, + TimeoutError, +} from "@opentelemetry/sdk-metrics"; +export { + AlwaysOffSampler, + AlwaysOnSampler, + BasicTracerProvider, + BatchSpanProcessor, + ConsoleSpanExporter, + InMemorySpanExporter, + NodeTracerProvider, + NoopSpanProcessor, + ParentBasedSampler, + RandomIdGenerator, + SamplingDecision, + SimpleSpanProcessor, + TraceIdRatioBasedSampler, +} from "@opentelemetry/sdk-trace-node"; +export * from "@opentelemetry/semantic-conventions"; diff --git a/docs/api-reference/functions/addEventToActiveSpan.md b/docs/api-reference/functions/addEventToActiveSpan.md index 770bb9e..746728e 100644 --- a/docs/api-reference/functions/addEventToActiveSpan.md +++ b/docs/api-reference/functions/addEventToActiveSpan.md @@ -4,7 +4,7 @@ function addEventToActiveSpan(event: string, attributes?: Attributes): void; ``` -Defined in: [api/global.ts:72](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/global.ts#L72) +Defined in: [api/global.ts:72](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/global.ts#L72) Adds an event to the given span. diff --git a/docs/api-reference/functions/defineMetrics.md b/docs/api-reference/functions/defineMetrics.md index 5875427..bec7274 100644 --- a/docs/api-reference/functions/defineMetrics.md +++ b/docs/api-reference/functions/defineMetrics.md @@ -4,7 +4,7 @@ function defineMetrics(createMetrics: (meter: Meter) => T): T; ``` -Defined in: [core/metrics.ts:52](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/core/metrics.ts#L52) +Defined in: [core/metrics.ts:52](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/core/metrics.ts#L52) Helper to define a record of metrics. diff --git a/docs/api-reference/functions/defineTelemetryConfig.md b/docs/api-reference/functions/defineTelemetryConfig.md index d3f2805..85a217d 100644 --- a/docs/api-reference/functions/defineTelemetryConfig.md +++ b/docs/api-reference/functions/defineTelemetryConfig.md @@ -14,7 +14,7 @@ function defineTelemetryConfig( }; ``` -Defined in: [core/config.ts:21](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/core/config.ts#L21) +Defined in: [core/config.ts:21](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/core/config.ts#L21) Helper to define the telemetry configuration for an entrypoint. diff --git a/docs/api-reference/functions/deserializeContextFromCarrier.md b/docs/api-reference/functions/deserializeContextFromCarrier.md index 18a3858..b65af2c 100644 --- a/docs/api-reference/functions/deserializeContextFromCarrier.md +++ b/docs/api-reference/functions/deserializeContextFromCarrier.md @@ -7,7 +7,7 @@ function deserializeContextFromCarrier( ): Context; ``` -Defined in: [api/propagation.ts:61](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/propagation.ts#L61) +Defined in: [api/propagation.ts:61](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/propagation.ts#L61) Deserializes the context from a carrier and augments the given base context with it. diff --git a/docs/api-reference/functions/getActiveSpan.md b/docs/api-reference/functions/getActiveSpan.md index 909d5c5..86f7834 100644 --- a/docs/api-reference/functions/getActiveSpan.md +++ b/docs/api-reference/functions/getActiveSpan.md @@ -4,7 +4,7 @@ function getActiveSpan(ctx: Context): Span; ``` -Defined in: [api/global.ts:30](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/global.ts#L30) +Defined in: [api/global.ts:30](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/global.ts#L30) Gets the active span from the given context. diff --git a/docs/api-reference/functions/getAioRuntimeAttributes.md b/docs/api-reference/functions/getAioRuntimeAttributes.md index b325550..247d63a 100644 --- a/docs/api-reference/functions/getAioRuntimeAttributes.md +++ b/docs/api-reference/functions/getAioRuntimeAttributes.md @@ -10,7 +10,7 @@ function getAioRuntimeAttributes(): { }; ``` -Defined in: [api/attributes.ts:28](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/attributes.ts#L28) +Defined in: [api/attributes.ts:28](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/attributes.ts#L28) Infers some useful attributes for the current action from the Adobe I/O Runtime and returns them as a record of key-value pairs. diff --git a/docs/api-reference/functions/getAioRuntimeResource.md b/docs/api-reference/functions/getAioRuntimeResource.md index ee8d9b6..8ef0384 100644 --- a/docs/api-reference/functions/getAioRuntimeResource.md +++ b/docs/api-reference/functions/getAioRuntimeResource.md @@ -4,7 +4,7 @@ function getAioRuntimeResource(): Resource; ``` -Defined in: [api/attributes.ts:45](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/attributes.ts#L45) +Defined in: [api/attributes.ts:45](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/attributes.ts#L45) Creates a [resource](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_sdk-node.resources.Resource.html) from the attributes inferred from the Adobe I/O Runtime and returns it as an OpenTelemetry Resource object. diff --git a/docs/api-reference/functions/getAioRuntimeResourceWithAttributes.md b/docs/api-reference/functions/getAioRuntimeResourceWithAttributes.md index 94c139f..d4fa686 100644 --- a/docs/api-reference/functions/getAioRuntimeResourceWithAttributes.md +++ b/docs/api-reference/functions/getAioRuntimeResourceWithAttributes.md @@ -6,7 +6,7 @@ function getAioRuntimeResourceWithAttributes( ): Resource; ``` -Defined in: [api/attributes.ts:64](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/attributes.ts#L64) +Defined in: [api/attributes.ts:64](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/attributes.ts#L64) Creates a [resource](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_sdk-node.resources.Resource.html) that combines the attributes inferred from the Adobe I/O Runtime with the provided attributes. diff --git a/docs/api-reference/functions/getGlobalTelemetryApi.md b/docs/api-reference/functions/getGlobalTelemetryApi.md index a92ae38..471696d 100644 --- a/docs/api-reference/functions/getGlobalTelemetryApi.md +++ b/docs/api-reference/functions/getGlobalTelemetryApi.md @@ -4,7 +4,7 @@ function getGlobalTelemetryApi(): TelemetryApi; ``` -Defined in: [core/telemetry-api.ts:34](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/core/telemetry-api.ts#L34) +Defined in: [core/telemetry-api.ts:34](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/core/telemetry-api.ts#L34) Gets the global telemetry API. diff --git a/docs/api-reference/functions/getInstrumentationHelpers.md b/docs/api-reference/functions/getInstrumentationHelpers.md index 393d478..206f4ed 100644 --- a/docs/api-reference/functions/getInstrumentationHelpers.md +++ b/docs/api-reference/functions/getInstrumentationHelpers.md @@ -4,7 +4,7 @@ function getInstrumentationHelpers(): InstrumentationContext; ``` -Defined in: [core/instrumentation.ts:73](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/core/instrumentation.ts#L73) +Defined in: [core/instrumentation.ts:73](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/core/instrumentation.ts#L73) Access helpers for the current instrumented operation. diff --git a/docs/api-reference/functions/getLogger.md b/docs/api-reference/functions/getLogger.md index cd6454d..ff2269f 100644 --- a/docs/api-reference/functions/getLogger.md +++ b/docs/api-reference/functions/getLogger.md @@ -4,7 +4,7 @@ function getLogger(name: string, config?: AioLoggerConfig): AioLogger; ``` -Defined in: [core/logging.ts:86](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/core/logging.ts#L86) +Defined in: [core/logging.ts:86](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/core/logging.ts#L86) Gets a logger instance that can export OpenTelemetry logs. diff --git a/docs/api-reference/functions/getPresetInstrumentations.md b/docs/api-reference/functions/getPresetInstrumentations.md index 7398516..830242c 100644 --- a/docs/api-reference/functions/getPresetInstrumentations.md +++ b/docs/api-reference/functions/getPresetInstrumentations.md @@ -6,7 +6,7 @@ function getPresetInstrumentations( ): Instrumentation[]; ``` -Defined in: [api/presets.ts:54](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/presets.ts#L54) +Defined in: [api/presets.ts:54](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/presets.ts#L54) Gets the instrumentations for a given preset. diff --git a/docs/api-reference/functions/instrument.md b/docs/api-reference/functions/instrument.md index a8ad566..5195da4 100644 --- a/docs/api-reference/functions/instrument.md +++ b/docs/api-reference/functions/instrument.md @@ -7,7 +7,7 @@ function instrument( ): (...args: Parameters) => ReturnType; ``` -Defined in: [core/instrumentation.ts:114](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/core/instrumentation.ts#L114) +Defined in: [core/instrumentation.ts:114](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/core/instrumentation.ts#L114) Instruments a function. diff --git a/docs/api-reference/functions/instrumentEntrypoint.md b/docs/api-reference/functions/instrumentEntrypoint.md index b354482..1e3c529 100644 --- a/docs/api-reference/functions/instrumentEntrypoint.md +++ b/docs/api-reference/functions/instrumentEntrypoint.md @@ -7,7 +7,7 @@ function instrumentEntrypoint( ): (params: Record) => ReturnType; ``` -Defined in: [core/instrumentation.ts:272](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/core/instrumentation.ts#L272) +Defined in: [core/instrumentation.ts:272](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/core/instrumentation.ts#L272) Instruments the entrypoint of a runtime action. Needs to be used ONLY with the `main` function of a runtime action. diff --git a/docs/api-reference/functions/serializeContextIntoCarrier.md b/docs/api-reference/functions/serializeContextIntoCarrier.md index cd52910..3bcf602 100644 --- a/docs/api-reference/functions/serializeContextIntoCarrier.md +++ b/docs/api-reference/functions/serializeContextIntoCarrier.md @@ -7,7 +7,7 @@ function serializeContextIntoCarrier( ): Carrier; ``` -Defined in: [api/propagation.ts:38](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/propagation.ts#L38) +Defined in: [api/propagation.ts:38](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/propagation.ts#L38) Serializes the current context into a carrier. diff --git a/docs/api-reference/functions/tryAddEventToActiveSpan.md b/docs/api-reference/functions/tryAddEventToActiveSpan.md index e43b34d..03bcd60 100644 --- a/docs/api-reference/functions/tryAddEventToActiveSpan.md +++ b/docs/api-reference/functions/tryAddEventToActiveSpan.md @@ -7,7 +7,7 @@ function tryAddEventToActiveSpan( ): boolean; ``` -Defined in: [api/global.ts:88](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/global.ts#L88) +Defined in: [api/global.ts:88](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/global.ts#L88) Tries to add an event to the active span. diff --git a/docs/api-reference/functions/tryGetActiveSpan.md b/docs/api-reference/functions/tryGetActiveSpan.md index bb0355d..a05f64e 100644 --- a/docs/api-reference/functions/tryGetActiveSpan.md +++ b/docs/api-reference/functions/tryGetActiveSpan.md @@ -4,7 +4,7 @@ function tryGetActiveSpan(ctx: Context): Span | null; ``` -Defined in: [api/global.ts:52](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/api/global.ts#L52) +Defined in: [api/global.ts:52](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/api/global.ts#L52) Tries to get the active span from the given context. diff --git a/docs/api-reference/interfaces/EntrypointInstrumentationConfig.md b/docs/api-reference/interfaces/EntrypointInstrumentationConfig.md index 7c5db4e..9e85858 100644 --- a/docs/api-reference/interfaces/EntrypointInstrumentationConfig.md +++ b/docs/api-reference/interfaces/EntrypointInstrumentationConfig.md @@ -1,6 +1,6 @@ # `EntrypointInstrumentationConfig` -Defined in: [types.ts:240](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L240) +Defined in: [types.ts:240](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L240) The configuration for entrypoint instrumentation. @@ -23,7 +23,7 @@ optional hooks: { }; ``` -Defined in: [types.ts:138](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L138) +Defined in: [types.ts:138](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L138) Hooks that can be used to act on a span depending on the result of the function. @@ -92,7 +92,7 @@ initializeTelemetry: ( ) => TelemetryConfig; ``` -Defined in: [types.ts:266](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L266) +Defined in: [types.ts:266](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L266) This function is called at the start of the action. @@ -121,7 +121,7 @@ The telemetry configuration to use for the action. optional integrations: TelemetryIntegration[]; ``` -Defined in: [types.ts:255](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L255) +Defined in: [types.ts:255](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L255) Integrations with external telemetry systems. @@ -143,7 +143,7 @@ Integrations with external telemetry systems. optional isSuccessful: (result: unknown) => boolean; ``` -Defined in: [types.ts:135](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L135) +Defined in: [types.ts:135](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L135) A function that will be called to determine if the instrumented function was successful. By default, the function is considered successful if it doesn't throw an error. @@ -178,7 +178,7 @@ InstrumentationConfig.isSuccessful; optional propagation: TelemetryPropagationConfig; ``` -Defined in: [types.ts:248](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L248) +Defined in: [types.ts:248](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L248) Configuration options related to context propagation. See the [TelemetryPropagationConfig](../type-aliases/TelemetryPropagationConfig.md) for the interface. @@ -198,7 +198,7 @@ optional spanConfig: SpanOptions & { }; ``` -Defined in: [types.ts:106](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L106) +Defined in: [types.ts:106](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L106) Configuration options related to the span started by the instrumented function. See also the [SpanOptions](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api._opentelemetry_api.SpanOptions.html) interface. diff --git a/docs/api-reference/interfaces/TelemetryConfig.md b/docs/api-reference/interfaces/TelemetryConfig.md index 95bd1e1..df43b23 100644 --- a/docs/api-reference/interfaces/TelemetryConfig.md +++ b/docs/api-reference/interfaces/TelemetryConfig.md @@ -1,6 +1,6 @@ # `TelemetryConfig` -Defined in: [types.ts:200](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L200) +Defined in: [types.ts:200](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L200) The configuration options for the telemetry module. @@ -22,7 +22,7 @@ optional diagnostics: | TelemetryDiagnosticsConfig; ``` -Defined in: [types.ts:227](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L227) +Defined in: [types.ts:227](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L227) The configuration options for the telemetry diagnostics. @@ -38,7 +38,7 @@ The configuration options for the telemetry diagnostics. optional instrumentationConfig: Omit; ``` -Defined in: [types.ts:218](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L218) +Defined in: [types.ts:218](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L218) The instrumentation configuration that will be used for the entrypoint function. @@ -65,7 +65,7 @@ undefined; optional meter: Meter; ``` -Defined in: [types.ts:287](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L287) +Defined in: [types.ts:287](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L287) The meter used to create metrics. @@ -87,7 +87,7 @@ Partial.meter; sdkConfig: Partial; ``` -Defined in: [types.ts:207](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L207) +Defined in: [types.ts:207](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L207) The configuration options for the OpenTelemetry SDK. See the [NodeSDKConfiguration](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_sdk-node.NodeSDKConfiguration.html) interface. @@ -104,7 +104,7 @@ See the [NodeSDKConfiguration](https://open-telemetry.github.io/opentelemetry-js optional tracer: Tracer; ``` -Defined in: [types.ts:281](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L281) +Defined in: [types.ts:281](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L281) The tracer used to create spans. diff --git a/docs/api-reference/type-aliases/DiagnosticsLogLevel.md b/docs/api-reference/type-aliases/DiagnosticsLogLevel.md index 5a9e706..810022e 100644 --- a/docs/api-reference/type-aliases/DiagnosticsLogLevel.md +++ b/docs/api-reference/type-aliases/DiagnosticsLogLevel.md @@ -4,7 +4,7 @@ type DiagnosticsLogLevel = Lowercase; ``` -Defined in: [types.ts:29](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L29) +Defined in: [types.ts:29](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L29) Available log levels for the OpenTelemetry `DiagLogger`. diff --git a/docs/api-reference/type-aliases/EntrypointFunction.md b/docs/api-reference/type-aliases/EntrypointFunction.md index bc7e351..3ab3cb0 100644 --- a/docs/api-reference/type-aliases/EntrypointFunction.md +++ b/docs/api-reference/type-aliases/EntrypointFunction.md @@ -4,7 +4,7 @@ type EntrypointFunction = (params: Record) => unknown; ``` -Defined in: [types.ts:234](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L234) +Defined in: [types.ts:234](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L234) The shape of the entrypoint function. diff --git a/docs/api-reference/type-aliases/InstrumentationConfig.md b/docs/api-reference/type-aliases/InstrumentationConfig.md index ac61d10..ba45244 100644 --- a/docs/api-reference/type-aliases/InstrumentationConfig.md +++ b/docs/api-reference/type-aliases/InstrumentationConfig.md @@ -14,7 +14,7 @@ type InstrumentationConfig = { }; ``` -Defined in: [types.ts:99](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L99) +Defined in: [types.ts:99](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L99) The configuration for instrumentation. @@ -43,7 +43,7 @@ optional hooks: { }; ``` -Defined in: [types.ts:138](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L138) +Defined in: [types.ts:138](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L138) Hooks that can be used to act on a span depending on the result of the function. @@ -103,7 +103,7 @@ You can use it to do something with the Span. optional isSuccessful: (result: ReturnType) => boolean; ``` -Defined in: [types.ts:135](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L135) +Defined in: [types.ts:135](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L135) A function that will be called to determine if the instrumented function was successful. By default, the function is considered successful if it doesn't throw an error. @@ -135,7 +135,7 @@ optional spanConfig: SpanOptions & { }; ``` -Defined in: [types.ts:106](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L106) +Defined in: [types.ts:106](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L106) Configuration options related to the span started by the instrumented function. See also the [SpanOptions](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api._opentelemetry_api.SpanOptions.html) interface. diff --git a/docs/api-reference/type-aliases/InstrumentationContext.md b/docs/api-reference/type-aliases/InstrumentationContext.md index b09a020..7832b80 100644 --- a/docs/api-reference/type-aliases/InstrumentationContext.md +++ b/docs/api-reference/type-aliases/InstrumentationContext.md @@ -10,7 +10,7 @@ type InstrumentationContext = { }; ``` -Defined in: [types.ts:294](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L294) +Defined in: [types.ts:294](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L294) The context for the current operation. @@ -26,7 +26,7 @@ The context for the current operation. contextCarrier: Record; ``` -Defined in: [types.ts:323](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L323) +Defined in: [types.ts:323](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L323) Holds a carrier that can be used to propagate the active context. @@ -42,7 +42,7 @@ Holds a carrier that can be used to propagate the active context. currentSpan: Span; ``` -Defined in: [types.ts:317](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L317) +Defined in: [types.ts:317](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L317) The span of the current operation. @@ -58,7 +58,7 @@ The span of the current operation. logger: ReturnType; ``` -Defined in: [types.ts:311](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L311) +Defined in: [types.ts:311](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L311) The logger for the current operation. @@ -74,7 +74,7 @@ The logger for the current operation. meter: Meter; ``` -Defined in: [types.ts:305](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L305) +Defined in: [types.ts:305](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L305) The global (managed by the library) meter instance used to create metrics. @@ -90,7 +90,7 @@ The global (managed by the library) meter instance used to create metrics. tracer: Tracer; ``` -Defined in: [types.ts:299](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L299) +Defined in: [types.ts:299](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L299) The global (managed by the library) tracer instance used to create spans. diff --git a/docs/api-reference/type-aliases/TelemetryApi.md b/docs/api-reference/type-aliases/TelemetryApi.md index 4834ab4..9303b81 100644 --- a/docs/api-reference/type-aliases/TelemetryApi.md +++ b/docs/api-reference/type-aliases/TelemetryApi.md @@ -7,7 +7,7 @@ type TelemetryApi = { }; ``` -Defined in: [types.ts:276](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L276) +Defined in: [types.ts:276](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L276) Defines the global telemetry API. These items should be set once per application. @@ -23,7 +23,7 @@ Defines the global telemetry API. These items should be set once per application meter: Meter; ``` -Defined in: [types.ts:287](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L287) +Defined in: [types.ts:287](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L287) The meter used to create metrics. @@ -39,7 +39,7 @@ The meter used to create metrics. tracer: Tracer; ``` -Defined in: [types.ts:281](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L281) +Defined in: [types.ts:281](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L281) The tracer used to create spans. diff --git a/docs/api-reference/type-aliases/TelemetryDiagnosticsConfig.md b/docs/api-reference/type-aliases/TelemetryDiagnosticsConfig.md index d450a72..8b198d8 100644 --- a/docs/api-reference/type-aliases/TelemetryDiagnosticsConfig.md +++ b/docs/api-reference/type-aliases/TelemetryDiagnosticsConfig.md @@ -8,7 +8,7 @@ type TelemetryDiagnosticsConfig = { }; ``` -Defined in: [types.ts:41](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L41) +Defined in: [types.ts:41](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L41) The configuration for the telemetry diagnostics. @@ -24,7 +24,7 @@ The configuration for the telemetry diagnostics. optional exportLogs: boolean; ``` -Defined in: [types.ts:63](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L63) +Defined in: [types.ts:63](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L63) Whether to make OpenTelemetry also export the diagnostic logs to the configured exporters. Set to `false` if you don't want to see diagnostic logs in your observability platform. @@ -47,7 +47,7 @@ true; optional loggerName: string; ``` -Defined in: [types.ts:54](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L54) +Defined in: [types.ts:54](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L54) The name of the logger to use for the diagnostics. @@ -67,7 +67,7 @@ The name of the logger to use for the diagnostics. logLevel: DiagnosticsLogLevel; ``` -Defined in: [types.ts:46](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L46) +Defined in: [types.ts:46](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L46) The log level to use for the diagnostics. diff --git a/docs/api-reference/type-aliases/TelemetryInstrumentationPreset.md b/docs/api-reference/type-aliases/TelemetryInstrumentationPreset.md index 7693c20..bbdcbeb 100644 --- a/docs/api-reference/type-aliases/TelemetryInstrumentationPreset.md +++ b/docs/api-reference/type-aliases/TelemetryInstrumentationPreset.md @@ -4,7 +4,7 @@ type TelemetryInstrumentationPreset = "simple" | "full"; ``` -Defined in: [types.ts:35](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L35) +Defined in: [types.ts:35](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L35) Defines the names of available instrumentation presets. diff --git a/docs/api-reference/type-aliases/TelemetryIntegration.md b/docs/api-reference/type-aliases/TelemetryIntegration.md index 565f7f1..e466ee3 100644 --- a/docs/api-reference/type-aliases/TelemetryIntegration.md +++ b/docs/api-reference/type-aliases/TelemetryIntegration.md @@ -16,7 +16,7 @@ type TelemetryIntegration = { }; ``` -Defined in: [types.ts:167](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L167) +Defined in: [types.ts:167](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L167) A telemetry integration. @@ -32,7 +32,7 @@ A telemetry integration. name: string; ``` -Defined in: [types.ts:172](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L172) +Defined in: [types.ts:172](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L172) The name of the integration. @@ -52,7 +52,7 @@ optional patchInstrumentationConfig: (payload: { }) => void; ``` -Defined in: [types.ts:183](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L183) +Defined in: [types.ts:183](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L183) A function that patches the [EntrypointInstrumentationConfig](../interfaces/EntrypointInstrumentationConfig.md) provided in [defineTelemetryConfig](../functions/defineTelemetryConfig.md) or in the [instrumentEntrypoint](../functions/instrumentEntrypoint.md) function. diff --git a/docs/api-reference/type-aliases/TelemetryPropagationConfig.md b/docs/api-reference/type-aliases/TelemetryPropagationConfig.md index c8da2ce..10b7a47 100644 --- a/docs/api-reference/type-aliases/TelemetryPropagationConfig.md +++ b/docs/api-reference/type-aliases/TelemetryPropagationConfig.md @@ -10,7 +10,7 @@ type TelemetryPropagationConfig = { }; ``` -Defined in: [types.ts:70](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L70) +Defined in: [types.ts:70](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L70) Configuration related to context propagation (for distributed tracing). @@ -29,7 +29,7 @@ optional getContextCarrier: (params: Record) => { }; ``` -Defined in: [types.ts:89](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L89) +Defined in: [types.ts:89](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L89) A function that returns the carrier for the current context. Use it to specify where your carrier is located in the incoming parameters, when it's not one of the defaults. @@ -75,7 +75,7 @@ carrier: Record; optional skip: boolean; ``` -Defined in: [types.ts:78](https://github.com/adobe/aio-lib-telemetry/blob/559503f2d0d79c50f3f552437165225cc1007a4f/source/types.ts#L78) +Defined in: [types.ts:78](https://github.com/adobe/aio-lib-telemetry/blob/317842f77a9a2210592cfbae768ca97d536e39af/source/types.ts#L78) By default, an instrumented entrypoint will try to automatically read (and use) the context from the incoming request. Set to `true` if you want to skip this automatic context propagation. From 93c483586d3c2089f46221e7e304ab8de9b99350 Mon Sep 17 00:00:00 2001 From: Ivan Porto Date: Wed, 26 Nov 2025 18:44:34 +0100 Subject: [PATCH 4/4] chore: add knip json --- knip.json | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 knip.json diff --git a/knip.json b/knip.json new file mode 100644 index 0000000..d3e5fc3 --- /dev/null +++ b/knip.json @@ -0,0 +1,3 @@ +{ + "project": ["**/*", "!docs"] +}