metrics: add links to public dashboards (#2486)

* metrics: add links to public dashboards

* add dashboards to top readme

---------

Co-authored-by: Prithvi Shahi <shahi.prithvi@gmail.com>
This commit is contained in:
Sukun
2023-08-15 23:00:31 +05:30
committed by GitHub
parent 3f2f357229
commit c97fce88bf
2 changed files with 19 additions and 0 deletions

View File

@@ -18,6 +18,7 @@
- [Roadmap](#roadmap)
- [Usage](#usage)
- [Examples](#examples)
- [Dashboards](#dashboards)
- [Contribute](#contribute)
- [Supported Go Versions](#supported-go-versions)
- [Notable Users](#notable-users)
@@ -54,6 +55,13 @@ import "github.com/libp2p/go-libp2p"
Examples can be found in the [examples folder](examples).
## Dashboards
We provide prebuilt Grafana dashboards so that applications can better monitor libp2p in production.
You can find the [dashboard JSON files here](https://github.com/libp2p/go-libp2p/tree/master/dashboards).
We also have live [Public Dashboards](https://github.com/libp2p/go-libp2p/tree/master/dashboards/README.md#public-dashboards) that you can check out to see real time monitoring in action.
# Contribute

View File

@@ -3,6 +3,17 @@
This directory contains prebuilt dashboards (provided as JSON files) for various components.
For steps on how to import and use them [please read the official Grafana documentation.](https://grafana.com/docs/grafana/latest/dashboards/export-import/#import-dashboard)
## Public dashboards
You can check the following prebuilt dashboards in action:
1. [AutoNAT](https://protocollabs.grafana.net/public-dashboards/fce8fdeb629742c89bd70f0ce38dfd97)
2. [Auto Relay](https://protocollabs.grafana.net/public-dashboards/380d52aded12404e9cf6ceccb824b7f9)
3. [Eventbus](https://protocollabs.grafana.net/public-dashboards/048029ac2d7e4a71b281ffea3535026e)
4. [Identify](https://protocollabs.grafana.net/public-dashboards/96b70328253d47c0b352dfae06f12a1b)
5. [Relay Service](https://protocollabs.grafana.net/public-dashboards/4a8cb5d245294893874ed65279b049be)
6. [Swarm](https://protocollabs.grafana.net/public-dashboards/2bd3f1bee9964d40b6786fbe3eafd9fc)
## Using locally
For local development and debugging, it can be useful to spin up a local Prometheus and Grafana instance.