Skip to content

Commit

Permalink
chore: Update Subgraph Radio grafana dashboard installation docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
i0n committed Oct 30, 2024
1 parent 054df11 commit 1db937f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/graphcast/radios/subgraph-radio/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The Subgraph Radio exposes metrics that can then be scraped by a Prometheus serv

The Subgraph Radio Grafana dashboard is included by default in Stakesquid's docker-compose stack. If you're not using the stack, below is a walk-through of how you can set it up.

There is a [Grafana dashboard config JSON file](https://github.com/graphops/subgraph-radio/blob/dev/grafana.json) provided in the repo, which you can import and use to visualise the metrics in Grafana. When importing the dashboard, it will require you to specify two data sources - a Prometheus one and a GraphQL one. For Prometheus you should select the Prometheus instance that you've set up to scrape metrics from Subgraph Radio's metrics host and port. For GraphQL, you'd need to install the [GraphQL data source plugin](https://grafana.com/grafana/plugins/fifemon-graphql-datasource/?tab=installation), if you don't have it already installed. Then you need to create a new GraphQL data srouce that points to the GraphQL API of the Radio's integrated HTTP server. For instance, if you've set `SERVER_HOST` to` 0.0.0.0` and `SERVER_PORT` to `3012`, your GraphQL data source would need to point at `http://0.0.0.0:3012/api/v1/graphql`. You can learn more about the HTTP server in the next section.
There is a [Grafana dashboard config JSON file](https://github.com/graphops/subgraph-radio/blob/dev/grafana.json) provided in the repo, which you can import and use to visualise the metrics in Grafana. When importing the dashboard, it will require you to specify two data sources - a Prometheus one and a GraphQL one. For Prometheus you should select the Prometheus instance that you've set up to scrape metrics from Subgraph Radio's metrics host and port. For GraphQL, you'd need to install the [Infinity data source plugin](https://grafana.com/docs/plugins/yesoreyeram-infinity-datasource/latest/), if you don't have it already installed. The dashboard is configured to point to the default Kubernetes service deployments for Subgraph Radtio using [Launchpad Namespaces](https://github.com/graphops/launchpad-namespaces) If you are deploying using a different configuration the dashboard endpoints will need to be adjusted on lines: 878, 890, 895 and 898. The format for these addresses is: `http://<SUBGRAPH_RADIO_URL>:<SUBGRAPH_RADIO_GRAPHQL_PORT>/api/v1/graphql`. You can learn more about the HTTP server in the next section.

### Reading the Grafana dashboard

Expand Down

0 comments on commit 1db937f

Please sign in to comment.