Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lightstep/lightstep-metrics-datasource
Lightstep's Grafana Datasource for Metrics
https://github.com/lightstep/lightstep-metrics-datasource
Last synced: 8 days ago
JSON representation
Lightstep's Grafana Datasource for Metrics
- Host: GitHub
- URL: https://github.com/lightstep/lightstep-metrics-datasource
- Owner: lightstep
- License: apache-2.0
- Created: 2021-04-16T17:14:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-04T18:14:02.000Z (about 2 years ago)
- Last Synced: 2024-04-14T09:25:51.681Z (7 months ago)
- Language: TypeScript
- Size: 6.55 MB
- Stars: 4
- Watchers: 57
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECATED: Lightstep Metrics Plugin
### This data source has been deprecated. Please use https://github.com/lightstep/lightstep-observability-datasource.
The Lightstep Metrics Plugin allows you to view metrics from Lightstep directly in Grafana. With minimal effort, you can use the plugin to continue viewing your existing visualizations in Grafana, using Lightstep as the data source. Then when you notice a deviation, you can click in a chart in Grafana and navigate into Lightstep to use [Change Intelligence](https://docs.lightstep.com/docs/investigate-metric-deviation) and uncover the root cause.
Change Intelligence determines the service that emitted a metric, searches for performance changes on Key Operations from that service at the same time as the deviation, and then uses trace data to determine what caused the change.
**NOTE:** _The Lightstep Metrics Plugin 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:
- A Grafana account (version 7 and greater)
**NOTE:** _The plugin only supports graph and time series charts._
- [Metric data](https://docs.lightstep.com/docs/send-metrics-to-lightstep) reporting to Lightstep.
Currently using Prometheus? You can use the [Prometheus sidecar](https://docs.lightstep.com/docs/ingest-metrics-prometheus) to send metrics to Lightstep. Lightstep also accepts metrics from other [backends](https://docs.lightstep.com/docs/send-metrics-to-lightstep).
- Your Organization and Project name. Both can be found on on the [Project Settings page](https://docs.lightstep.com/docs/create-projects-for-your-environments) of Lightstep.
- A Lightstep [API key](https://docs.lightstep.com/docs/create-and-manage-api-keys) with Viewer permissions created just for Grafana.
Paste the key someplace safe, as you will not be able to access it again from Lightstep.
## Installation
You can install the plugin using the Grafana CLI, or if your Grafana server doesn't have internet access, you can download and instal it manually.
### Install from the CLI
Install the plugin from the Grafana CLI using [Grafana's plugin installation instructions](https://grafana.com/docs/grafana/latest/plugins/installation/).
```sh
grafana-cli plugins install lightstep-metrics-datasource
```
### Install Manually
1. Download the zip file from GitHub releases page.
```sh
https://github.com/lightstep/lightstep-metrics-datasource/releases
```
### Develop with Docker
It's possible to use the `docker-compose.yml` file in this repo to quickly install this plugin in a new instance of Grafana for development or testing.
First, create a named volume so settings and dashboards will persist across container launches:
```
$ docker volume create grafana-data-lmd
# build the plugin
$ yarn install && yarn build
```
Next, run docker compose: `docker compose up` — the plugin now will be able to be installed on the Grafana instance that runs on `localhost:3000`.
## 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. In the Navigation Bar, choose **Configuration**, select **Data Sources**, and click **Add data source**.
3. Start typing `Lightstep` in the search field to find the Lightstep Metrics plugin and click **Select**.
4. Enter your Lightstep organization and project name, paste in your Lightstep [API key](https://docs.lightstep.com/docs/create-and-manage-api-keys), and click **Save & Test**.
Grafana confirms that it's connected to Lightstep.
You can now create dashboards and charts in Grafana using metrics sent from Lightstep.
## Create Grafana Charts Using Metrics from Lightstep
With the Lightstep plugin installed, you can query your Lightstep metrics directly from Grafana.
1. In the Edit Panel view, make sure **Lightstep Metrics** is selected as the data source.
2. Use the **Metrics** dropdown to select the metric for your query.
3. Continue adding to your query in the **Metrics** field, using the [PromQL](https://prometheus.io/docs/prometheus/latest/querying/basics/) query language.
Click out of the field (or press `shift` + `Enter`) to run your query.
4. Choose the visualization for the chart (Lightstep supports either **Graph** or **Time Series**). Click **Apply** to create the graph.
## Investigate a Metric Deviation from a Grafana Chart
Now that you have a Grafana chart based on Lightstep metrics, when you notice a deviation, you can go directly from that chart into Lightstep to find the root cause.
When you view the chart and notice a deviation that you'd like to investigate, click into the deviation and select **View what changed in Lightstep**.
You're taken into Change Intelligence in Lightstep, where you can [start your investigation](https://docs.lightstep.com/docs/investigate-metric-deviation).
View the query you made in Grafana by clicking the **View query** button.
