Skip to content

Commit

Permalink
docs: add info about grafana dashboard (#1863)
Browse files Browse the repository at this point in the history
  • Loading branch information
draincoder authored Oct 20, 2024
1 parent 7c5cc6c commit 3beae64
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 0 deletions.
Binary file added docs/docs/assets/img/grafana-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/img/import-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/docs/en/getting-started/opentelemetry/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ An example includes:
* Three `FastStream` services
* Exporting traces to `Grafana Tempo` via `gRPC`
* Visualization of traces via `Grafana`
* Collecting metrics and exporting using `Prometheus`
* `Grafana dashboard` for metrics
* Examples with custom spans
* Configured `docker-compose` with the entire infrastructure

Expand Down
14 changes: 14 additions & 0 deletions docs/docs/en/getting-started/prometheus/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,17 @@ passing in the registry that was passed to `PrometheusMiddleware`.
| status (while publishing) | Message publishing status | `success`, `error` |
| destination | Where the message is sent | |
| exception_type (while publishing) | Exception type when publishing message | |
### Grafana dashboard
You can import the [**Grafana dashboard**](https://grafana.com/grafana/dashboards/22130-faststream-metrics/){.external-link target="_blank"} to visualize the metrics collected by middleware.
Enter the dashboard **URL** `https://grafana.com/grafana/dashboards/22130-faststream-metrics/` (or just the **ID**, `22130`), and click on **Load**.
![HTML-page](../../../assets/img/import-dashboard.png){ .on-glb loading=lazy }
`Import dashboard`
An [example](https://github.com/draincoder/faststream-monitoring){.external-link target="_blank"} application with configured **metrics**, **Prometheus** and **Grafana**.
![HTML-page](../../../assets/img/grafana-dashboard.png){ .on-glb loading=lazy }
`Grafana dashboard`

0 comments on commit 3beae64

Please sign in to comment.