Amazon X-Ray · JSON Structure

Xray Error Root Cause Structure

The root cause of a trace summary error.

Type: object Properties: 2
Application PerformanceDebuggingDistributed TracingMonitoringObservability

ErrorRootCause is a JSON Structure definition published by Amazon X-Ray, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Services ClientImpacting

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "Services": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ErrorRootCauseServices"
        },
        {
          "description": "A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag."
        }
      ]
    },
    "ClientImpacting": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "A flag that denotes that the root cause impacts the trace client."
        }
      ]
    }
  },
  "description": "The root cause of a trace summary error.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "ErrorRootCause",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-structure/xray-error-root-cause-structure.json"
}