To get telemetry data into Lightstep, you need to instrument your services to send information about the spans from your operations to Lightstep Satellites, which analysize that data and send it on to the Lightstep UI.

OpenTelemetry provides APIs, libraries, agents, and collector services to capture that data from your application. It’s currently in Beta (with a GA release in November 2020).

Already instrumented using OpenTelemetry Collector? It’s easy to configure them to report to Lightstep.

There are generally two ways to instrument:

  • Auto-installers: An agent or wrapper instruments RPC frameworks, clients and other common libraries, either by modifying code at runtime or by integrating like a plug-in as a dependency. Requires little to no service code, depending on your language.
  • Manual instrumentation: Uses an SDK and APIs you call from your services to provide observability into the operations within a service.

Using the auto-installers is a quick way to start seeing your telemetry data in Lightstep. Once that’s in place, you’ll be able to see where the blind spots are in your system and you can start adding manual instrumentation as needed.

Instrument with OpenTelemetry

Following are links to get started with OpenTelemetry, by language.

If OpenTelemetry doesn’t currently support the language you need, you can use OpenTracing for now and then move to OpenTelemetry when it’s ready. If you use OpenTracing in some services and OpenTelemetry in other services, traces will be correctly connected as long as you use B3 context propagation in all services.

Java

Quick Start
Add instrumentation

JavaScript/Node.js

Node.js Quick Start
JavaScript Browser setup and installation
JavaScript/Node.js add instrumentation

Python

Quick Start
Add instrumentation

Golang

Quick Start
Add instrumentation

C#/.NET

.NET Quick Start

Instrument with OpenTracing

If the language you need isn’t yet available in OpenTelemetry, you can get started with OpenTracing.

C++

Get Started
GitHub repo

Objective-C/Swift

Get Started
GitHub repo

PHP

Get Started
GitHub repo

Ruby

Auto-install
Add instrumentation
GitHub repo