Skip to content

Conversation

@hawkw
Copy link
Contributor

@hawkw hawkw commented Apr 10, 2023

This branch adds documentation for the new metrics added in linkerd/linkerd2-proxy#2377 and linkerd/linkerd2-proxy#2380.

* `parent_group`, `parent_kind`, `parent_name`, and `parent_namespace` reference
the parent resource through which the proxy discovered the route binding.
The parent resource of an HTTPRoute is generally a Service.
* `route_grouo`, `route_kind`, `route_name`, and `route_namespace` reference the
Copy link
Member

Choose a reason for hiding this comment

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

typo: route_grouo

* `route_grouo`, `route_kind`, `route_name`, and `route_namespace` reference the
route resource through which the proxy discovered the route binding. This will
either reference an HTTPRoute resource or a default (synthesized) route.
* `backend_grouo`, `backend_kind`, `backend_name`, and `backend_namespace`
Copy link
Member

Choose a reason for hiding this comment

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

ditto

Comment on lines +242 to +243
When performing policy-based routing, proxies may dispatch requests through
per-route backend configurations. In order to record how routing rules
Copy link
Contributor Author

Choose a reason for hiding this comment

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

would be nice if this linked to the HTTPRoute docs once they land

Comment on lines +277 to +278
reestablished), or when the endpoint has been made unavailable by failure
accrual.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

would be nice if this linked to the failure accrual docs once #1598 lands

@hawkw hawkw merged commit 5d0d782 into main Apr 10, 2023
@hawkw hawkw deleted the eliza/route-metrics branch April 10, 2023 17:24
cratelyn added a commit that referenced this pull request Nov 14, 2025
the documentation of our proxy metrics has not kept pace with all of the
exciting telemetry that has been introduced since
#1599 documented the state of our
authorization policy metrics.

this commit reworks the documentation to exhaustively document the
families of metrics exported by the proxy. this commit does not
introduce mention of the _inbound_ metrics that have been added, but
does rename this section to "_Endpoint Metrics_" in order to be
compatible with the future addition of `inbound_http_route_*`,
`inbound_http_route_backend_*`, `inbound_grpc_route*`, and
`inbound_grpc_route_backend_*` metrics.

see:
* linkerd/linkerd2-proxy#2377
* linkerd/linkerd2-proxy#2380
* linkerd/linkerd2-proxy#3086
* linkerd/linkerd2-proxy#3308
* linkerd/linkerd2-proxy#3334

Signed-off-by: katelyn martin <[email protected]>
kflynn pushed a commit that referenced this pull request Nov 20, 2025
* feat(proxy-metrics): document outbound policy routing metrics

the documentation of our proxy metrics has not kept pace with all of the
exciting telemetry that has been introduced since
#1599 documented the state of our
authorization policy metrics.

this commit reworks the documentation to exhaustively document the
families of metrics exported by the proxy. this commit does not
introduce mention of the _inbound_ metrics that have been added, but
does rename this section to "_Endpoint Metrics_" in order to be
compatible with the future addition of `inbound_http_route_*`,
`inbound_http_route_backend_*`, `inbound_grpc_route*`, and
`inbound_grpc_route_backend_*` metrics.

see:
* linkerd/linkerd2-proxy#2377
* linkerd/linkerd2-proxy#2380
* linkerd/linkerd2-proxy#3086
* linkerd/linkerd2-proxy#3308
* linkerd/linkerd2-proxy#3334

Signed-off-by: katelyn martin <[email protected]>

* chore(markdownlint): allow duplicate "labels" headers

Signed-off-by: katelyn martin <[email protected]>

---------

Signed-off-by: katelyn martin <[email protected]>
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