LightStep Documentation

Welcome to the LightStep developer hub. You'll find comprehensive guides and documentation to help you start working with LightStep as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Use Zipkin with LightStep

If you're currently using Zipkin for tracing, you can configure it to send that data directly to LightStep Satellites with little change. This is a great way to reuse your existing instrumentation architecture either directly in production or to quickly try out LightStep for the first time.

Use the correct version and format of Zipkin

The LightStep integration only supports Zipkin V2 JSON /api/v2/spans format over HTTP.

Configure Zipkin to Work with LightStep

To use Zipkin with LightStep, you need to make the following changes to your Zipkin tracers:

  • Configure the Zipkin HTTP Reporter's URL to http://<satellite-host>:<satellite-port>/api/v2/spans to send data to LightStep Satellites. See openzipkin/zipkin-go for an example of how to do this.

  • Ensure that the tracer is configured to AlwaysSample. See openzipkin/zipkin-go for an example.

  • By default, Zipkin uses shared spans between the client and server. You need to disable this feature when initializing the tracer in your services. See openzipkin/zipkin-go and openzipkin/brave for examples.

  • If you're using Brave, add a FinishedSpanHandler to the Tracing configuration.

  • LightStep Satellites need your project's access token to accept the data. The recommended way to do this is to pass the token with the trace by setting the tag lightstep.access_token=<access_token> as part of the configuration when initializing the tracer. See openzipkin/zipkin-go for an example of how to do this is Go.

Only have one project?

Then you could launch the satellite in a single project mode and not send a project access token. However, if you add a project, the Zipkin integration will not work.

Use Zipkin Tracers with LightStep Tracers

If you're using a mix of Zipkin and LightStep you must use B3 header propagation.

LightStep only supports B3 header propagation for its Java and C# tracers.

Use Zipkin with LightStep

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.