LightStep

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    

Welcome to LightStep Docs

Learn all you need to know about using LightStep! These topics cover everything from getting started and instrumenting your system, to finding root causes and resolution hypotheses quickly, monitoring for behavior anomalies, and installing and load balancing on-premise Satellites to keep LightStep running smoothly.

Get Started

Read these topics to quickly see the value that LightStep and distributed tracing bring to monitoring your complex, heterogeneous system and keeping it healthy.

* [Quick Start: Resolve an Incident Quickly](doc:tutorial-resolve-an-incident-quickly): Get a walkthrough of LightStep by going step-by-step through a real-world use case of finding sudden latency in the system. The root cause can sometimes be a surprise!
  • Quick Start: Instrument Your Code: See how you can instrument automatically without needing to touch your code, or how only a few lines of code can get you started with more granular instrumentation of your services.
  • Typical Workflows Using LightStep: Find out how LightStep can help you in your daily workflows, like viewing downstream service performance or monitoring a full transaction across the stack.
  • Learn About Satellites: Learn how LightStep uses Satellites to collect and analyze 100% of the data your instrumentation produces.

Get Data into LightStep

Read these topics to understand how to instrument your system to report to LightStep.

Find and Analyze Root Causes

Read these topics to learn how to use LightStep to quickly diagnose issues.

  • Query Span Data: Use the Explorer view to see latency histograms, analyze span data, and validate hypotheses.
  • Find Correlated Areas of Latency: Because LightStep analyses 100% of your span data, it can correlate the different services, operations, or even attributes provided by tags, that may be the cause of latency upstream and downstream of where you are seeing issues.
  • View Traces: See complete traces through your system. LightStep shows you the critical path where the system slows down. Metadata provided by tags, logs, and custom links help you surface probably causes and continue your workflow towards resolution.
  • Share Your Findings: LightStep durably stores all your queries and the data that support them for as long as your data retention settings allow. You can share links that allow your teammates to view and work with the data exactly as you did.

Monitor for SLAs and SLOs

Read these topics to understand how to monitor your system and alert for anomalies and outliers or for regressions post-deploy.

  • Monitor Specific Data with Streams: Streams allow you to monitor any facet of your application no matter how fine-grained the criteria, whether it's a specific service, operation, release version, or even an individual customer.
  • Create Dashboards from Streams: Put related Streams on a dashboard to see holistic health of any part of your system - a vital transaction, services involved in a deploy, or a VIP customer.
  • Create Alerts for Monitored Data: Send alerts using Slack, PagerDuty, OpsGenie, or other third-party applications when thresholds are crossed.

Set Up and Manage Satellites

Read these topics to understand the Satellite architecture, and how to install and configure on-premise Satellites to meet your requirements.

Monitor and Tune LightStep

Read these topics to understand how to keep LightStep Satellites and Tracers performant as your tracing grows throughout your system.

  • Monitor LightStep Performance: LightStep offers a number of tools to monitor your tracers and Satellites and tips for improving health when improvements are needed.
  • Load Balance LightStep: Best practices for load balancers and tips for tuning your tracers and Satellites.

Use the LightStep API

Read these topics to learn how to use the LightStep public API to programmatically integrate third-party systems.

Administer LightStep

Read these topics to create users and projects and configure LightStep.

Welcome to LightStep Docs


Suggested Edits are limited on API Reference Pages

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