-
Notifications
You must be signed in to change notification settings - Fork 330
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add integration tutorial for Grafana (#4295)
* Add integration tutorial for Grafana * Improve Grafana tutorial * Replace screenshot for grafana tutorial * Minor update. --------- Co-authored-by: fmassot <[email protected]>
- Loading branch information
Showing
4 changed files
with
99 additions
and
1 deletion.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions
98
docs/get-started/tutorials/trace-analytics-with-grafana.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
--- | ||
title: Trace analytics with Grafana | ||
description: A simple tutorial to use Grafana with Quickwit's datasource plugin. | ||
icon_url: /img/tutorials/quickwit-logo.png | ||
tags: [grafana, integration] | ||
sidebar_position: 2 | ||
--- | ||
|
||
In this tutorial, we will set up a Grafana Dashboard showing Quickwit traces using Docker Compose. | ||
|
||
You only need a few minutes to get Grafana working with Quickwit and build meaningful dashboards. | ||
|
||
![Quickwit Panel in Grafana Dashboard](../../assets/images/screenshot-grafana-tutorial-dashboard.png) | ||
|
||
## Create a Docker Compose recipe | ||
|
||
Let's add a [Quickwit instance](../installation.md) with the OTLP service enabled. | ||
|
||
```yaml | ||
version: '3.0' | ||
services: | ||
quickwit: | ||
image: quickwit/quickwit | ||
environment: | ||
QW_ENABLE_OPENTELEMETRY_OTLP_EXPORTER: "true" | ||
OTEL_EXPORTER_OTLP_ENDPOINT: "http://localhost:7281" | ||
ports: | ||
- 7280:7280 | ||
command: ["run"] | ||
``` | ||
Then we create a [Grafana](https://grafana.com/docs/grafana/latest/setup-grafana/installation/docker/#run-grafana-via-docker-compose) service with the [Quickwit Datasource](https://github.com/quickwit-oss/quickwit-datasource) plugin. | ||
```yaml | ||
grafana: | ||
image: grafana/grafana-oss | ||
container_name: grafana | ||
ports: | ||
- "${MAP_HOST_GRAFANA:-127.0.0.1}:3000:3000" | ||
environment: | ||
GF_INSTALL_PLUGINS: https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.3.0-beta.2/quickwit-quickwit-datasource-0.3.0-beta.2.zip;quickwit-quickwit-datasource | ||
GF_AUTH_DISABLE_LOGIN_FORM: "true" | ||
GF_AUTH_ANONYMOUS_ENABLED: "true" | ||
GF_AUTH_ANONYMOUS_ORG_ROLE: Admin | ||
``` | ||
Save and run the recipe: | ||
```bash | ||
$ docker compose up | ||
``` | ||
|
||
You should be able to access Quickwit's UI on `http://localhost:7280/` and Grafana's UI on `http://localhost:3000/`. | ||
|
||
## Setting up the datasource | ||
|
||
In Grafana, head to [Data Sources](http://localhost:3000/connections/datasources). If the plugin is installed correctly you should be able to find Quickwit in the list. | ||
|
||
We're going to set up a new Quickwit data source lookig at Quickwit's own OpenTelemetry traces, let's configure the datasource with the following parameters: | ||
|
||
- URL : `http://quickwit:7280/api/v1/` _This uses the docker service name as the host_ | ||
- Index ID : `otel-traces-v0_6` | ||
- Timestamp field : `span_start_timestamp_nanos` | ||
- Timestamp output format : `unix_timestamp_nanos` | ||
|
||
Save and test, you should obtain a confirmation that the datasource is correctly set up. | ||
|
||
|
||
![Quickwit Plugin configuration success](../../assets/images/grafana-ui-quickwit-datasource-plugin-success.png) | ||
|
||
## Creating a dashboard | ||
|
||
You can then [create a new dashboard](http://localhost:3000/dashboard/new) and add a visualization : you should be able to choose our new quickwit datasource here. | ||
|
||
Quickwit sends itself its own traces, so you should already have data to display. Let's configure some panels ! | ||
|
||
- a Table counting span_names | ||
- **Panel type** : Table | ||
- **Query**: _empty_ | ||
- **Metric** : Count | ||
- **Group by** : Terms : `span_name` : order by Count | ||
- a Bar Chart showing the amount of tantivy searches per hour : | ||
- **Panel type**: Time Series | ||
- **Query** : "span_name:tantivy_search" | ||
- **Metric**: Count | ||
- **Group by** : Date Histogram : `span_start_timestamp_nanos` : Interval 1h | ||
- a Bar Chart showing the amount of ERROR logs per hour for the last 6 hours : | ||
- **Panel type**: Bar Chart | ||
- **Query**: "service_name:quickwit AND events.event_attributes.level:ERROR" | ||
- **Metric**: Count | ||
- **Group by** : Terms : `span_start_timestamp_nanos` : Interval 1h | ||
- another query on the same Bar Chart for WARN logs | ||
|
||
## The result | ||
|
||
Here's what your first dashboard can look like : | ||
|
||
![Quickwit Panel in Grafana Dashboard](../../assets/images/screenshot-grafana-tutorial-dashboard.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters