Skip to content

Commit eb45d60

Browse files
dprotasodprotaso
authored
OTel docs follow up (#6360)
* include UCUM link * address Evan's OTel Docs feedback * include autoscaler attributes
1 parent b936c72 commit eb45d60

File tree

2 files changed

+35
-26
lines changed

2 files changed

+35
-26
lines changed

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

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ requests and user-container behavior.
2222

2323
**Instrument Type:** Int64Gauge
2424

25-
**Unit (UCUM):** {item}
25+
**Unit ([UCUM](https://ucum.org)):** {request}
2626

2727
**Description:** Number of current items in the queue proxy queue
2828

2929
### `kn.queueproxy.app.duration`
3030

3131
**Instrument Type:** Float64Histogram
3232

33-
**Unit (UCUM):** s
33+
**Unit ([UCUM](https://ucum.org)):** s
3434

3535
**Description:** The duration of the task execution
3636

@@ -43,11 +43,11 @@ The following metrics can help you to understand how an application responds whe
4343

4444
**Instrument Type:** Float64Gauge
4545

46-
**Unit (UCUM):** {request}
46+
**Unit ([UCUM](https://ucum.org)):** {request}
4747

4848
**Description:** Concurrent requests that are routed to the Activator
4949

50-
The following attributes are included with the metrics below
50+
The following attributes are included with the metric
5151

5252
Name | Type | Description
5353
-|-|-
@@ -60,108 +60,117 @@ Name | Type | Description
6060

6161
Autoscaler component exposes a number of metrics related to its decisions per revision. For example, at any given time, you can monitor the desired pods the Autoscaler wants to allocate for a Service, the average number of requests per second during the stable window, or whether autoscaler is in panic mode (KPA).
6262

63+
The following attributes are included with the autoscaling metrics below
64+
65+
Name | Type | Description
66+
-|-|-
67+
`k8s.namespace.name` | string | Namespace of the Revision
68+
`kn.service.name` | string | Knative Service name associated with this Revision
69+
`kn.configuration.name` | string | Knative Configuration name associated with this Revision
70+
`kn.revision.name` | string | The name of the Revision
71+
72+
6373
### `kn.autoscaler.scrape.duration`
6474

6575
**Instrument Type:** Float64Histogram
6676

67-
**Unit (UCUM):** s
77+
**Unit ([UCUM](https://ucum.org)):** s
6878

6979
**Description:** The duration of scraping the revision
7080

7181
### `kn.revision.pods.desired`
7282

7383
**Instrument Type:** Int64Gauge
7484

75-
**Unit (UCUM):** {item}
85+
**Unit ([UCUM](https://ucum.org)):** {pod}
7686

7787
**Description:** Number of pods the autoscaler wants to allocate
7888

7989
### `kn.revision.capacity.excess`
8090

8191
**Instrument Type:** Float64Gauge
8292

83-
**Unit (UCUM):** {concurrency}
93+
**Unit ([UCUM](https://ucum.org)):** {concurrency}
8494

8595
**Description:** Excess burst capacity observed over the stable window
8696

8797
### `kn.revision.concurrency.stable`
8898

8999
**Instrument Type:** Float64Gauge
90100

91-
**Unit (UCUM):** {concurrency}
101+
**Unit ([UCUM](https://ucum.org)):** {concurrency}
92102

93103
**Description:** Average of request count per observed pod over the stable window
94104

95105
### `kn.revision.concurrency.panic`
96106

97107
**Instrument Type:** Float64Gauge
98108

99-
**Unit (UCUM):** {concurrency}
109+
**Unit ([UCUM](https://ucum.org)):** {concurrency}
100110

101111
**Description:** Average of request count per observed pod over the panic window
102112

103113
### `kn.revision.concurrency.target`
104114

105115
**Instrument Type:** Float64Gauge
106116

107-
**Unit (UCUM):** {concurrency}
117+
**Unit ([UCUM](https://ucum.org)):** {concurrency}
108118

109119
**Description:** The desired concurrent requests for each pod
110120

111121
### `kn.revision.rps.stable`
112122

113123
**Instrument Type:** Float64Gauge
114124

115-
**Unit (UCUM):** {request}/s
125+
**Unit ([UCUM](https://ucum.org)):** {request}/s
116126

117127
**Description:** Average of requests-per-second per observed pod over the stable window
118128

119129
### `kn.revision.rps.panic`
120130

121131
**Instrument Type:** Float64Gauge
122132

123-
**Unit (UCUM):** {request}/s
133+
**Unit ([UCUM](https://ucum.org)):** {request}/s
124134

125135
**Description:** Average of requests-per-second per observed pod over the panic window
126136

127-
128137
### `kn.revision.pods.requested`
129138

130139
**Instrument Type:** Int64Gauge
131140

132-
**Unit (UCUM):** {pod}
141+
**Unit ([UCUM](https://ucum.org)):** {pod}
133142

134143
**Description:** Number of pods autoscaler requested from Kubernetes
135144

136145
### `kn.revision.pods.count`
137146

138147
**Instrument Type:** Int64Gauge
139148

140-
**Unit (UCUM):** {pod}
149+
**Unit ([UCUM](https://ucum.org)):** {pod}
141150

142151
**Description:** Number of pods that are allocated currently
143152

144153
### `kn.revision.pods.not_ready.count`
145154

146155
**Instrument Type:** Int64Gauge
147156

148-
**Unit (UCUM):** {pod}
157+
**Unit ([UCUM](https://ucum.org)):** {pod}
149158

150159
**Description:** Number of pods that are not ready currently
151160

152161
### `kn.revision.pods.pending.count`
153162

154163
**Instrument Type:** Int64Gauge
155164

156-
**Unit (UCUM):** {pod}
165+
**Unit ([UCUM](https://ucum.org)):** {pod}
157166

158167
**Description:** Number of pods that are pending currently
159168

160169
### `kn.revision.pods.terminating.count`
161170

162171
**Instrument Type:** Int64Gauge
163172

164-
**Unit (UCUM):** {pod}
173+
**Unit ([UCUM](https://ucum.org)):** {pod}
165174

166175
**Description:** Number of pods that are terminating currently
167176

‎docs/snippets/observability-shared-metrics.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Name | Type | Description | Examples
2525

2626
**Instrument Type:** Histogram
2727

28-
**Unit (UCUM):** s
28+
**Unit ([[UCUM](https://ucum.org)):** s
2929

3030
**Description:** The duration of task execution.
3131

@@ -55,55 +55,55 @@ Name | Type | Description |
5555

5656
**Instrument Type:** Int64UpDownCounter
5757

58-
**Unit (UCUM):** {item}
58+
**Unit ([UCUM](https://ucum.org)):** {item}
5959

6060
**Description:** Number of current items in the queue
6161

6262
### `kn.workqueue.adds`
6363

6464
**Instrument Type:** Int64Counter
6565

66-
**Unit (UCUM):** {item}
66+
**Unit ([UCUM](https://ucum.org)):** {item}
6767

6868
**Description:** Number of items added to the queue
6969

7070
### `kn.workqueue.queue.duration`
7171

7272
**Instrument Type:**
7373

74-
**Unit (UCUM):** s
74+
**Unit ([UCUM](https://ucum.org)):** s
7575

7676
**Description:** How long an item stays in workqueue
7777

7878
### `kn.workqueue.process.duration`
7979

8080
**Instrument Type:** Float64Histogram
8181

82-
**Unit (UCUM):** s
82+
**Unit ([UCUM](https://ucum.org)):** s
8383

8484
**Description:** How long in seconds processing an item from workqueue takes
8585

8686
### `kn.workqueue.unfinished_work`
8787

8888
**Instrument Type:** Float64Gauge
8989

90-
**Unit (UCUM):** s
90+
**Unit ([UCUM](https://ucum.org)):** s
9191

9292
**Description:** How many seconds of work the reconciler has done that is in progress and hasn't been observed by duration. Large values indicate stuck threads. One can deduce the number of stuck threads by observing the rate at which this increases.
9393

9494
### `kn.workqueue.longest_running_processor`
9595

9696
**Instrument Type:** Float64Gauge
9797

98-
**Unit (UCUM):** s
98+
**Unit ([UCUM](https://ucum.org)):** s
9999

100100
**Description:** How long the longest worker thread has been running
101101

102102
### `kn.workqueue.retries`
103103

104104
**Instrument Type:** Int64Counter
105105

106-
**Unit (UCUM):** {item}
106+
**Unit ([UCUM](https://ucum.org)):** {item}
107107

108108
**Description:** Number of items re-added to the queue
109109

0 commit comments

Comments
 (0)