Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430332272.3 KB

Creates a dynamic instrumentation configuration for a specific code or endpoint location within a service and environment. Configurations are immutable after creation.

For BREAKPOINT type configurations, they expire after 24 hours unless a shorter expiration is provided. For PROBE type configurations, they persist until explicitly deleted; an expiration cannot be set for PROBE configurations.

If a configuration already exists for the same service, environment, signal type, and location, this operation returns a conflict instead of overwriting it. Use attribute filters and capture settings to control where the instrumentation runs and which data is collected.

post/create-instrumentation-configuration

Request body

InstrumentationType'BREAKPOINT' | 'PROBE' required

Type of instrumentation configuration

Servicestring required

The name of the service to instrument. This should match the <code>service.name</code> resource attribute reported by the application.

Environmentstring required

The environment that the service is running in, such as <code>eks:cluster-prod/namespace</code> or <code>ec2:production</code>.

SignalType'SNAPSHOT' required
<p>The telemetry signal type for instrumentation.</p> <ul> <li> <p> <code>SNAPSHOT</code> - Captures a snapshot of the instrumentation point.</p> </li> </ul>
Descriptionstring

An optional short description (up to 50 characters) that explains the purpose of this instrumentation.

ExpiresAtstring date-time

For BREAKPOINT: optional, defaults to 24 hours, must be between 5 min and 24 hours. For PROBE: not supported. PROBE configurations are permanent and persist until explicitly deleted.

AttributeFiltersDynamicInstrumentationAttributeFilterGroup[]

An array of attribute filter groups used to target specific instances. Each filter group must match all of its keys (AND), and multiple groups are OR-matched to decide whether an instance applies the instrumentation. Filters are evaluated client-side by the SDK.

Response

Success

InstrumentationType'BREAKPOINT' | 'PROBE' required

The type of instrumentation that was created, echoed from the request.

Servicestring required

The service name for the instrumentation configuration, echoed from the request.

Environmentstring required

The environment for the instrumentation configuration, echoed from the request.

SignalType'SNAPSHOT' required

The telemetry signal type for the instrumentation configuration, echoed from the request.

LocationHashstring required

A stable hash computed from the location that uniquely identifies this instrumentation point within the service, environment, and signal type.

Descriptionstring

The optional description that was stored with the instrumentation configuration.

ExpiresAtstring date-time

The timestamp after which this configuration is no longer served to clients. Present only for <code>BREAKPOINT</code> configurations; <code>PROBE</code> configurations do not expire.

AttributeFiltersDynamicInstrumentationAttributeFilterGroup[]

The attribute filters returned with the configuration so SDKs can perform client-side targeting.

CreatedAtstring date-time required

The server-generated creation timestamp for this instrumentation configuration.

ARNstring required

ARN for the created instrumentation configuration