Skip to content

Commit a67ff63

Browse files
authored
DOC-15352: Replace use of metrics-list.csv with metrics.yaml in metrics generated pages (#21072)
- In multi-dimensional-metrics-table.md, cockroachcloud/metrics-essential.md, and _includes/cockroachcloud/metrics-tab.md, updated to use metrics.yaml data file. - In metrics-cloud.yml, added how_to_use to 11 Request Units metrics and 4 other non-essential metrics. - In _includes/cockroachcloud/metrics-usage, deleted all files as well as directory and replaced with how_to_use in metric.yaml and metrics-cloud.yml. - Deleted metrics-list.csv. * Incorporated Mike’s feedback.
1 parent 15f1be8 commit a67ff63

File tree

67 files changed

+117
-2916
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+117
-2916
lines changed

src/current/_data/v25.4/metrics/metrics-cloud.yml

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@
9191
metric_type: "Request Units"
9292
metric_ui_tab: [ Overview, "Request Units"]
9393
metric_ui_graph: "Request Units"
94+
how_to_use: 'The CPU and I/O resources being used by queries in the cluster. Simple queries consume few RUs, while complicated queries with many reads and writes consume more RUs. To learn more about how RUs are calculated, refer to Resource Usage.'
9495

9596
- metric_id: livebytes
9697
deploy_selfhosted: true
@@ -103,6 +104,7 @@
103104
metric_type: Storage
104105
metric_ui_tab: [ Overview ]
105106
metric_ui_graph: Storage
107+
how_to_use: 'The amount of data being stored in the cluster. In the Storage Used graph, this is the logical number of live bytes and does not account for compression or replication.'
106108

107109
- metric_id: tenant.consumption.sql_pods_cpu_seconds
108110
deploy_selfhosted: false
@@ -115,6 +117,12 @@
115117
metric_type: "Request Units"
116118
metric_ui_tab: [ "Request Units" ]
117119
metric_ui_graph: "CPU"
120+
how_to_use: |
121+
The number of RUs consumed by CPU usage of SQL processes (not storage processes). The CPU seconds is converted to Request Units using this equivalency:
122+
123+
1 RU = 3 milliseconds SQL CPU.
124+
125+
Correlate this metric with Request Units (RUs) and determine if your workload is CPU-intensive. To learn more about how RUs are calculated, refer to Resource Usage.
118126
119127
- metric_id: tenant.consumption.pgwire_egress_bytes
120128
deploy_selfhosted: false
@@ -127,6 +135,12 @@
127135
metric_type: "Request Units"
128136
metric_ui_tab: [ "Request Units" ]
129137
metric_ui_graph: "Egress"
138+
how_to_use: |
139+
The number of RUs consumed by byte traffic to the client. Egress bytes are converted to Request Units using this equivalency:
140+
141+
1 RU = 1 KiB Network egress.
142+
143+
Correlate this metric with Request Units (RUs). To learn more about how RUs are calculated, refer to Resource Usage.
130144
131145
- metric_id: tenant.consumption.external_io_egress_bytes
132146
deploy_selfhosted: false
@@ -139,6 +153,12 @@
139153
metric_type: "Request Units"
140154
metric_ui_tab: [ "Request Units" ]
141155
metric_ui_graph: "Egress"
156+
how_to_use: |
157+
The number of RUs consumed by byte traffic for cluster bulk I/O operations (e.g., CDC). Egress bytes are converted to Request Units using this equivalency:
158+
159+
1 RU = 1 KiB Network egress.
160+
161+
Correlate this metric with Request Units (RUs). To learn more about how RUs are calculated, refer to Resource Usage.
142162
143163
- metric_id: tenant.consumption.read_requests
144164
deploy_selfhosted: false
@@ -151,7 +171,13 @@
151171
metric_type: "Request Units"
152172
metric_ui_tab: [ "Request Units" ]
153173
metric_ui_graph: "Reads"
154-
174+
how_to_use: |
175+
The number of RUs consumed by KV storage layer reads, broken down by requests. SQL statements are translated into lower-level KV read requests that are sent in batches. Batches may contain any number of requests. Requests can have a payload containing any number of bytes. Storage layer I/O is converted to Request Units using this equivalency:
176+
177+
1 RU = 8 storage read requests
178+
179+
Correlate this metric with Request Units (RUs). To learn more about how RUs are calculated, refer to Resource Usage.
180+
155181
- metric_id: tenant.consumption.read_batches
156182
deploy_selfhosted: false
157183
deploy_dedicated: false
@@ -163,6 +189,12 @@
163189
metric_type: "Request Units"
164190
metric_ui_tab: [ "Request Units" ]
165191
metric_ui_graph: "Reads"
192+
how_to_use: |
193+
The number of RUs consumed by KV storage layer reads, broken down by batches. SQL statements are translated into lower-level KV read requests that are sent in batches. Batches may contain any number of requests. Requests can have a payload containing any number of bytes. Storage layer I/O is converted to Request Units using this equivalency:
194+
195+
1 RU = 2 storage read batches
196+
197+
Correlate this metric with Request Units (RUs). To learn more about how RUs are calculated, refer to Resource Usage.
166198
167199
- metric_id: tenant.consumption.read_bytes
168200
deploy_selfhosted: false
@@ -175,6 +207,12 @@
175207
metric_type: "Request Units"
176208
metric_ui_tab: [ "Request Units" ]
177209
metric_ui_graph: "Reads"
210+
how_to_use: |
211+
The number of RUs consumed by KV storage layer reads, broken down by bytes. SQL statements are translated into lower-level KV read requests that are sent in batches. Batches may contain any number of requests. Requests can have a payload containing any number of bytes. Storage layer I/O is converted to Request Units using this equivalency:
212+
213+
1 RU = 64 KiB read request payload (prorated)
214+
215+
Correlate this metric with Request Units (RUs). To learn more about how RUs are calculated, refer to Resource Usage.
178216
179217
- metric_id: tenant.consumption.write_requests
180218
deploy_selfhosted: false
@@ -187,6 +225,12 @@
187225
metric_type: "Request Units"
188226
metric_ui_tab: [ "Request Units" ]
189227
metric_ui_graph: "Writes"
228+
how_to_use: |
229+
The number of RUs consumed by KV writes, broken down by requests. SQL statements are translated into lower-level KV write requests that are sent in batches. Batches may contain any number of requests. Requests can have a payload containing any number of bytes. Write operations are replicated to multiple storage processes (3 by default), with each replica counted as a separate write operation. Storage layer I/O is converted to Request Units using this equivalency:
230+
231+
1 RU = 1 storage write request
232+
233+
Correlate this metric with Request Units (RUs). To learn more about how RUs are calculated, refer to Resource Usage.
190234
191235
- metric_id: tenant.consumption.write_batches
192236
deploy_selfhosted: false
@@ -199,6 +243,12 @@
199243
metric_type: "Request Units"
200244
metric_ui_tab: [ "Request Units" ]
201245
metric_ui_graph: "Writes"
246+
how_to_use: |
247+
The number of RUs consumed by KV writes, broken down by batches. SQL statements are translated into lower-level KV write requests that are sent in batches. Batches may contain any number of requests. Requests can have a payload containing any number of bytes. Write operations are replicated to multiple storage processes (3 by default), with each replica counted as a separate write operation. Storage layer I/O is converted to Request Units using this equivalency:
248+
249+
1 RU = 1 storage write batch
250+
251+
Correlate this metric with Request Units (RUs). To learn more about how RUs are calculated, refer to Resource Usage.
202252
203253
- metric_id: tenant.consumption.write_bytes
204254
deploy_selfhosted: false
@@ -211,6 +261,12 @@
211261
metric_type: "Request Units"
212262
metric_ui_tab: [ "Request Units" ]
213263
metric_ui_graph: "Writes"
264+
how_to_use: |
265+
The number of RUs consumed by KV writes, broken down by bytes. SQL statements are translated into lower-level KV write requests that are sent in batches. Batches may contain any number of requests. Requests can have a payload containing any number of bytes. Write operations are replicated to multiple storage processes (3 by default), with each replica counted as a separate write operation. Storage layer I/O is converted to Request Units using this equivalency:
266+
267+
1 RU = 1 KiB write request payload (prorated)
268+
269+
Correlate this metric with Request Units (RUs). To learn more about how RUs are calculated, refer to Resource Usage.
214270
215271
- metric_id: tenant.consumption.cross_region_network_ru
216272
deploy_selfhosted: false
@@ -223,6 +279,7 @@
223279
metric_type: "Request Units"
224280
metric_ui_tab: [ "Request Units" ]
225281
metric_ui_graph: "Cross-region Networking"
282+
how_to_use: 'The number of RUs consumed by cross-region networking. Correlate these metrics with Request Units (RUs). For more information about multi-region clusters and networking, refer to Multi-region clusters.'
226283

227284
- metric_id: sql.conn.latency
228285
deploy_selfhosted: true
@@ -331,6 +388,7 @@
331388
metric_type: SQL
332389
metric_ui_tab: [ SQL ]
333390
metric_ui_graph: "Transaction Restarts"
391+
how_to_use: 'This metric is one measure of the impact of contention conflicts on workload performance. For guidance on contention conflicts, review transaction contention best practices and performance tuning recipes. Tens of restarts per minute may be a high value, a signal of an elevated degree of contention in the workload, which should be investigated. For the specific error, refer to the transaction retry error reference for more details.'
334392

335393
- metric_id: txn.restarts.serializable
336394
deploy_selfhosted: true
@@ -355,6 +413,7 @@
355413
metric_type: SQL
356414
metric_ui_tab: [ SQL ]
357415
metric_ui_graph: "Transaction Restarts"
416+
how_to_use: 'This metric is one measure of the impact of contention conflicts on workload performance. For guidance on contention conflicts, review transaction contention best practices and performance tuning recipes. Tens of restarts per minute may be a high value, a signal of an elevated degree of contention in the workload, which should be investigated. For the specific error, refer to the transaction retry error reference for more details.'
358417

359418
- metric_id: txn.restarts.readwithinuncertainty
360419
deploy_selfhosted: false
@@ -367,6 +426,7 @@
367426
metric_type: SQL
368427
metric_ui_tab: [ SQL ]
369428
metric_ui_graph: "Transaction Restarts"
429+
how_to_use: 'This metric is one measure of the impact of contention conflicts on workload performance. For guidance on contention conflicts, review transaction contention best practices and performance tuning recipes. Tens of restarts per minute may be a high value, a signal of an elevated degree of contention in the workload, which should be investigated. For the specific error, refer to the transaction retry error reference for more details.'
370430

371431
- metric_id: txn.restarts.txnaborted
372432
deploy_selfhosted: true

0 commit comments

Comments
 (0)