Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src
README.md
pom.xml

README.md

autoconfigure-storage-xray

Overview

This is a Spring Boot AutoConfiguration module that can be added to a Zipkin Server deployment to send Spans to Amazon XRay.

This currently only supports sending to an XRay UDP daemon, not reading back spans from the service. Internally this module wraps the XRayUDPStorage and exposes configuration options through environment variables.

Experimental

Quick start

JRE 8 is required to run Zipkin server.

Fetch the latest released executable jar for Zipkin server and autoconfigure module jar for the xray storage. Run Zipkin server with the XRAY storage enabled.

For example:

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

After executing these steps, applications can send spans http://localhost:9411/api/v2/spans (or the legacy endpoint http://localhost:9411/api/v1/spans)

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.

Environment Variables
  • AWS_XRAY_DAEMON_ADDRESS The UDP endpoint to send spans to. Defaults to localhost:2000

Testing

Once your storage is enabled, verify it is running:

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