Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ReportInstrumentationConfigurationStatus

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


POST /report-instrumentation-configuration-status HTTP/1.1
Content-type: application/json

{
   "Configurations": [ 
      { 
         "ErrorCause": "string",
         "InstrumentationType": "string",
         "LocationHash": "string",
         "SignalType": "string",
         "Status": "string",
         "Time": number
      }
   ],
   "Environment": "string",
   "Service": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Configurations

An array of configuration status reports (up to 100) that include the instrumentation type, signal type, location hash, status, timestamp, and optional error cause.

Type: Array of InstrumentationConfigurationStatusReport objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Environment

The environment that the service is running in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Service

The service that the reported configurations belong to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Environment": "string",
   "Service": "string",
   "UnprocessedStatusEvents": [ 
      { 
         "FailedReason": "string",
         "InstrumentationType": "string",
         "LocationHash": "string",
         "SignalType": "string",
         "Status": "string",
         "Time": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Environment

The environment echoed from the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Service

The service name echoed from the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

UnprocessedStatusEvents

Status events that failed to be processed. Each entry includes the configuration identifiers, status, timestamp, and a reason for the failure.

Type: Array of UnprocessedStatusEvent objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 429

ValidationException

The resource is not valid.

HTTP Status Code: 400