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    

Verify Satellite Setup

This document describes steps to take to verify that you've installed and configured your new satellite correctly.

Verify Satellite Log Statuses

  • /var/log/syslog (on Docker and Debian)
  • /var/log/messages (Amazon Linux)

The log should contain output from a self-test:

Satellite Self-Test Results... 
API Key authorized for:
1 Organizations [organization name]
5 Projects [project name]
100 Access Tokens [redacted]
Tests: Connected to api-grpc.lightstep.com:8043: success
Require unique port numbers: success
Self-Test Status: SUCCESS 

If you don't see a success message, read below to help troubleshoot.

Verify Basic Connectivity

  1. Verify application host to Satellite network connectivity.
    Are you able to ping the Satellite from the application host?
  2. Verify that the Satellite host is correctly listening.
    Open a browser and access the Satellite's diagnostic page: http://{satellite_ip}:8000}/diagnostics.
    The Satellite Diagnostics page should display.

Verify the Satellite Can Process Spans

  1. Create a workspace directory under your home directory.
    > mkdir workspace
    

Go Setup

  • Ensure that Go 1.7 or higher is installed.
  • Set GOPATH=$HOME/workspace
  1. Setup Lightstep Go Tracer

    > cd workspace
    > go get 'github.com/lightstep/lightstep-tracer-go'
    
  2. Run the Span generator

    > cd ~/workspace/src/github.com/lightstep/lightstep-tracer-go/cmd/sendspan
    > go run main.go -access_token {access_token} -collector_host {satellite_ip} -collector_port {http_plain_port} -secure=false -use_grpc=false -operation_name {dummy_operation_name}
    
  3. Verify that traffic is sent. Go to https://app.lightstep.com/{project}/live and click Explorer from the left navigation bar. There should now be a value for "Operation: {dummy_operation_name}", verifying that the Satellite is receiving and sending data.

Possible Service Startup Issues

Check your /var/logs/syslog file on your Satellite host for these possible Satellite service startup issues:

  • Apr 30 18:18:15 collector-host lightstep-collector[5571]: panic: failed to generate credentials:open /root/certs/mydomain.bundle.pem: permission denied
    If you are not using a secure connection between the application and the Satellite, comment out the tls_cert_prefix: /root/certs/mydomain in your Satellite Configuration file.
    If you are using a secure connection, make sure the certificate file is correct.

  • Apr 30 18:22:12 collector-host lightstep-collector[5729]: panic: listen tcp :80: bind: permission denied
    By default, the Satellite uses port 80 on the Satellite host for inbound non-secure communications with the application clients. Because port 80 is a privileged port, you may receive a permission error. You can modify the plain_port: configuration in your Satellite Configuration file to use a non-privileged port (above 1024).

Monitor and Tune Satellites

Now that you've verified that your tracers, Satellites, and the LightStep Engine are communicating, you need to ensure that the configurations are ideal for the amount of span data that your tracers are collecting from your instrumentation. LightStep offers a number of ways to Monitor LightStep performance. If you see issues, you may need to tune configuration options, add more satellites, or load balance.

Verify Satellite Setup


Suggested Edits are limited on API Reference Pages

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