Amazon X-Ray · Schema

SamplingStatisticSummary

Aggregated request sampling data for a sampling rule across all services for a 10-second window.

Application PerformanceDebuggingDistributed TracingMonitoringObservability

Properties

Name Type Description
RuleName object
Timestamp object
RequestCount object
BorrowCount object
SampledCount object
View JSON Schema on GitHub

JSON Schema

xray-sampling-statistic-summary-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "RuleName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the sampling rule."
        }
      ]
    },
    "Timestamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The start time of the reporting window."
        }
      ]
    },
    "RequestCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The number of requests that matched the rule."
        }
      ]
    },
    "BorrowCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The number of requests recorded with borrowed reservoir quota."
        }
      ]
    },
    "SampledCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The number of requests recorded."
        }
      ]
    }
  },
  "description": "Aggregated request sampling data for a sampling rule across all services for a 10-second window.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SamplingStatisticSummary",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-sampling-statistic-summary-schema.json"
}