Skip to content

Open telemetry #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft

Open telemetry #413

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
9b87760
open telemetry - initial formatting and organizing
jhadobe Jul 10, 2025
917a4c9
cleanup 1
jhadobe Jul 11, 2025
e884b40
part 2
jhadobe Jul 14, 2025
ec76438
linting
jhadobe Jul 15, 2025
1752332
Merge branch 'main' into jh_integration-OT
jhadobe Jul 15, 2025
3c32a12
clean up api reference
jhadobe Jul 15, 2025
31fc939
fix links
jhadobe Jul 16, 2025
e15adfd
Merge branch 'main' into jh_integration-OT
jhadobe Jul 16, 2025
5af937b
editing pass
jhadobe Jul 16, 2025
adeb665
Merge branch 'main' into jh_integration-OT
jhadobe Jul 18, 2025
8eb4456
Apply suggestions from code review
jhadobe Jul 30, 2025
e77a50a
Merge branch 'main' into jh_integration-OT
jhadobe Jul 30, 2025
6089331
code review
jhadobe Jul 30, 2025
f33793d
linting
jhadobe Jul 30, 2025
a601796
update apis
jhadobe Aug 1, 2025
109d22e
linting
jhadobe Aug 1, 2025
3667adc
Merge branch 'main' into jh_integration-OT
jhadobe Sep 17, 2025
6318c1d
fix link
jhadobe Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix links
  • Loading branch information
@jhadobe
jhadobe committed Jul 16, 2025
commit 31fc9395c6ed5505ce6b82a1cd3c90d5b4ca010f
12 changes: 6 additions & 6 deletions src/pages/starter-kit/integration/telemetry/reference/functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Helper to define the telemetry config for an entrypoint.

| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- |
| `init` | (`params`: `RecursiveStringRecord`, `isDevelopment`: `boolean`) => [`TelemetryConfig`](../interfaces/TelemetryConfig.md) | The function to initialize the telemetry. |
| `init` | (`params`: `RecursiveStringRecord`, `isDevelopment`: `boolean`) => [`TelemetryConfig`](./interfaces.md#telemetryconfig) | The function to initialize the telemetry. |

**Returns:**

Expand Down Expand Up @@ -311,7 +311,7 @@ Gets the global telemetry API.

**Returns:**

[`TelemetryApi`](../interfaces/TelemetryApi.md)
[`TelemetryApi`](./interfaces.md#telemetryapi)

**Throws:**

Expand Down Expand Up @@ -340,7 +340,7 @@ Access helpers for the current instrumented operation.

**Returns:**

[`InstrumentationContext`](../interfaces/InstrumentationContext.md)
[`InstrumentationContext`](./interfaces.md#instrumentationcontext)

**Defined in:** [core/instrumentation.ts:61](https://github.com/adobe/commerce-integration-starter-kit/blob/6d4d9f7c629d2abc0e81fce4567de926c2bddb60/packages/aio-lib-telemetry/source/core/instrumentation.ts#L61)

Expand Down Expand Up @@ -393,7 +393,7 @@ Get the instrumentations for a given preset.

| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------- | ------------------------------------------- |
| `preset` | [`TelemetryInstrumentationPreset`](../type-aliases/TelemetryInstrumentationPreset.md) | The preset to get the instrumentations for. |
| `preset` | [`TelemetryInstrumentationPreset`](./aliases.md#telemetryinstrumentationpreset) | The preset to get the instrumentations for. |

**Returns:**

Expand Down Expand Up @@ -444,7 +444,7 @@ Instruments a function.
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------ | ------------------------------------------ |
| `fn` | `T` | The function to instrument. |
| `config` | [`InstrumentationConfig`](../interfaces/InstrumentationConfig.md)\<`T`\> | The configuration for the instrumentation. |
| `config` | [`InstrumentationConfig`](./interfaces.md#instrumentationconfig)\<`T`\> | The configuration for the instrumentation. |

**Returns:**

Expand Down Expand Up @@ -492,7 +492,7 @@ Instruments the entrypoint of a runtime action. Needs to be used ONLY with the `
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `fn` | `T` | The entrypoint function to instrument. |
| `config` | [`EntrypointInstrumentationConfig`](../interfaces/EntrypointInstrumentationConfig.md)\<`T`\> | The configuration for the entrypoint instrumentation. |
| `config` | [`EntrypointInstrumentationConfig`](./interfaces.md#entrypointinstrumentationconfig)\<`T`\> | The configuration for the entrypoint instrumentation. |

**Returns:**

Expand Down
50 changes: 25 additions & 25 deletions src/pages/starter-kit/integration/telemetry/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,38 +90,38 @@ import {

| Interface | Description |
| -------------------------------- | --------------------------------------------------------------------------------- |
| [EntrypointInstrumentationConfig](./interfaces#entrypointinstrumentationconfig) | The configuration for entry point instrumentation. |
| [InstrumentationConfig](./interfaces#instrumentationconfig) | The configuration for instrumentation. |
| [InstrumentationContext](./interfaces#instrumentationcontext) | The context for the current operation. |
| [TelemetryApi](./interfaces#telemetryapi) | Defines the global telemetry API. These items should be set once per-application. |
| [TelemetryConfig](./interfaces#telemetryconfig) | The configuration options for the telemetry module. |
| [TelemetryDiagnosticsConfig](./interfaces#telemetrydiagnosticsconfig) | The configuration for the telemetry diagnostics. |
| [TelemetryPropagationConfig](./interfaces#telemetrypropagationconfig) | Configuration related to context propagation (for distributed tracing). |
| [EntrypointInstrumentationConfig](./interfaces.md#entrypointinstrumentationconfig) | The configuration for entry point instrumentation. |
| [InstrumentationConfig](./interfaces.md#instrumentationconfig) | The configuration for instrumentation. |
| [InstrumentationContext](./interfaces.md#instrumentationcontext) | The context for the current operation. |
| [TelemetryApi](./interfaces.md#telemetryapi) | Defines the global telemetry API. These items should be set once per-application. |
| [TelemetryConfig](./interfaces.md#telemetryconfig) | The configuration options for the telemetry module. |
| [TelemetryDiagnosticsConfig](./interfaces.md#telemetrydiagnosticsconfig) | The configuration for the telemetry diagnostics. |
| [TelemetryPropagationConfig](./interfaces.md#telemetrypropagationconfig) | Configuration related to context propagation (for distributed tracing). |

## Type aliases

| Type Alias | Description |
| ------------------------------- | ------------------------------------------------------- |
| [DiagnosticsLogLevel](./aliases#diagnosticsloglevel) | Available log levels for the OpenTelemetry DiagLogger. |
| [TelemetryInstrumentationPreset](./aliases#telemetryinstrumentationpreset) | Defines the names of available instrumentation presets. |
| [DiagnosticsLogLevel](./aliases.md#diagnosticsloglevel) | Available log levels for the OpenTelemetry DiagLogger. |
| [TelemetryInstrumentationPreset](./aliases.md#telemetryinstrumentationpreset) | Defines the names of available instrumentation presets. |

## Functions

| Function | Description |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [addEventToActiveSpan](./functions#addeventtoactivespan) | Adds an event to the given span. |
| [defineMetrics](./functions#definemetrics) | Helper to define a record of metrics. |
| [defineTelemetryConfig](./functions#definetelemetryconfig) | Helper to define the telemetry config for an entry point. |
| [deserializeContextFromCarrier](./functions#deserializecontextfromcarrier) | Deserializes the context from a carrier and augments the given base context with it. |
| [getActiveSpan](./functions#getactivespan) | Gets the active span from the given context. |
| [getAioRuntimeAttributes](./functions#getaioruntimeattributes) | Infers some useful attributes for the current action from the Adobe I/O Runtime and returns them as a record of key-value pairs. |
| [getAioRuntimeResource](./functions#getaioruntimeresource) | 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. |
| [getAioRuntimeResourceWithAttributes](./functions#getaioruntimeresourcewithattributes) | 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. |
| [getGlobalTelemetryApi](./functions#getglobaltelemetryapi) | Gets the global telemetry API. |
| [getInstrumentationHelpers](./functions#getinstrumentationhelpers) | Access helpers for the current instrumented operation. |
| [getLogger](./functions#getlogger) | Get a logger instance. |
| [getPresetInstrumentations](./functions#getpresetinstrumentations) | Get the instrumentations for a given preset. |
| [instrument](./functions#instrument) | Instruments a function. |
| [instrumentEntrypoint](./functions#instrumententrypoint) | Instruments the entrypoint of a runtime action. Needs to be used ONLY with the `main` function of a runtime action. |
| [serializeContextIntoCarrier](./functions#serializecontextintocarrier) | Serializes the current context into a carrier. |
| [tryGetActiveSpan](./functions#trygetactivespan) | Tries to get the active span from the given context. |
| [addEventToActiveSpan](./functions.md#addeventtoactivespan) | Adds an event to the given span. |
| [defineMetrics](./functions.md#definemetrics) | Helper to define a record of metrics. |
| [defineTelemetryConfig](./functions.md#definetelemetryconfig) | Helper to define the telemetry config for an entry point. |
| [deserializeContextFromCarrier](./functions.md#deserializecontextfromcarrier) | Deserializes the context from a carrier and augments the given base context with it. |
| [getActiveSpan](./functions.md#getactivespan) | Gets the active span from the given context. |
| [getAioRuntimeAttributes](./functions.md#getaioruntimeattributes) | Infers some useful attributes for the current action from the Adobe I/O Runtime and returns them as a record of key-value pairs. |
| [getAioRuntimeResource](./functions.md#getaioruntimeresource) | 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. |
| [getAioRuntimeResourceWithAttributes](./functions.md#getaioruntimeresourcewithattributes) | 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. |
| [getGlobalTelemetryApi](./functions.md#getglobaltelemetryapi) | Gets the global telemetry API. |
| [getInstrumentationHelpers](./functions.md#getinstrumentationhelpers) | Access helpers for the current instrumented operation. |
| [getLogger](./functions.md#getlogger) | Get a logger instance. |
| [getPresetInstrumentations](./functions.md#getpresetinstrumentations) | Get the instrumentations for a given preset. |
| [instrument](./functions.md#instrument) | Instruments a function. |
| [instrumentEntrypoint](./functions.md#instrumententrypoint) | Instruments the entrypoint of a runtime action. Needs to be used ONLY with the `main` function of a runtime action. |
| [serializeContextIntoCarrier](./functions.md#serializecontextintocarrier) | Serializes the current context into a carrier. |
| [tryGetActiveSpan](./functions.md#trygetactivespan) | Tries to get the active span from the given context. |