Zipkin · JSON Structure

Zipkin Api V2 Span Structure

A Zipkin span representing an individual unit of work in a distributed trace.

Type: object Properties: 13 Required: 2
Distributed TracingObservabilityOpen SourceMicroservices

Span is a JSON Structure definition published by Zipkin, describing 13 properties, of which 2 are required. It conforms to the https://json-structure.org/schema/v0 meta-schema.

Properties

traceId parentId id kind name timestamp duration localEndpoint remoteEndpoint annotations tags debug shared

Meta-schema: https://json-structure.org/schema/v0

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/schema/v0",
  "name": "Span",
  "type": "object",
  "description": "A Zipkin span representing an individual unit of work in a distributed trace.",
  "properties": {
    "traceId": {"type": "string", "description": "128-bit or 64-bit trace ID, hex encoded"},
    "parentId": {"type": "string", "description": "Parent span ID, hex encoded"},
    "id": {"type": "string", "description": "64-bit span ID, hex encoded"},
    "kind": {"type": "string", "enum": ["CLIENT", "SERVER", "PRODUCER", "CONSUMER"]},
    "name": {"type": "string", "description": "Logical operation name"},
    "timestamp": {"type": "integer", "description": "Start epoch microseconds"},
    "duration": {"type": "integer", "description": "Duration in microseconds"},
    "localEndpoint": {"$ref": "zipkin-api-v2-endpoint-structure.json"},
    "remoteEndpoint": {"$ref": "zipkin-api-v2-endpoint-structure.json"},
    "annotations": {"type": "array", "items": {"$ref": "zipkin-api-v2-annotation-structure.json"}},
    "tags": {"type": "map", "values": {"type": "string"}},
    "debug": {"type": "boolean"},
    "shared": {"type": "boolean"}
  },
  "required": ["traceId", "id"]
}