LightStep

LightStep [𝑥]PM 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    

Trace View

The trace view is designed to make navigating, investigating, and sharing data about a particular trace easy and intuitive. Once a trace is viewed, it is persisted forever so that it can be bookmarked, shared, and reviewed in the future.

Trace Mini-Map

The trace mini-map shows a condensed view of the overview trace, allowing you to quickly navigate to different parts of large, complex traces. The different services within the system are displayed in different colors to give a sense of the overall service interactions.

The trace mini-map can toggle between two modes: an “icicle graph” intended to give a sense of the overall shape of the trace and a single-line condensed view designed to take up minimal screen space.

The expanded mini-map

The expanded mini-map

The collapsed mini-map

The collapsed mini-map

Main Trace View

The main view of the trace contains a wealth of information about the individual spans within the trace:

Critical Path Information

LightStep automatically runs a heuristic to determine the critical path of a given trace. The critical path is highlighted in yellow to help identify bottlenecks in the overall transactions.

The trace critical path

The trace critical path

Errors

Spans containing errors are highlighted in red in both the main view and the mini-map.

Spans with errors

Spans with errors

Missing Spans

When spans have a parent id that wasn't found to be a span id in any of the Satellites, they are highlighted with a dashed red box. This can be a Satellite related span drop (for example, your Satellite pool is not auto-scaling to keep up with traffic) or client-side span drop (for example, your application crashed or never called span.flush() )

Span with missing span errors.

Span with missing span errors.

Side Panel

The side panel contains information about the currently selected span in the trace. This includes information about the span itself, its tags, and the logs. This information is a direct reflection of the OpenTracing span information.

Log Payloads

Log payloads are displayed inline with the log information. Payloads are a powerful feature for capturing detailed information for transactions of interest.

Linking to a specific span

Whenever a span is selected in the trace, the URL is automatically updated. That URL is permanent and can be bookmarked and shared.