Skip to content

Update monitoring-tracing.mdx #6598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 11, 2025
Merged

Update monitoring-tracing.mdx #6598

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6deea5e
Update monitoring-tracing.mdx
PlayAnyData Mar 10, 2025
541d119
Merge branch 'graphql-hive:main' into patch-5
PlayAnyData Mar 11, 2025
04a12be
docs: pretty
PlayAnyData Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions packages/web/docs/src/content/gateway/monitoring-tracing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1123,7 +1123,7 @@ This will log the traces to the console, which can be useful for debugging and t

## Prometheus Metrics

[Prometheus](https://www.prometheus.io/) is a utility for producing, scraping and storage of metrics
[Prometheus](https://www.prometheus.io/) is a utility for producing, scraping and storing metrics
from services and utilities.

You can use this feature of the gateway to expose and collect metrics from all phases of your
Expand Down Expand Up @@ -1221,20 +1221,20 @@ recommend using the official
### Grafana Dashboard

If you are using Grafana to visualize your metrics, you can
[import the published Grafana dashboard for Grafana's marketplace](https://grafana.com/grafana/dashboards/21777),
[import this pre-configured Grafana dashboard from Grafana's marketplace](https://grafana.com/grafana/dashboards/21777),
or
[you can use/import this dashboard JSON file directly](https://github.com/graphql-hive/gateway/blob/main/packages/plugins/prometheus/grafana.json)
to easily visualuze the metrics for your gateway.
to easily visualize the metrics for your gateway.

![image](https://github.com/user-attachments/assets/d72ef00b-90c2-4fb2-9bc4-851cec0eaf0b)

For additional instructions, please refer to
[Import dashboards insturction in Grafana documentation](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/).
[Import dashboards instruction in Grafana documentation](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/).

### Reported Metrics

You will find the timing of each phase of the GraphQL execution. If you are not familiar with the
lifecycle of a GraphQL operation in the gateway, please refer to the
You will find the timing of each GraphQL execution phase. If you are not familiar with the lifecycle
of a GraphQL operation in the gateway, please refer to the
[Plugin Lifecycle page](/docs/gateway/other-features/custom-plugins#plugin-lifecycle). Each plugin
hook has a corresponding metric which tracks timings as
[histograms](https://prometheus.io/docs/concepts/metric_types/#histogram) or
Expand Down
Loading