Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lightstep/lightstep-grafana-plugin
https://github.com/lightstep/lightstep-grafana-plugin
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lightstep/lightstep-grafana-plugin
- Owner: lightstep
- License: apache-2.0
- Created: 2018-01-09T16:12:05.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-12T20:14:18.000Z (about 1 year ago)
- Last Synced: 2023-09-13T06:12:26.467Z (about 1 year ago)
- Language: JavaScript
- Size: 2.11 MB
- Stars: 19
- Watchers: 66
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Lightstep Datasource for Streams
In August 2023, [Lightstep became ServiceNow
Cloud Observability](https://docs.lightstep.com/docs/banner-faq). To ease the
transition, all code artifacts will continue to use the Lightstep name. You
don't need to do anything to keep using this plugin.
Lightstep datasource for [streams]((https://docs.lightstep.com/docs/monitor-a-service-level-indicator-with-streams)) in Grafana.
Looking for [Lightstep metrics](https://lightstep.com/metrics/) in Grafana? Check out the [Lightstep Observability Datasource](https://github.com/lightstep/lightstep-observability-datasource).
## Requirements
* Grafana 7 (v1.1.9 or earlier) or Grafana 8 (v1.2.0 or later)
* Datasource configured with proxy mode (_not_ direct).
* Unsigned plugin permissions for: lightstep-app,grafana-lightstep-datasource,grafana-lightstep-graph
* [Lightstep streams](https://docs.lightstep.com/docs/monitor-a-service-level-indicator-with-streams)
* Lightstep API Key with viewer role
## Installing
1. Download the latest zip archive from the [Releases page](https://github.com/lightstep/lightstep-grafana-plugin/releases). Note that v1.2.0 and later are only compatible with Grafana 8.
2. Install the plugin from the zip archive, [see Grafana documentation here](https://grafana.com/docs/grafana/latest/plugins/installation).
3. Modify the `allow_loading_unsigned_plugins` property in `grafana.ini` to the following value (or set using the env var `GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS`):
```
[plugins]
allow_loading_unsigned_plugins = lightstep-app,grafana-lightstep-datasource,grafana-lightstep-graph
```
1. [Provision the data source](https://grafana.com/docs/grafana/latest/administration/provisioning/#data-sources) using a file or the Grafana UI. An example file for provisioning the plugin with a sample datasource can be found in the [`provisioning`](./provisioning/datasources) directory of this repository. Note that the API key, once set, is no longer visible in the UI.
2. Click "Save and Test" in the data source configuration page to confirm you can receive data from Lightstep.
## Templating
See the [Templating](https://grafana.com/docs/grafana/latest/reference/templating/) documentation for an introduction to the templating feature and the different types of template variables.
### Query variable
The Lightstep datasource provides the following queries that you can specify in the `Query` field in the Variable edit view of Grafana.
| Name | Description |
| ------------ |-------------|
| `attributes(name)`
`attributes(stream_query)` | Returns the Name or the Stream Query of all Streams. This is can be used with the `Regex` field in Grafana to build a dropdown |
| `stream_ids(stream_query=~"regex")`
`stream_ids(stream_query!=~"regex")`
`stream_ids(stream_query="value")`
`stream_ids(stream_query!="value")` | Returns the Stream ID of all matching Streams. The datasource uses the Stream ID to request the timeseries data in the various panel/visualization. |
| `stream_ids(name=~"regex")`
`stream_ids(name!=~"regex")`
`stream_ids(name="value")`
`stream_ids(name!="value")` | Returns the Stream ID of all matching Streams. The datasource uses the Stream ID to request the timeseries data in the various panel/visualization. |
### Using interval and range variables
It's possible to use some [global built-in variables](https://grafana.com/docs/grafana/latest/reference/templating/#global-built-in-variables) in the `Resolution` field.
Currently, only `$__range` and `$__interval` are supported.
## Testing
### Running on docker for development and testing
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 in testing. The `docker-compose.yml` configuration automatically provisions the plugin and creates a default datasource using the files in the `provisioning` directory.
```
# install dependencies
$ make install
# build assets from source
$ make build
# create volume so you don't lose your config across container start/stops
$ docker volume create grafana-data-lgp
$ edit `provisioning/datasources/lightstep.yaml` to point to your project/org
# bring up docker connected to your API key
$ export LIGHTSTEP_API_KEY=your_api_key
$ docker-compose up
# grafana is now running on localhost:3000
```
### Using the CLI
```
# Note: you will still need to manually provision the datasource and edit your grafana.ini file to allow unsigned plugins
$ make release
$ grafana-cli --pluginUrl ./lightstep-grafana-plugin-release.zip plugins install lightstep-app
```