Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 2.5 KB

README.md

File metadata and controls

73 lines (54 loc) · 2.5 KB
Raw

zipkin-module-otel

Overview

This is a module that can be added to a Zipkin Server deployment to receive Spans to OpenTelemetry's OLTP/HTTP protocols.

Experimental

  • Note: This is currently experimental! *
  • Note: This requires reporters send 128-bit trace IDs *
  • Check openzipkin/b3-propagation#6 for tracers that support 128-bit trace IDs

Quick start

JRE 11+ is required to run Zipkin server.

Fetch the latest released executable jar for Zipkin server and module jar for otel. Run Zipkin server with the StackDriver Storage enabled.

For example:

$ curl -sSL https://zipkin.io/quickstart.sh | bash -s
$ curl -sSL https://zipkin.io/quickstart.sh | bash -s io.zipkin.contrib.otel:zipkin-module-otel:LATEST:module otel.jar
$ java \
    -Dloader.path='otel.jar,otel.jar!/lib' \
    -Dspring.profiles.active=otel \
    -cp zipkin.jar \
    org.springframework.boot.loader.PropertiesLauncher

TODO: add example of sending span in otel protocols

The Zipkin server can be further configured as described in the Zipkin server documentation.

Configuration

Configuration can be applied either through environment variables or an external Zipkin configuration file. The module includes default configuration that can be used as a reference for users that prefer a file based approach.

Property Environment Variable Description
zipkin.collector.otel.http.enabled COLLECTOR_HTTP_OTEL_ENABLED false disables the HTTP collector. Defaults to true.

Running

$ java \
    -Dloader.path='otel.jar,otel.jar!/lib' \
    -Dspring.profiles.active=otel \
    -cp zipkin.jar \
    org.springframework.boot.loader.PropertiesLauncher

Testing

Once your collector is enabled, verify it is running:

$ curl -s localhost:9411/health|jq .zipkin.details.OpenTelemetryCollector
{
  "status": "UP"
}