Skip to content

Commit 2f32686

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 2f32686

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

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)