InstrumentationConfiguration
The full instrumentation configuration, including the instrumentation type, service, environment, signal type, location details, stable location hash, capture settings, filters, expiration, creation time, and ARN.
Contents
- ARN
-
The ARN for the instrumentation configuration.
Type: String
Pattern:
arn:[^:]+:application-signals:[^:]+:[0-9]{12}:instrumentationConfig/.+/[0-9a-f]{16}Required: Yes
- CaptureConfiguration
-
The capture settings for this instrumentation configuration.
Type: CaptureConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- CreatedAt
-
The timestamp when this instrumentation configuration was created.
Type: Timestamp
Required: Yes
- Environment
-
The environment where the service is running.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- InstrumentationType
-
The type of instrumentation for this configuration.
Type: String
Valid Values:
BREAKPOINT | PROBERequired: Yes
- Location
-
The location where this instrumentation is applied.
Type: Location object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- LocationHash
-
The stable hash derived from the location that uniquely identifies this instrumentation point within the service and environment.
Type: String
Length Constraints: Fixed length of 16.
Required: Yes
- Service
-
The service that this instrumentation configuration targets.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- SignalType
-
The telemetry signal type for this instrumentation configuration.
Type: String
Valid Values:
SNAPSHOTRequired: Yes
- AttributeFilters
-
Client-side filters that determine which instances apply this instrumentation.
Type: Array of string to string maps
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 50.
Value Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- Description
-
An optional short description of the instrumentation configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
- ExpiresAt
-
The timestamp when this configuration expires.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: