LightStep Documentation

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

Get Started    

Quickstart with LightStep [𝑥]PM

This guide assumes you have read the article on OpenTracing Instrumentation, reviewed the materials on the OpenTracing website, configured basic OpenTracing instrumentation, and are ready to start using LightStep.

LightStep has client libraries in most major languages. These libraries allow you to instrument your codebase to send tracing data to LightStep. All client libraries are open-source and hosted on GitHub.

To get started, see the examples in the GitHub repository for the language of your choice. The examples provide a quick demonstration of how to send tracing data to LightStep and then view the visualized trace along with its latency, logs, and tag information.

Step 1: Find your LightStep [𝑥]PM project's access token

  1. Visit the "Project Settings" page. This is accessible via the top navigation bar.
  2. Locate your project's access token. This token will be need to set up the initial examples.

Step 2: Visit the GitHub repository for the language of choice

Select a link below to go to the GitHub repository for the language you want to use. Once there, take a look at the "Getting Started" section of the README, and run the basic example. That'll get you started.

If you're run the example, you should have seen your first trace on LightStep! Congratulations!

A very simple, single span trace

A very simple, single span trace

If not you weren't able to get a successful trace, please let us know and we'll help you out. Email or create an issue with the feedback link below!

Now that you've created your first, simple trace, you can move on to instrumenting the first component of your production system and getting the value LightStep provides at scale.

Quickstart with LightStep [𝑥]PM

Suggested Edits are limited on API Reference Pages

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