Skip to content

CreateInstrumentationConfigurationRequest

Source code in docs_src/capo_application_signals/types/create_instrumentation_configuration_request.py
class CreateInstrumentationConfigurationRequest(TypedDict, closed=True):
    instrumentation_type: (
        "capo_application_signals.types.instrumentation_type.InstrumentationType"
    )
    """Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)"""
    service: "str"
    """<p>The name of the service to instrument. This should match the <code>service.name</code> resource attribute reported by the application.</p>"""
    environment: "str"
    """<p>The environment that the service is running in, such as <code>eks:cluster-prod/namespace</code> or <code>ec2:production</code>.</p>"""
    signal_type: "capo_application_signals.types.dynamic_instrumentation_signal_type.DynamicInstrumentationSignalType"
    """<p>The telemetry signal type to emit for this instrumentation. The supported value is <code>SNAPSHOT</code>.</p>"""
    location: "capo_application_signals.types.location.Location"
    """<p>The location where instrumentation should be applied. Specify a <code>CodeLocation</code> for code-level instrumentation.</p>"""
    description: NotRequired["str"]
    """<p>An optional short description (up to 50 characters) that explains the purpose of this instrumentation.</p>"""
    expires_at: NotRequired["datetime.datetime"]
    """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."""
    attribute_filters: NotRequired[
        "capo_application_signals.types.dynamic_instrumentation_attribute_filters.DynamicInstrumentationAttributeFilters"
    ]
    """<p>Client-side filters that target specific instances. Each object in the array is AND-matched on its keys, and multiple objects are OR-matched to decide where to apply the instrumentation.</p>"""
    capture_configuration: (
        "capo_application_signals.types.capture_configuration.CaptureConfiguration"
    )
    """<p>Specifies what to capture when the instrumentation point is hit. Specify <code>CodeCapture</code> for code-level capture settings.</p>"""
    tags: NotRequired["capo_application_signals.types.tag_list.TagList"]
    """<p>An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.</p>"""

attribute_filters instance-attribute

attribute_filters: NotRequired[DynamicInstrumentationAttributeFilters]

Client-side filters that target specific instances. Each object in the array is AND-matched on its keys, and multiple objects are OR-matched to decide where to apply the instrumentation.

capture_configuration instance-attribute

capture_configuration: CaptureConfiguration

Specifies what to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.

description instance-attribute

description: NotRequired[str]

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

environment instance-attribute

environment: str

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

expires_at instance-attribute

expires_at: NotRequired[datetime]

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.

instrumentation_type instance-attribute

instrumentation_type: InstrumentationType

Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)

location instance-attribute

location: Location

The location where instrumentation should be applied. Specify a CodeLocation for code-level instrumentation.

service instance-attribute

service: str

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

signal_type instance-attribute

The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.

tags instance-attribute

tags: NotRequired[TagList]

An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.