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    

Review Satellite Diagnostics

The Satellite diagnostics service provides health and diagnostic information about the Satellite.

The service runs by default on port 8000 at the /diagnostics endpoint, set during Satellite configuration.

To access the diagnostics page, go to {satellite-host}:8000/diagnostics. The page displays a list of status checks, connections, Satellite build information and configuration settings for the given Satellite.

On the Satellite Diagnostics page, the status of Satellite Health and Liveness checks will have a mark next to its name. A means that the check is okay and means there is an issue.

Health / Readiness Checks (for load balancers)

The Satellite Health / Readiness Check endpoint allows load balancers to determine whether a Satellite is healthy and available to handle incoming span traffic. This endpoint is available at: http(s)://{satellite host}:{admin port}/_ready

A 200 (OK) response indicates that the satellite is currently able to accept incoming span traffic. Any other response, including a timeout, indicates that either the Satellite is not currently running, or it has too many queued span reports and cannot handle any more at the moment. In this case, the load balancer should send the request to a different satellite.

Liveness Checks (for deployment orchestration)

The Liveness Check endpoint allows orchestration frameworks like Kubernetes to determine when a Satellite is not responding and needs to be restarted. This endpoint is available at: http(s)://{satellite host}:{admin port}/_live.

A 200 (OK) response indicates that the satellite is currently running. Any other response, including a timeout, indicates that the Satellite is not able to respond to HTTP requests at all, and the instance should be terminated.

The Liveness Check does not verify Satellite health!

This is a lower-confidence indication of Satellite health than the health/readiness checks listed above. It makes no promises about Satellite health (the Satellite could be temporarily overloaded and not accepting spans).

Configuration

The Satellite diagnostics page keeps track of whether the configuration has been parsed and shows what the current Satellite configuration is. This will not include the Satellite key, for security reasons.

Connection Status

Satellites need to communicate with the following LightStep endpoint to work:

  • api-grpc.lightstep.com

This endpoint may be marked as "not connected" if span data hasn't been sent to the Satellite yet.

The api.lightstep.com endpoint is no longer used.

Diagnostics Bundle

If the information shown isn't enough to make a quick diagnosis, the diagnostics page can generate a tarball with additional information. This will include the checks and logs shown above plus various profiles from the Satellite. The LightStep Customer Success team may request this to help with troubleshooting.

Review Satellite Diagnostics


Suggested Edits are limited on API Reference Pages

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