tracing

Generated reference page for spec/v1/schemas/common/tracing.json.

Metadata

• Type: JSON Schema
• Source: spec/v1/schemas/common/tracing.json
• Raw: View Raw

Summary

• Schema ID: https://agent-service.spec/v1/schemas/common/tracing.json
• Defs: 10
• Properties: 0
• Required: 0

Source

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/common/tracing.json",
  "$defs": {
    "traceId": {
      "$ref": "./identity.json#/$defs/opaqueId"
    },
    "spanId": {
      "$ref": "./identity.json#/$defs/opaqueId"
    },
    "spanType": {
      "type": "string",
      "enum": ["unknown", "others", "compute", "io", "network", "interactive", "llm", "chain"]
    },
    "spanStatus": {
      "type": "string",
      "enum": ["running", "success", "failed", "cancelled", "timeout"]
    },
    "traceStatus": {
      "type": "string",
      "enum": ["running", "success", "failed", "cancelled", "timeout", "partial"]
    },
    "TraceContext": {
      "type": "object",
      "additionalProperties": false,
      "required": ["traceId", "spanId"],
      "properties": {
        "traceId": {
          "$ref": "#/$defs/traceId"
        },
        "spanId": {
          "$ref": "#/$defs/spanId"
        },
        "rootSpanId": {
          "$ref": "#/$defs/spanId"
        },
        "runId": {
          "$ref": "./identity.json#/$defs/runId"
        },
        "traceparent": {
          "type": "string",
          "minLength": 1
        },
        "tracestate": {
          "type": "string"
        },
        "baggage": {
          "type": "string"
        },
        "baggageItems": {
          "type": "array",
          "items": {
            "$ref": "./otel.json#/$defs/BaggageItem"
          }
        },
        "carrierFormat": {
          "type": "string",
          "enum": ["w3c_headers", "text_map", "environment"]
        },
        "isRemote": {
          "type": "boolean"
        }
      }
    },
    "TracerConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "globalTimeoutMs": {
          "type": "integer",
          "minimum": 0,
          "default": 600000
        },
        "metricsIntervalMs": {
          "type": "integer",
          "minimum": 100,
          "default": 1000
        },
        "exportEnabled": {
          "type": "boolean",
          "default": true
        },
        "logInjectionEnabled": {
          "type": "boolean",
          "default": true
        },
        "defaultContentCaptureMode": {
          "$ref": "./otel.json#/$defs/ContentCaptureMode"
        },
        "propagationFormats": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": ["w3c_headers", "text_map", "environment"]
          }
        },
        "semanticConventionProfiles": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "maxOpenSpans": {
          "type": "integer",
          "minimum": 1
        },
        "metadataDenyKeys": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "commonTags": {
          "type": "object",
          "additionalProperties": {
            "type": ["string", "number", "boolean"]
          }
        }
      }
    },
    "StartSpanOptions": {
      "type": "object",
      "additionalProperties": false,
      "required": ["spanName"],
      "properties": {
        "spanName": {
          "type": "string",
          "minLength": 1
        },
        "spanType": {
          "$ref": "#/$defs/spanType"
        },
        "spanKind": {
          "$ref": "./otel.json#/$defs/spanKind"
        },
        "timeoutMs": {
          "type": "integer",
          "minimum": 0
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        },
        "attributes": {
          "$ref": "./otel.json#/$defs/OTelAttributes"
        },
        "links": {
          "type": "array",
          "items": {
            "$ref": "./otel.json#/$defs/OTelLink"
          }
        },
        "parentSpanId": {
          "$ref": "#/$defs/spanId"
        },
        "parentSpanName": {
          "type": "string",
          "minLength": 1
        },
        "parentContext": {
          "$ref": "#/$defs/TraceContext"
        },
        "captureMode": {
          "$ref": "./otel.json#/$defs/ContentCaptureMode"
        }
      }
    },
    "SpanMetrics": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "cpuCount": {
          "type": "integer",
          "minimum": 0
        },
        "totalMemoryBytes": {
          "type": "integer",
          "minimum": 0
        },
        "systemUptimeMs": {
          "type": "integer",
          "minimum": 0
        },
        "processUptimeMs": {
          "type": "integer",
          "minimum": 0
        },
        "maxUsedMemoryBytes": {
          "type": "integer",
          "minimum": 0
        },
        "maxRssBytes": {
          "type": "integer",
          "minimum": 0
        },
        "maxHeapUsedBytes": {
          "type": "integer",
          "minimum": 0
        },
        "maxUserCpuTimeMs": {
          "type": "number",
          "minimum": 0
        },
        "maxSystemCpuTimeMs": {
          "type": "number",
          "minimum": 0
        },
        "fsReadBytes": {
          "type": "integer",
          "minimum": 0
        },
        "fsWriteBytes": {
          "type": "integer",
          "minimum": 0
        },
        "processMaxRssBytes": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "TraceStatusCounts": {
      "type": "object",
      "additionalProperties": false,
      "required": ["running", "success", "failed", "cancelled", "timeout"],
      "properties": {
        "running": {
          "type": "integer",
          "minimum": 0
        },
        "success": {
          "type": "integer",
          "minimum": 0
        },
        "failed": {
          "type": "integer",
          "minimum": 0
        },
        "cancelled": {
          "type": "integer",
          "minimum": 0
        },
        "timeout": {
          "type": "integer",
          "minimum": 0
        }
      }
    }
  }
}