Amazon X-Ray · JSON Structure

Xray Error Root Cause Entity Structure

A collection of segments and corresponding subsegments associated to a trace summary error.

Type: object Properties: 3
Application PerformanceDebuggingDistributed TracingMonitoringObservability

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

Properties

Name Exceptions Remote

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the entity."
        }
      ]
    },
    "Exceptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RootCauseExceptions"
        },
        {
          "description": "The types and messages of the exceptions."
        }
      ]
    },
    "Remote": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "A flag that denotes a remote subsegment."
        }
      ]
    }
  },
  "description": "A collection of segments and corresponding subsegments associated to a trace summary error.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "ErrorRootCauseEntity",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-structure/xray-error-root-cause-entity-structure.json"
}