Amazon X-Ray · JSON Structure

Xray Edge Structure

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.

Type: object Properties: 8
Application PerformanceDebuggingDistributed TracingMonitoringObservability

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

Properties

ReferenceId StartTime EndTime SummaryStatistics ResponseTimeHistogram Aliases EdgeType ReceivedEventAgeHistogram

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

JSON Structure

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-structure.org/meta/core/v0/#",
  "name": "Edge",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-structure/xray-edge-structure.json"
}