instrumentation_configuration_status

Creates, updates, deletes, gets or lists an instrumentation_configuration_status resource.

Overview

Name	instrumentation_configuration_status
Type	Resource
Id	aws.application_signals.instrumentation_configuration_status

Fields

The following fields are returned by SELECT queries:

get_instrumentation_configuration_status

Name	Datatype	Description
error_cause	string	The error cause when the status is ERROR. (FILE_NOT_FOUND, METHOD_NOT_FOUND, LINE_NOT_EXECUTABLE, OVERLOADED_METHODS, LANGUAGE_MISMATCH, RUNTIME_ERROR)
time	string (date-time)	The time when the status was reported, rounded to the nearest minute.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_instrumentation_configuration_status	select	region		Retrieves the status history for a single instrumentation configuration during a specified time range. The response lists when the configuration was ACTIVE, READY, ERROR, or DISABLED. If no status or time window is provided, the operation defaults to ACTIVE events from the last hour.
report_instrumentation_configuration_status	exec	region, Configurations		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_instrumentation_configuration_status

Retrieves the status history for a single instrumentation configuration during a specified time range. The response lists when the configuration was ACTIVE, READY, ERROR, or DISABLED. If no status or time window is provided, the operation defaults to ACTIVE events from the last hour.

SELECT
error_cause,
time
FROM aws.application_signals.instrumentation_configuration_status
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

report_instrumentation_configuration_status

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.

EXEC aws.application_signals.instrumentation_configuration_status.report_instrumentation_configuration_status 
@region='{{ region }}' --required 
@@json=
'{
"Service": "{{ Service }}", 
"Environment": "{{ Environment }}", 
"Configurations": "{{ Configurations }}"
}'
;