Skip to content

Commit a1d1a68

Browse files
Fixed formatting in Proxy Metrics reference doc (#2071)
Signed-off-by: Travis Beckham <travis@buoyant.io>
1 parent 16cd206 commit a1d1a68

File tree

11 files changed

+2
-102
lines changed

11 files changed

+2
-102
lines changed

linkerd.io/content/2-edge/reference/proxy-metrics.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,12 @@ The Linkerd proxy exposes metrics that describe the traffic flowing through the
99
proxy. The following metrics are available at `/metrics` on the proxy's metrics
1010
port (default: `:4191`) in the [Prometheus format][prom-format].
1111

12-
## Process-level Metrics
12+
## Process-Level Metrics
1313

1414
- `proxy_build_info`: A constant gauge with information on how this instance of
1515
the proxy was built, such as build date, proxy version, etc.
16-
1716
- `rustls_info`: A constant gauge with information on the proxy's TLS library,
1817
`rustls`. This includes the following labels:
19-
2018
- `tls_suites`: The set of cipher suites that the proxy will use for TLS
2119
connections, sorted by preference order.
2220
- `tls_kx_groups`: The set of key exchange algorithms the proxy will use,
@@ -25,50 +23,42 @@ port (default: `:4191`) in the [Prometheus format][prom-format].
2523
- `tls_key_provider`: The crytpographic key provider
2624
- `tls_fips`: A boolean denoting if the proxy's connections are
2725
FIPS-compliant.
28-
2926
- `tokio_rt_*`: A set of counters and gauges with stats on the proxy's
3027
asynchronous runtime, `tokio`.
3128

3229
## Protocol-Level Metrics
3330

3431
- `request_total`: A counter of the number of requests the proxy has received.
3532
This is incremented when the request stream begins.
36-
3733
- `response_total`: A counter of the number of responses the proxy has received.
3834
This is incremented when the response stream ends.
39-
4035
- `response_latency_ms`: A histogram of response latencies. This measurement
4136
reflects the [time-to-first-byte][ttfb] (TTFB) by recording the elapsed time
4237
between the proxy processing a request's headers and the first data frame of
4338
the response. If a response does not include any data, the end-of-stream event
4439
is used. The TTFB measurement is used so that Linkerd accurately reflects
4540
application behavior when a server provides response headers immediately but
4641
is slow to begin serving the response body.
47-
4842
- `route_request_total`, `route_response_latency_ms`, and
4943
`route_response_total`: These metrics are analogous to `request_total`,
5044
`response_latency_ms`, and `response_total` except that they are collected at
5145
the route level. This means that they do not have `authority`, `tls`,
5246
`grpc_status_code` or any outbound labels but instead they have:
5347
- `dst`: The authority of this request.
5448
- `rt_route`: The name of the route for this request.
55-
5649
- `control_request_total`, `control_response_latency_ms`, and
5750
`control_response_total`: These metrics are analogous to `request_total`,
5851
`response_latency_ms`, and `response_total` but for requests that the proxy
5952
makes to the Linkerd control plane. Instead of `authority`, `direction`, or
6053
any outbound labels, instead they have:
6154
- `addr`: The address used to connect to the control plane.
62-
6355
- `inbound_http_authz_allow_total`: A counter of the total number of inbound
6456
HTTP requests that were authorized.
6557
- `authz_name`: The name of the authorization policy used to allow the
6658
request.
67-
6859
- `inbound_http_authz_deny_total`: A counter of the total number of inbound HTTP
6960
requests that could not be processed due to being denied by the authorization
7061
policy.
71-
7262
- `inbound_http_route_not_found_total`: A counter of the total number of inbound
7363
HTTP requests that could not be associated with a route.
7464

linkerd.io/content/2.10/reference/proxy-metrics.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,22 @@ port (default: `:4191`) in the [Prometheus format][prom-format].
1313

1414
- `request_total`: A counter of the number of requests the proxy has received.
1515
This is incremented when the request stream begins.
16-
1716
- `response_total`: A counter of the number of responses the proxy has received.
1817
This is incremented when the response stream ends.
19-
2018
- `response_latency_ms`: A histogram of response latencies. This measurement
2119
reflects the [time-to-first-byte][ttfb] (TTFB) by recording the elapsed time
2220
between the proxy processing a request's headers and the first data frame of
2321
the response. If a response does not include any data, the end-of-stream event
2422
is used. The TTFB measurement is used so that Linkerd accurately reflects
2523
application behavior when a server provides response headers immediately but
2624
is slow to begin serving the response body.
27-
2825
- `route_request_total`, `route_response_latency_ms`, and
2926
`route_response_total`: These metrics are analogous to `request_total`,
3027
`response_latency_ms`, and `response_total` except that they are collected at
3128
the route level. This means that they do not have `authority`, `tls`,
3229
`grpc_status_code` or any outbound labels but instead they have:
33-
3430
- `dst`: The authority of this request.
3531
- `rt_route`: The name of the route for this request.
36-
3732
- `control_request_total`, `control_response_latency_ms`, and
3833
`control_response_total`: These metrics are analogous to `request_total`,
3934
`response_latency_ms`, and `response_total` but for requests that the proxy

linkerd.io/content/2.11/reference/proxy-metrics.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,22 @@ port (default: `:4191`) in the [Prometheus format][prom-format].
1313

1414
- `request_total`: A counter of the number of requests the proxy has received.
1515
This is incremented when the request stream begins.
16-
1716
- `response_total`: A counter of the number of responses the proxy has received.
1817
This is incremented when the response stream ends.
19-
2018
- `response_latency_ms`: A histogram of response latencies. This measurement
2119
reflects the [time-to-first-byte][ttfb] (TTFB) by recording the elapsed time
2220
between the proxy processing a request's headers and the first data frame of
2321
the response. If a response does not include any data, the end-of-stream event
2422
is used. The TTFB measurement is used so that Linkerd accurately reflects
2523
application behavior when a server provides response headers immediately but
2624
is slow to begin serving the response body.
27-
2825
- `route_request_total`, `route_response_latency_ms`, and
2926
`route_response_total`: These metrics are analogous to `request_total`,
3027
`response_latency_ms`, and `response_total` except that they are collected at
3128
the route level. This means that they do not have `authority`, `tls`,
3229
`grpc_status_code` or any outbound labels but instead they have:
33-
3430
- `dst`: The authority of this request.
3531
- `rt_route`: The name of the route for this request.
36-
3732
- `control_request_total`, `control_response_latency_ms`, and
3833
`control_response_total`: These metrics are analogous to `request_total`,
3934
`response_latency_ms`, and `response_total` but for requests that the proxy

linkerd.io/content/2.12/reference/proxy-metrics.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,45 +13,35 @@ port (default: `:4191`) in the [Prometheus format][prom-format].
1313

1414
- `request_total`: A counter of the number of requests the proxy has received.
1515
This is incremented when the request stream begins.
16-
1716
- `response_total`: A counter of the number of responses the proxy has received.
1817
This is incremented when the response stream ends.
19-
2018
- `response_latency_ms`: A histogram of response latencies. This measurement
2119
reflects the [time-to-first-byte][ttfb] (TTFB) by recording the elapsed time
2220
between the proxy processing a request's headers and the first data frame of
2321
the response. If a response does not include any data, the end-of-stream event
2422
is used. The TTFB measurement is used so that Linkerd accurately reflects
2523
application behavior when a server provides response headers immediately but
2624
is slow to begin serving the response body.
27-
2825
- `route_request_total`, `route_response_latency_ms`, and
2926
`route_response_total`: These metrics are analogous to `request_total`,
3027
`response_latency_ms`, and `response_total` except that they are collected at
3128
the route level. This means that they do not have `authority`, `tls`,
3229
`grpc_status_code` or any outbound labels but instead they have:
33-
3430
- `dst`: The authority of this request.
3531
- `rt_route`: The name of the route for this request.
36-
3732
- `control_request_total`, `control_response_latency_ms`, and
3833
`control_response_total`: These metrics are analogous to `request_total`,
3934
`response_latency_ms`, and `response_total` but for requests that the proxy
4035
makes to the Linkerd control plane. Instead of `authority`, `direction`, or
4136
any outbound labels, instead they have:
42-
4337
- `addr`: The address used to connect to the control plane.
44-
4538
- `inbound_http_authz_allow_total`: A counter of the total number of inbound
4639
HTTP requests that were authorized.
47-
4840
- `authz_name`: The name of the authorization policy used to allow the
4941
request.
50-
5142
- `inbound_http_authz_deny_total`: A counter of the total number of inbound HTTP
5243
requests that could not be processed due to being denied by the authorization
5344
policy.
54-
5545
- `inbound_http_route_not_found_total`: A counter of the total number of inbound
5646
HTTP requests that could not be associated with a route.
5747

linkerd.io/content/2.13/reference/proxy-metrics.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,45 +13,35 @@ port (default: `:4191`) in the [Prometheus format][prom-format].
1313

1414
- `request_total`: A counter of the number of requests the proxy has received.
1515
This is incremented when the request stream begins.
16-
1716
- `response_total`: A counter of the number of responses the proxy has received.
1817
This is incremented when the response stream ends.
19-
2018
- `response_latency_ms`: A histogram of response latencies. This measurement
2119
reflects the [time-to-first-byte][ttfb] (TTFB) by recording the elapsed time
2220
between the proxy processing a request's headers and the first data frame of
2321
the response. If a response does not include any data, the end-of-stream event
2422
is used. The TTFB measurement is used so that Linkerd accurately reflects
2523
application behavior when a server provides response headers immediately but
2624
is slow to begin serving the response body.
27-
2825
- `route_request_total`, `route_response_latency_ms`, and
2926
`route_response_total`: These metrics are analogous to `request_total`,
3027
`response_latency_ms`, and `response_total` except that they are collected at
3128
the route level. This means that they do not have `authority`, `tls`,
3229
`grpc_status_code` or any outbound labels but instead they have:
33-
3430
- `dst`: The authority of this request.
3531
- `rt_route`: The name of the route for this request.
36-
3732
- `control_request_total`, `control_response_latency_ms`, and
3833
`control_response_total`: These metrics are analogous to `request_total`,
3934
`response_latency_ms`, and `response_total` but for requests that the proxy
4035
makes to the Linkerd control plane. Instead of `authority`, `direction`, or
4136
any outbound labels, instead they have:
42-
4337
- `addr`: The address used to connect to the control plane.
44-
4538
- `inbound_http_authz_allow_total`: A counter of the total number of inbound
4639
HTTP requests that were authorized.
47-
4840
- `authz_name`: The name of the authorization policy used to allow the
4941
request.
50-
5142
- `inbound_http_authz_deny_total`: A counter of the total number of inbound HTTP
5243
requests that could not be processed due to being denied by the authorization
5344
policy.
54-
5545
- `inbound_http_route_not_found_total`: A counter of the total number of inbound
5646
HTTP requests that could not be associated with a route.
5747

linkerd.io/content/2.14/reference/proxy-metrics.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,45 +13,35 @@ port (default: `:4191`) in the [Prometheus format][prom-format].
1313

1414
- `request_total`: A counter of the number of requests the proxy has received.
1515
This is incremented when the request stream begins.
16-
1716
- `response_total`: A counter of the number of responses the proxy has received.
1817
This is incremented when the response stream ends.
19-
2018
- `response_latency_ms`: A histogram of response latencies. This measurement
2119
reflects the [time-to-first-byte][ttfb] (TTFB) by recording the elapsed time
2220
between the proxy processing a request's headers and the first data frame of
2321
the response. If a response does not include any data, the end-of-stream event
2422
is used. The TTFB measurement is used so that Linkerd accurately reflects
2523
application behavior when a server provides response headers immediately but
2624
is slow to begin serving the response body.
27-
2825
- `route_request_total`, `route_response_latency_ms`, and
2926
`route_response_total`: These metrics are analogous to `request_total`,
3027
`response_latency_ms`, and `response_total` except that they are collected at
3128
the route level. This means that they do not have `authority`, `tls`,
3229
`grpc_status_code` or any outbound labels but instead they have:
33-
3430
- `dst`: The authority of this request.
3531
- `rt_route`: The name of the route for this request.
36-
3732
- `control_request_total`, `control_response_latency_ms`, and
3833
`control_response_total`: These metrics are analogous to `request_total`,
3934
`response_latency_ms`, and `response_total` but for requests that the proxy
4035
makes to the Linkerd control plane. Instead of `authority`, `direction`, or
4136
any outbound labels, instead they have:
42-
4337
- `addr`: The address used to connect to the control plane.
44-
4538
- `inbound_http_authz_allow_total`: A counter of the total number of inbound
4639
HTTP requests that were authorized.
47-
4840
- `authz_name`: The name of the authorization policy used to allow the
4941
request.
50-
5142
- `inbound_http_authz_deny_total`: A counter of the total number of inbound HTTP
5243
requests that could not be processed due to being denied by the authorization
5344
policy.
54-
5545
- `inbound_http_route_not_found_total`: A counter of the total number of inbound
5646
HTTP requests that could not be associated with a route.
5747

linkerd.io/content/2.15/reference/proxy-metrics.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,45 +13,35 @@ port (default: `:4191`) in the [Prometheus format][prom-format].
1313

1414
- `request_total`: A counter of the number of requests the proxy has received.
1515
This is incremented when the request stream begins.
16-
1716
- `response_total`: A counter of the number of responses the proxy has received.
1817
This is incremented when the response stream ends.
19-
2018
- `response_latency_ms`: A histogram of response latencies. This measurement
2119
reflects the [time-to-first-byte][ttfb] (TTFB) by recording the elapsed time
2220
between the proxy processing a request's headers and the first data frame of
2321
the response. If a response does not include any data, the end-of-stream event
2422
is used. The TTFB measurement is used so that Linkerd accurately reflects
2523
application behavior when a server provides response headers immediately but
2624
is slow to begin serving the response body.
27-
2825
- `route_request_total`, `route_response_latency_ms`, and
2926
`route_response_total`: These metrics are analogous to `request_total`,
3027
`response_latency_ms`, and `response_total` except that they are collected at
3128
the route level. This means that they do not have `authority`, `tls`,
3229
`grpc_status_code` or any outbound labels but instead they have:
33-
3430
- `dst`: The authority of this request.
3531
- `rt_route`: The name of the route for this request.
36-
3732
- `control_request_total`, `control_response_latency_ms`, and
3833
`control_response_total`: These metrics are analogous to `request_total`,
3934
`response_latency_ms`, and `response_total` but for requests that the proxy
4035
makes to the Linkerd control plane. Instead of `authority`, `direction`, or
4136
any outbound labels, instead they have:
42-
4337
- `addr`: The address used to connect to the control plane.
44-
4538
- `inbound_http_authz_allow_total`: A counter of the total number of inbound
4639
HTTP requests that were authorized.
47-
4840
- `authz_name`: The name of the authorization policy used to allow the
4941
request.
50-
5142
- `inbound_http_authz_deny_total`: A counter of the total number of inbound HTTP
5243
requests that could not be processed due to being denied by the authorization
5344
policy.
54-
5545
- `inbound_http_route_not_found_total`: A counter of the total number of inbound
5646
HTTP requests that could not be associated with a route.
5747

linkerd.io/content/2.16/reference/proxy-metrics.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,45 +13,35 @@ port (default: `:4191`) in the [Prometheus format][prom-format].
1313

1414
- `request_total`: A counter of the number of requests the proxy has received.
1515
This is incremented when the request stream begins.
16-
1716
- `response_total`: A counter of the number of responses the proxy has received.
1817
This is incremented when the response stream ends.
19-
2018
- `response_latency_ms`: A histogram of response latencies. This measurement
2119
reflects the [time-to-first-byte][ttfb] (TTFB) by recording the elapsed time
2220
between the proxy processing a request's headers and the first data frame of
2321
the response. If a response does not include any data, the end-of-stream event
2422
is used. The TTFB measurement is used so that Linkerd accurately reflects
2523
application behavior when a server provides response headers immediately but
2624
is slow to begin serving the response body.
27-
2825
- `route_request_total`, `route_response_latency_ms`, and
2926
`route_response_total`: These metrics are analogous to `request_total`,
3027
`response_latency_ms`, and `response_total` except that they are collected at
3128
the route level. This means that they do not have `authority`, `tls`,
3229
`grpc_status_code` or any outbound labels but instead they have:
33-
3430
- `dst`: The authority of this request.
3531
- `rt_route`: The name of the route for this request.
36-
3732
- `control_request_total`, `control_response_latency_ms`, and
3833
`control_response_total`: These metrics are analogous to `request_total`,
3934
`response_latency_ms`, and `response_total` but for requests that the proxy
4035
makes to the Linkerd control plane. Instead of `authority`, `direction`, or
4136
any outbound labels, instead they have:
42-
4337
- `addr`: The address used to connect to the control plane.
44-
4538
- `inbound_http_authz_allow_total`: A counter of the total number of inbound
4639
HTTP requests that were authorized.
47-
4840
- `authz_name`: The name of the authorization policy used to allow the
4941
request.
50-
5142
- `inbound_http_authz_deny_total`: A counter of the total number of inbound HTTP
5243
requests that could not be processed due to being denied by the authorization
5344
policy.
54-
5545
- `inbound_http_route_not_found_total`: A counter of the total number of inbound
5646
HTTP requests that could not be associated with a route.
5747

linkerd.io/content/2.17/reference/proxy-metrics.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,45 +13,35 @@ port (default: `:4191`) in the [Prometheus format][prom-format].
1313

1414
- `request_total`: A counter of the number of requests the proxy has received.
1515
This is incremented when the request stream begins.
16-
1716
- `response_total`: A counter of the number of responses the proxy has received.
1817
This is incremented when the response stream ends.
19-
2018
- `response_latency_ms`: A histogram of response latencies. This measurement
2119
reflects the [time-to-first-byte][ttfb] (TTFB) by recording the elapsed time
2220
between the proxy processing a request's headers and the first data frame of
2321
the response. If a response does not include any data, the end-of-stream event
2422
is used. The TTFB measurement is used so that Linkerd accurately reflects
2523
application behavior when a server provides response headers immediately but
2624
is slow to begin serving the response body.
27-
2825
- `route_request_total`, `route_response_latency_ms`, and
2926
`route_response_total`: These metrics are analogous to `request_total`,
3027
`response_latency_ms`, and `response_total` except that they are collected at
3128
the route level. This means that they do not have `authority`, `tls`,
3229
`grpc_status_code` or any outbound labels but instead they have:
33-
3430
- `dst`: The authority of this request.
3531
- `rt_route`: The name of the route for this request.
36-
3732
- `control_request_total`, `control_response_latency_ms`, and
3833
`control_response_total`: These metrics are analogous to `request_total`,
3934
`response_latency_ms`, and `response_total` but for requests that the proxy
4035
makes to the Linkerd control plane. Instead of `authority`, `direction`, or
4136
any outbound labels, instead they have:
42-
4337
- `addr`: The address used to connect to the control plane.
44-
4538
- `inbound_http_authz_allow_total`: A counter of the total number of inbound
4639
HTTP requests that were authorized.
47-
4840
- `authz_name`: The name of the authorization policy used to allow the
4941
request.
50-
5142
- `inbound_http_authz_deny_total`: A counter of the total number of inbound HTTP
5243
requests that could not be processed due to being denied by the authorization
5344
policy.
54-
5545
- `inbound_http_route_not_found_total`: A counter of the total number of inbound
5646
HTTP requests that could not be associated with a route.
5747

0 commit comments

Comments
 (0)