Repository navigation
[Automated] Draft docs (agentgateway): feat(hbone): serve the metrics endpoint over HBONE - #1452
Open
github-actions[bot] wants to merge 3 commits into
Open
github-actions[bot] wants to merge 3 commits into
github-actions[bot] wants to merge 3 commits into
Conversation
… endpoint over HBONE Drafts-Commit: e1c3749 Signed-off-by: GitHub Action <action@github.com>
Deploying agentproxy with
|
| Latest commit: |
e336ff0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7f78dccc.agentproxy.pages.dev |
| Branch Preview URL: | https://pr-tracker-draft-agentgatewa-56aa.agentproxy.pages.dev |
The release-notes entry for this change now lives in the combined release-notes PR, #1482, so the draft PRs no longer conflict on the release-notes pages. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Collaborator
|
Moved this PR's release-notes entry to the combined release-notes PR, #1482, so the draft PRs stop conflicting on the release-notes pages. Review or change the entry there. |
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
agentgateway/agentgateway#4118 — feat(hbone): serve the metrics endpoint over HBONE
Docs versions:
standalone/main,kubernetes/mainNo code-path rule covers 5 touched file(s). The planner could route these only by identifier search, so the candidate pages may miss what they changed, including in the other mode:
crates/agentgateway/src/app.rscrates/agentgateway/src/lib.rscrates/agentgateway/src/management/hyper_helpers.rscrates/agentgateway/src/proxy/gateway.rscrates/agentgateway/src/proxy/tcpproxy.rsWhat changes for users: Prometheus can scrape the proxy
/metricsendpoint over HBONE when the stats listener is bound to all interfaces, such as0.0.0.0:15020. A loopback-only stats listener is not exposed over HBONE. Standalone configs with anhbone:block can also omithbone.poolUnusedReleaseTimeout.What the docs now say: The Kubernetes data plane metrics page now states the HBONE scraping condition and that routes and policies do not apply to the metrics request. The standalone Prometheus page now tells readers to bind
statsAddrto a non-loopback address when another workload scrapes the endpoint, such as through HBONE.How
agentgateway-4118was drafted, and what was not verifiedPlan, and what changed it
hbone.poolUnusedReleaseTimeout, but no authorized prose page owns standalone HBONE pool fields beyond generated schema coverage.Why a documentation change is necessary
The pull request exposes the data plane metrics service through the HBONE path when the requested port matches the stats listener and that listener is bound on an unspecified address. The existing metrics pages explain direct scraping on port
15020, but they do not tell readers that ambient-mesh scraping can reach the same endpoint over HBONE or that loopback-bound stats listeners stay private. The diff also shows that the metrics request bypasses binds, routes, and policies, which matters to readers who expect normal gateway routing to apply.What changed on disk
assets/agw-docs/pages/observability/metrics/dataplane.md: Added a main-only note for Kubernetes data plane metrics over HBONE.content/docs/standalone/main/documentation/observability/metrics/prometheus.md: Added the standalonestatsAddrbinding requirement for scrapers in another workload.How to verify this change
15020.agentgateway_build_info.127.0.0.1:15020, and repeat the scrape from the meshed workload. The metrics endpoint is not exposed over HBONE.What was not verified
How the pages were chosen (triage report)
Draft a documentation change
agentgateway/agentgateway#4118 — feat(hbone): serve the metrics endpoint over HBONE
agentgateway/websitecrates/agentgateway/src/app.rscrates/agentgateway/src/lib.rscrates/agentgateway/src/management/hyper_helpers.rscrates/agentgateway/src/proxy/gateway.rscrates/agentgateway/src/proxy/tcpproxy.rsRelease notes
This pull request also adds its release-note entries:
content/docs/kubernetes/main/release-notes/release-notes.md: Metrics scraping over HBONE (feature, in a new 1.8 section)content/docs/standalone/main/release-notes/release-notes.md: Metrics scraping over HBONE (feature, in a new 1.8 section)Check these release-note links and names. Each note is on its page, but a link may not reach the drafted content there, or a name may belong to the other mode:
content/docs/kubernetes/main/release-notes/release-notes.md: feat(hbone): serve the metrics endpoint over HBONE agentgateway#4118's note links to/documentation/observability/metrics/, which in this tree iscontent/docs/kubernetes/main/documentation/observability/metrics/_index.md, a page this draft did not change. A note placed in more than one tree resolves its links in each one; check that the link reaches the drafted content here, or word the note for this tree.content/docs/kubernetes/main/release-notes/release-notes.md: feat(hbone): serve the metrics endpoint over HBONE agentgateway#4118's note names0.0.0.0:15020, whichcontent/docs/standalone/mainmentions andcontent/docs/kubernetes/maindoes not. Check that this tree's readers can set it, or word the note for this mode.content/docs/standalone/main/release-notes/release-notes.md: feat(hbone): serve the metrics endpoint over HBONE agentgateway#4118's note links to/documentation/observability/metrics/, which in this tree iscontent/docs/standalone/main/documentation/observability/metrics/_index.md, a page this draft did not change. A note placed in more than one tree resolves its links in each one; check that the link reaches the drafted content here, or word the note for this tree.Draft branch:
pr-tracker-draft-agentgateway-4118