Skip to content

docs: reuse shared gateway metrics content#862

Closed
omda777 wants to merge 8 commits into
kgateway-dev:mainfrom
omda777:docs/reuse-gateway-metrics
Closed

docs: reuse shared gateway metrics content#862
omda777 wants to merge 8 commits into
kgateway-dev:mainfrom
omda777:docs/reuse-gateway-metrics

Conversation

@omda777

@omda777 omda777 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor
  • Extract gateway metrics page content into a shared reusable asset
  • Update all versioned gateway metrics docs to use the shared reuse
    shortcode
  • Keep version-specific front matter in each docs page

issue #832

Signed-off-by: Abdelrahman Emad <abdoemad0120@gmail.com>
@omda777

omda777 commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

hi @artberger , @kristin-kronstain-brown
can review this PR

@kristin-kronstain-brown kristin-kronstain-brown left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some small suggestions.

By default, {{< reuse "/docs/snippets/kgateway.md" >}} exposes metrics in Prometheus format for the data plane of each gateway proxy. You can use these metrics to monitor the health and performance of your gateway environment.

## View default data plane metrics in Prometheus {#prometheus-metrics}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The otel-stack link was removed. Was that intentional? It shouldn't show in 2.0.x since that topic doesn't exist there, but you could add a version exclude shortcode around the sentence to omit it from that version.

The following steps show you how to quickly view the metrics endpoint of the gateway proxy deployment. To integrate the Prometheus metrics into your observability stack, see the [OpenTelemetry guide]({{< link-hextra path="/observability/otel-stack/" >}}).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it wasn't intentional. I copied it from 2.0.x.

Comment thread assets/docs/pages/observability/gateway-metrics.md Outdated
Comment thread content/docs/envoy/2.0.x/observability/gateway-metrics.md Outdated
Comment thread content/docs/envoy/2.1.x/observability/gateway-metrics.md Outdated
Comment thread content/docs/envoy/2.2.x/observability/gateway-metrics.md Outdated
Comment thread content/docs/envoy/latest/observability/gateway-metrics.md Outdated
Comment thread content/docs/envoy/main/observability/gateway-metrics.md Outdated
omda777 and others added 7 commits June 26, 2026 18:16
Co-authored-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Abdelrahman Emad <abdoemad0120@gmail.com>
Co-authored-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Abdelrahman Emad <abdoemad0120@gmail.com>
Co-authored-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Abdelrahman Emad <abdoemad0120@gmail.com>
Co-authored-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Abdelrahman Emad <abdoemad0120@gmail.com>
Co-authored-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Abdelrahman Emad <abdoemad0120@gmail.com>
Co-authored-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Abdelrahman Emad <abdoemad0120@gmail.com>
Signed-off-by: Abdelrahman Emad <abdoemad0120@gmail.com>
@omda777

omda777 commented Jun 28, 2026

Copy link
Copy Markdown
Contributor Author

Hi @kristin-kronstain-brown, I've updated the PR. Could you take another look?

@Nadine2016

Copy link
Copy Markdown
Contributor

this was addressed as part of this PR #879 as other changes to the page were introduced.

closing this pull request.

@Nadine2016 Nadine2016 closed this Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants