Zipkin Go

Zipkin distributed tracing library for go.
Alternatives To Zipkin Go
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Jaeger18,71215208a day ago304November 02, 2023351apache-2.0Go
CNCF Jaeger, a Distributed Tracing Platform
Zipkin16,5334767a day ago122November 16, 2023220apache-2.0Java
Zipkin is a distributed tracing system
Tempo3,377720 hours ago99August 17, 2022163agpl-3.0Go
Grafana Tempo is a high volume, minimal dependency distributed tracing backend.
Brave2,289731423 months ago142May 11, 2023124apache-2.0Java
Java distributed tracing implementation compatible with Zipkin backend services.
Spring Cloud Sleuth1,7351,242563 days ago72June 29, 202340apache-2.0Java
Distributed tracing for spring cloud
Opentelemetry Rust1,4251211a day ago29November 06, 2023141apache-2.0Rust
OpenTelemetry API and SDK for Rust
Molten694
4 years ago49apache-2.0C
php probe for zipkin and opentracing
Opencensus Java673713217 months ago47April 29, 2022113apache-2.0Java
A stats collection and distributed tracing framework
Opentelemetry Php612
10 days ago9March 30, 202225apache-2.0PHP
The OpenTelemetry PHP Library
Zipkin Go5821,4921,5734 months ago31August 10, 202313apache-2.0Go
Zipkin distributed tracing library for go.
Alternatives To Zipkin Go
Select To Compare


Alternative Project Comparisons
Readme

Zipkin Library for Go

GHA codecov Go Report Card GoDoc Gitter chat Sourcegraph

Zipkin Go is the official Go Tracer / Tracing implementation for Zipkin, supported by the OpenZipkin community.

package organization

zipkin-go is built with interoperability in mind within the OpenZipkin community and even 3rd parties, the library consists of several packages.

The main tracing implementation can be found in the root folder of this repository. Reusable parts not considered core implementation or deemed beneficiary for usage by others are placed in their own packages within this repository.

model

This library implements the Zipkin V2 Span Model which is available in the model package. It contains a Go data model compatible with the Zipkin V2 API and can automatically sanitize, parse and (de)serialize to and from the required JSON representation as used by the official Zipkin V2 Collectors.

propagation

The propagation package and B3 subpackage hold the logic for propagating SpanContext (span identifiers and sampling flags) between services participating in traces. Currently Zipkin B3 Propagation is supported for HTTP and GRPC.

middleware

The middleware subpackages contain officially supported middleware handlers and tracing wrappers.

http

An easy to use http.Handler middleware for tracing server side requests is provided. This allows one to use this middleware in applications using standard library servers as well as most available higher level frameworks. Some frameworks will have their own instrumentation and middleware that maps better for their ecosystem.

For HTTP client operations NewTransport can return a http.RoundTripper implementation that can either wrap the standard http.Client's Transport or a custom provided one and add per request tracing. Since HTTP Requests can have one or multiple redirects it is advisable to always enclose HTTP Client calls with a Span either around the *http.Client call level or parent function level.

For convenience NewClient is provided which returns a HTTP Client which embeds *http.Client and provides an application span around the HTTP calls when calling the DoWithAppSpan() method.

grpc

Easy to use grpc.StatsHandler middleware are provided for tracing gRPC server and client requests.

For a server, pass NewServerHandler when calling NewServer, e.g.,

import (
	"google.golang.org/grpc"
	zipkingrpc "github.com/openzipkin/zipkin-go/middleware/grpc"
)

server = grpc.NewServer(grpc.StatsHandler(zipkingrpc.NewServerHandler(tracer)))

For a client, pass NewClientHandler when calling Dial, e.g.,

import (
	"google.golang.org/grpc"
	zipkingrpc "github.com/openzipkin/zipkin-go/middleware/grpc"
)

conn, err = grpc.Dial(addr, grpc.WithStatsHandler(zipkingrpc.NewClientHandler(tracer)))

reporter

The reporter package holds the interface which the various Reporter implementations use. It is exported into its own package as it can be used by 3rd parties to use these Reporter packages in their own libraries for exporting to the Zipkin ecosystem. The zipkin-go tracer also uses the interface to accept 3rd party Reporter implementations.

HTTP Reporter

Most common Reporter type used by Zipkin users transporting Spans to the Zipkin server using JSON over HTTP. The reporter holds a buffer and reports to the backend asynchronously.

Kafka Reporter

High performance Reporter transporting Spans to the Zipkin server using a Kafka Producer digesting JSON V2 Spans. The reporter uses the Sarama async producer underneath.

usage and examples

HTTP Server Example

Popular Tracing Projects
Popular Zipkin Projects
Popular Operations Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
Go
Http
Grpc
Tracing
Instrumentation
Zipkin
Distributed Tracing
Openzipkin