Amazon X-Ray · Schema

Edge

Information about a connection between two services. An edge can be a synchronous connection, such as typical call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an SNS queue.

Application PerformanceDebuggingDistributed TracingMonitoringObservability

Properties

Name Type Description
ReferenceId object
StartTime object
EndTime object
SummaryStatistics object
ResponseTimeHistogram object
Aliases object
EdgeType object
ReceivedEventAgeHistogram object
View JSON Schema on GitHub

JSON Schema

xray-edge-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "ReferenceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableInteger"
        },
        {
          "description": "Identifier of the edge. Unique within a service map."
        }
      ]
    },
    "StartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The start time of the first segment on the edge."
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The end time of the last segment on the edge."
        }
      ]
    },
    "SummaryStatistics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EdgeStatistics"
        },
        {
          "description": "Response statistics for segments on the edge."
        }
      ]
    },
    "ResponseTimeHistogram": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Histogram"
        },
        {
          "description": "A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges."
        }
      ]
    },
    "Aliases": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AliasList"
        },
        {
          "description": "Aliases for the edge."
        }
      ]
    },
    "EdgeType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Describes an asynchronous connection, with a value of <code>link</code>."
        }
      ]
    },
    "ReceivedEventAgeHistogram": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Histogram"
        },
        {
          "description": "A histogram that maps the spread of event age when received by consumers. Age is calculated each time an event is received. Only populated when <i>EdgeType</i> is <code>link</code>."
        }
      ]
    }
  },
  "description": "Information about a connection between two services. An edge can be a synchronous connection, such as typical call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an SNS queue.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Edge",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-edge-schema.json"
}