CloudWatchApplicationSignals / Client / report_instrumentation_configuration_status

report_instrumentation_configuration_status¶

CloudWatchApplicationSignals.Client.report_instrumentation_configuration_status(**kwargs)¶

Reports the status of one or more instrumentation configurations from SDK instances. Use this to record when configurations become ready, hit errors, become active, or are disabled by limits.

Report READY, ERROR, and DISABLED when the status changes. Report ACTIVE periodically (for example, every minute) while instrumentation is running.

Request Syntax

response = client.report_instrumentation_configuration_status(
    Service='string',
    Environment='string',
    Configurations=[
        {
            'InstrumentationType': 'BREAKPOINT'|'PROBE',
            'SignalType': 'SNAPSHOT',
            'LocationHash': 'string',
            'Status': 'READY'|'ERROR'|'ACTIVE'|'DISABLED',
            'Time': datetime(2015, 1, 1),
            'ErrorCause': 'FILE_NOT_FOUND'|'METHOD_NOT_FOUND'|'LINE_NOT_EXECUTABLE'|'OVERLOADED_METHODS'|'LANGUAGE_MISMATCH'|'RUNTIME_ERROR'
        },
    ]
)

Parameters:

Service (string) –
[REQUIRED]

The service that the reported configurations belong to.
Environment (string) –
[REQUIRED]

The environment that the service is running in.
Configurations (list) –
[REQUIRED]

An array of configuration status reports (up to 100) that include the instrumentation type, signal type, location hash, status, timestamp, and optional error cause.
- (dict) –
  
  The status of a single instrumentation configuration reported by an SDK instance.
  - InstrumentationType (string) – [REQUIRED]
    
    The type of instrumentation configuration being reported.
  - SignalType (string) – [REQUIRED]
    
    The telemetry signal type for this instrumentation configuration.
  - LocationHash (string) – [REQUIRED]
    
    The stable hash of the instrumentation location that identifies the configuration being reported.
  - Status (string) – [REQUIRED]
    
    The status of the instrumentation configuration: READY, ERROR, ACTIVE, or DISABLED.
  - Time (datetime) – [REQUIRED]
    
    The timestamp when the status event occurred.
  - ErrorCause (string) –
    
    The error cause when the status is ERROR, such as the file or method not being found.

Return type:

dict

Returns:

Response Syntax

{
    'Service': 'string',
    'Environment': 'string',
    'UnprocessedStatusEvents': [
        {
            'InstrumentationType': 'BREAKPOINT'|'PROBE',
            'SignalType': 'SNAPSHOT',
            'LocationHash': 'string',
            'Status': 'READY'|'ERROR'|'ACTIVE'|'DISABLED',
            'Time': datetime(2015, 1, 1),
            'FailedReason': 'THROTTLED'|'INTERNAL_ERROR'|'VALIDATION_ERROR'
        },
    ]
}

Response Structure

(dict) –
- Service (string) –
  
  The service name echoed from the request.
- Environment (string) –
  
  The environment echoed from the request.
- UnprocessedStatusEvents (list) –
  
  Status events that failed to be processed. Each entry includes the configuration identifiers, status, timestamp, and a reason for the failure.
  - (dict) –
    
    A status event that could not be processed by the service.
    - InstrumentationType (string) –
      
      The type of instrumentation configuration for the unprocessed status event.
    - SignalType (string) –
      
      The telemetry signal type for the unprocessed status event.
    - LocationHash (string) –
      
      The stable hash of the instrumentation location for the unprocessed event.
    - Status (string) –
      
      The status that failed to be processed.
    - Time (datetime) –
      
      The timestamp of the status event that failed to be processed.
    - FailedReason (string) –
      
      The reason why this status event could not be processed, such as throttling or validation errors.

Exceptions

CloudWatchApplicationSignals.Client.exceptions.ValidationException
CloudWatchApplicationSignals.Client.exceptions.ThrottlingException