Skip to content

Commit ef08fc7

Browse files
Add documentation for activator <> autoscaler connectivity metrics (#6548)
* Add documentation for activator_autoscaler_reachable metric Document the new activator_autoscaler_reachable gauge metric that indicates whether the autoscaler is reachable from the activator component (1 = reachable, 0 = not reachable). * Correcting the metric name inline with knative standards * Added a new metric * Added a new metric * Apply suggestion from @dprotaso Co-authored-by: Dave Protasowski <[email protected]> * Apply suggestion from @dprotaso Co-authored-by: Dave Protasowski <[email protected]> * Apply suggestion from @dprotaso Co-authored-by: Dave Protasowski <[email protected]> --------- Co-authored-by: Dave Protasowski <[email protected]>
1 parent 6818664 commit ef08fc7

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/versioned/serving/observability/metrics/serving-metrics.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,45 @@ Name | Type | Description
9292
`kn.configuration.name` | string | Knative Configuration name associated with this Revision
9393
`kn.revision.name` | string | The name of the Revision
9494

95+
### `kn.activator.stats.conn.reachable`
96+
97+
**Instrument Type:** Int64Gauge
98+
99+
**Unit ([UCUM](https://ucum.org)):** {reachable}
100+
101+
**Description:** Whether a peer is reachable from the activator (1 = reachable, 0 = not reachable)
102+
103+
The following attributes are included with the metric
104+
105+
Name | Type | Description
106+
-|-|-
107+
`peer` | string | The peer service the activator is connecting to (e.g., `autoscaler`)
108+
109+
This metric helps operators identify connectivity issues between the activator and its peer components. The metric is recorded:
110+
111+
- When a connection is established (value = 1)
112+
- When a connection is lost (value = 0)
113+
114+
### `kn.activator.stats.conn.errors`
115+
116+
**Instrument Type:** Int64Counter
117+
118+
**Unit ([UCUM](https://ucum.org)):** {error}
119+
120+
**Description:** Number of connection errors from the activator
121+
122+
The following attributes are included with the metric
123+
124+
Name | Type | Description
125+
-|-|-
126+
`peer` | string | The peer service the activator is connecting to (e.g., `autoscaler`)
127+
128+
This counter increments each time the activator fails to communicate with a peer. It complements the `kn.activator.stats.conn.reachable` gauge by providing a cumulative count of errors, which is useful for:
129+
130+
- Detecting flaky connections that might be missed by point-in-time gauge sampling
131+
- Creating rate-based alerts (e.g., alert if error rate exceeds threshold over 5 minutes)
132+
- Tracking connection stability trends over time
133+
95134
### HTTP metrics
96135

97136
Since the activator receives and forwards requests to the user workload it has both HTTP server and client metrics.

0 commit comments

Comments
 (0)