Zipkin website screenshot

Zipkin

Zipkin is an open source distributed tracing system for gathering timing data to troubleshoot latency problems in microservice architectures. It was originally developed at Twitter based on the Google Dapper paper, and is now a CNCF-related project maintained by the OpenZipkin community. Zipkin provides a collector, storage, and query service with a UI for visualizing trace data across distributed services.

1 APIs 6 Features
Distributed TracingObservabilityOpen SourceMicroservices

APIs

Zipkin API V2

Zipkin's v2 HTTP API for querying and collecting distributed traces. Provides endpoints for submitting spans, querying traces, looking up services and span names, and retrieving...

Collections

Zipkin API v2

OPEN

Pricing Plans

Zipkin Plans Pricing

3 plans

PLANS

Rate Limits

Zipkin Rate Limits

5 limits

RATE LIMITS

FinOps

Zipkin Finops

FINOPS

Features

Distributed Tracing

End-to-end tracing of requests across microservices.

Span Collection

Ingestion of spans via HTTP, Kafka, and other transports.

Trace Search

Query traces by service, span name, tags, and time range.

Dependency Graph

Derived service-to-service dependency links from spans.

UI

Web-based UI for exploring traces and dependency graphs.

Pluggable Storage

Pluggable backends including in-memory, MySQL, Cassandra, and Elasticsearch.

Use Cases

Microservices Latency Debugging

Identify slow services and operations in a microservice architecture.

Error Investigation

Trace failed requests across services to find error origin.

Service Dependency Mapping

Visualize which services call which, with call counts.

Performance Optimization

Identify hotspots and optimize critical-path operations.

Integrations

Brave

Java instrumentation library for OpenZipkin.

OpenTelemetry

OpenTelemetry can export traces to Zipkin.

Spring Cloud Sleuth

Spring framework integration emitting Zipkin traces.

Kafka

Span transport via Kafka for asynchronous ingestion.

Elasticsearch

Storage backend for spans and traces at scale.

Semantic Vocabularies

Zipkin Context

4 classes · 20 properties

JSON-LD

API Governance Rules

Zipkin API Rules

6 rules · 2 errors 4 warnings

SPECTRAL

JSON Structure

Zipkin Api V2 Annotation Structure

2 properties

JSON STRUCTURE

Zipkin Api V2 Dependency Link Structure

4 properties

JSON STRUCTURE

Zipkin Api V2 Endpoint Structure

4 properties

JSON STRUCTURE

Zipkin Api V2 Span Structure

13 properties

JSON STRUCTURE

Example Payloads

Zipkin Api V2 Get Dependencies Example

4 fields

EXAMPLE

Zipkin Api V2 Get Services Example

4 fields

EXAMPLE

Zipkin Api V2 Report Spans Example

4 fields

EXAMPLE

Zipkin Api V2 Search Traces Example

4 fields

EXAMPLE

Resources

🔗
Website
Website
🔗
Documentation
Documentation
👥
GitHubOrganization
GitHubOrganization
📦
SDKs
SDKs
📦
SDKs
SDKs
📦
SDKs
SDKs
📦
SDKs
SDKs
🔗
JSONLD
JSONLD
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Zipkin API v2
  version: 2.0.0
items:
- info:
    name: Services
    type: folder
  items:
  - info:
      name: Zipkin Get Service Names
      type: http
    http:
      method: GET
      url: http://localhost:9411/api/v2/services
    docs: Returns a list of all service names associated with span endpoints.
- info:
    name: Spans
    type: folder
  items:
  - info:
      name: Zipkin Get Span Names
      type: http
    http:
      method: GET
      url: http://localhost:9411/api/v2/spans
      params:
      - name: serviceName
        value: ''
        type: query
        description: The service name to lookup span names for
    docs: Returns a list of span names for a given service.
  - info:
      name: Zipkin Report Spans
      type: http
    http:
      method: POST
      url: http://localhost:9411/api/v2/spans
      body:
        type: json
        data: '{}'
    docs: Uploads a list of spans encoded per content type. Accepted content types are application/json and application/x-protobuf.
- info:
    name: Traces
    type: folder
  items:
  - info:
      name: Zipkin Search for Traces
      type: http
    http:
      method: GET
      url: http://localhost:9411/api/v2/traces
      params:
      - name: serviceName
        value: ''
        type: query
        description: Service name to query for
      - name: spanName
        value: ''
        type: query
        description: Span name to query for
      - name: annotationQuery
        value: ''
        type: query
        description: Annotation query string, e.g. "http.method=GET" or "error"
      - name: minDuration
        value: ''
        type: query
        description: Minimum duration in microseconds
      - name: maxDuration
        value: ''
        type: query
        description: Maximum duration in microseconds
      - name: endTs
        value: ''
        type: query
        description: Upper bound on the timestamp of the first span in a trace, in epoch milliseconds. Defaults to current
          time.
      - name: lookback
        value: ''
        type: query
        description: How far back to look from endTs, in milliseconds. Defaults to endTs, limited to a system-configured max.
      - name: limit
        value: ''
        type: query
        description: Maximum number of traces to return. Defaults to 10.
    docs: Searches for traces matching the given query parameters. Results are sorted by descending end timestamp.
  - info:
      name: Zipkin Get a Trace by ID
      type: http
    http:
      method: GET
      url: http://localhost:9411/api/v2/trace/:traceId
      params:
      - name: traceId
        value: ''
        type: path
        description: Trace ID, 16 or 32 character hex string
    docs: Returns a trace by its 16 or 32 character hex trace ID.
- info:
    name: Dependencies
    type: folder
  items:
  - info:
      name: Zipkin Get Dependency Links
      type: http
    http:
      method: GET
      url: http://localhost:9411/api/v2/dependencies
      params:
      - name: endTs
        value: ''
        type: query
        description: Upper bound timestamp for dependency links, in epoch milliseconds.
      - name: lookback
        value: ''
        type: query
        description: How far back from endTs to look, in milliseconds.
    docs: Returns dependency links derived from spans. Dependencies show which services call which other services, along with
      call counts and error counts.
- info:
    name: Autocomplete
    type: folder
  items:
  - info:
      name: Zipkin Get Autocomplete Keys
      type: http
    http:
      method: GET
      url: http://localhost:9411/api/v2/autocompleteKeys
    docs: Returns a list of tag keys configured for autocomplete.
  - info:
      name: Zipkin Get Autocomplete Values
      type: http
    http:
      method: GET
      url: http://localhost:9411/api/v2/autocompleteValues
      params:
      - name: key
        value: ''
        type: query
        description: The tag key to lookup values for
    docs: Returns a list of values for a given autocomplete tag key.
- info:
    name: Health
    type: folder
  items:
  - info:
      name: Zipkin Health Check
      type: http
    http:
      method: GET
      url: http://localhost:9411/health
    docs: Returns OK if the server is healthy.
bundled: true