Lightstep offers a plugin for Grafana that allows you to view Lightstep Stream charts directly in Grafana. You can navigate directly from the chart in Grafana to Lightstep where you can continue your investigation.

Looking for our metrics plugin for Grafana instead?

The Grafana Stream integration is on a per-project basis. If you want this integration for multiple Lightstep projects, follow these instructions for each of your projects.

Prerequisites

You’ll need the following to enable and use the plugin:

  • Your Organization and Project name. Both can be found on on the Project Settings page of Lightstep. Project settings
  • An API key created just for Grafana.
  • Existing Streams in Lightstep.

Installation

Install the plugin from the Grafana CLI using Grafana’s plugin installation instructions.

The Lightstep plugin is located in Git.

1
grafana-cli --pluginUrl https://github.com/lightstep/lightstep-grafana-plugin/archive/master.zip plugins install lightstep-tracing-app

Enable the Lightstep Plugin in Grafana

After you install the plugin, follow these steps:

Steps may vary slightly depending on your version of Grafana.

  1. Restart the grafana server so it can discover the new plugin.
  2. On Grafana’s Home Dashboard, on the right, click Enable Now for the Lightstep App.
  3. Click on the Grafana menu icon on the top left, and select Data Sources.
  4. On the top right, click Add data source.
  5. Set the name of your new data source (e.g. Lightstep).
  6. Set the type to Lightstep.
  7. Set your Organization and Project name.
  8. Set your API key.
  9. Make sure you leave the Access setting under Advanced set to Proxy.
  10. Hit Add at the bottom to save your new data source.

Use the Lightstep Plugin in Grafana

With the Lightstep plugin installed, you can query your Lightstep streams directly from Grafana.

  1. In the Edit Panel view, make sure Lightstep is selected as the data source. Lightstep as data source
  2. In the Select stream dropdown, start typing the Stream’s name to find it. Select stream
  3. To visualize the data correctly, in the Visualization Panel, select Lightstep Graph. Lightstep graph
  4. Click Apply to create the graph.

When viewing the graph, you can navigate to a trace in Lightstep by clicking any of the exemplar traces in the graph. Navigate to Lightstep