You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fixes DOC-13184
Summary of changes:
- Add a mention of the `storage.wal.failover.write_and_sync.latency`
metric to the `wal-failover-metrics.md` include file, which will pull
it into the 'WAL failover' and 'cockroach start' pages.
- We're also doing a cockroachdb/cockroach PR to mark this metric as
'essential', so it shows up in the list of Storage essential metrics
at e.g.
https://www.cockroachlabs.com/docs/v25.3/essential-metrics-self-hosted.html#storage
Copy file name to clipboardExpand all lines: src/current/_includes/v25.4/wal-failover-metrics.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,14 @@ You can monitor WAL failover occurrences using the following metrics:
3
3
-`storage.wal.failover.secondary.duration`: Cumulative time spent (in nanoseconds) writing to the secondary WAL directory. Only populated when WAL failover is configured.
4
4
-`storage.wal.failover.primary.duration`: Cumulative time spent (in nanoseconds) writing to the primary WAL directory. Only populated when WAL failover is configured.
5
5
-`storage.wal.failover.switch.count`: Count of the number of times WAL writing has switched from primary to secondary store, and vice versa.
6
+
-`storage.wal.fsync.latency` monitors the latencies of WAL files. If you have WAL failover enabled and are failing over, `storage.wal.fsync.latency` will include the latency of the stalled primary.
7
+
-`storage.wal.failover.write_and_sync.latency` metric is up one level from `storage.wal.fsync.latency`, and during the failover will report the latency actually observed by higher levels (which should be ~equivalent to the latency of the secondary).
6
8
7
9
The `storage.wal.failover.secondary.duration` is the primary metric to monitor. You should expect this metric to be `0` unless a WAL failover occurs. If a WAL failover occurs, the rate at which it increases provides an indication of the health of the primary store.
8
10
9
11
You can access these metrics via the following methods:
10
12
11
13
- The [**Custom Chart** debug page]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}) in [DB Console]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}).
12
14
- By [monitoring CockroachDB with Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}).
15
+
16
+
For more information, refer to [Essential storage metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %}#storage)
0 commit comments