Skip to content

Commit 84ed83f

Browse files
committed
storage: mark add'l WAL latency metric essential
This change marks the `storage.wal.failover.write_and_sync.latency` metric as "Essential" so it gets automatically pulled into the 'Essential Metrics' documentation at e.g., https://www.cockroachlabs.com/docs/stable/essential-metrics-self-hosted.html#storage This is necessary since we are adding some words about this metric to the docs via cockroachdb/docs#20566 We would like to then backport this change to all supported versions of CockroachDB which have WAL failover (i.e., v24.1 and later).
1 parent 738c039 commit 84ed83f

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

docs/generated/metrics/metrics.yaml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10551,6 +10551,16 @@ layers:
1055110551
derivative: NON_NEGATIVE_DERIVATIVE
1055210552
how_to_use: This metric reports the number of a node's LSM compactions. If the number of compactions remains elevated while the LSM health does not improve, compactions are not keeping up with the workload. If the condition persists for an extended period, the cluster will initially exhibit performance issues that will eventually escalate into stability issues.
1055310553
essential: true
10554+
- name: storage.wal.failover.write_and_sync.latency
10555+
exported_name: storage_wal_failover_write_and_sync_latency
10556+
description: The observed latency for writing and syncing to the logical Write-Ahead Log.
10557+
y_axis_label: Nanoseconds
10558+
type: HISTOGRAM
10559+
unit: NANOSECONDS
10560+
aggregation: AVG
10561+
derivative: NONE
10562+
how_to_use: Only populated when WAL failover is configured. Without WAL failover, the relevant metric is storage.wal.fsync.latency.
10563+
essential: true
1055410564
- name: storage.wal.fsync.latency
1055510565
exported_name: storage_wal_fsync_latency
1055610566
description: The fsync latency to the Write-Ahead Log device.
@@ -17352,15 +17362,6 @@ layers:
1735217362
aggregation: AVG
1735317363
derivative: NON_NEGATIVE_DERIVATIVE
1735417364
how_to_use: Only populated when WAL failover is configured. A high switch count indicates that many disk stalls were encountered.
17355-
- name: storage.wal.failover.write_and_sync.latency
17356-
exported_name: storage_wal_failover_write_and_sync_latency
17357-
description: The observed latency for writing and syncing to the logical Write-Ahead Log.
17358-
y_axis_label: Nanoseconds
17359-
type: HISTOGRAM
17360-
unit: NANOSECONDS
17361-
aggregation: AVG
17362-
derivative: NONE
17363-
how_to_use: Only populated when WAL failover is configured. Without WAL failover, the relevant metric is storage.wal.fsync.latency.
1736417365
- name: storage.write-amplification
1736517366
exported_name: storage_write_amplification
1736617367
description: |-

pkg/kv/kvserver/metrics.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2823,6 +2823,8 @@ Note that the measurement does not include the duration for replicating the eval
28232823
Name: "storage.wal.failover.write_and_sync.latency",
28242824
Help: "The observed latency for writing and syncing to the logical Write-Ahead Log.",
28252825
Measurement: "Nanoseconds",
2826+
Category: metric.Metadata_STORAGE,
2827+
Essential: true,
28262828
Unit: metric.Unit_NANOSECONDS,
28272829
HowToUse: "Only populated when WAL failover is configured. Without WAL failover, the relevant " +
28282830
"metric is storage.wal.fsync.latency.",

0 commit comments

Comments
 (0)