Skip to content

Reporters and collectors for use in OpenTelemetry

License

Notifications You must be signed in to change notification settings

openzipkin-contrib/zipkin-otel

Repository files navigation

Gitter chat Build Status Maven Central

zipkin-otel

Shared libraries that provide Zipkin integration with the OpenTelemetry. Requires JRE 11 or later.

Usage

These components integrate traced applications and servers with OpenTelemetry protocols via interfaces defined by Zipkin.

Collectors

The component in a zipkin server that receives trace data is called a collector. A collector decodes spans reported by applications and persists them to a configured collector component.

Collector Description
collector-http Implements the OTLP/HTTP protocol

Encoders

The encoder encodes brave spans into OTLP proto format.

Encoder Description
OtlpProtoV1Encoder zipkin-reporter-brave AsyncZipkinSpanHandler

Server integration

If you cannot use our Docker image, you can still integrate yourself by downloading a couple jars.

Here's an example of integrating OpenTelemetry collectors.

Troubleshooting

Artifacts

All artifacts publish to the group ID "io.zipkin.contrib.otel". We use a common release version for all components.

Library Releases

Releases are at Sonatype and Maven Central

Library Snapshots

Snapshots are uploaded to Sonatype after commits to main.

Docker Images

Released versions of zipkin-otel are published to the GitHub Container Registry as ghcr.io/openzipkin-contrib/zipkin-otel.

See docker for details.