Skip to content

Commit 7cb8dd6

Browse files
authored
docs: Fillout metrics section of our WAL docs (#15809)
**What this PR does / why we need it**: Add a new `metrics` section to our WAL docs.
1 parent e637ee7 commit 7cb8dd6

File tree

1 file changed

+8
-1
lines changed
  • docs/sources/operations/storage

1 file changed

+8
-1
lines changed

‎docs/sources/operations/storage/wal.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ The WAL also includes a backpressure mechanism to allow a large WAL to be replay
3636

3737
### Metrics
3838

39+
The following metrics are available for monitoring the WAL:
40+
41+
* `loki_ingester_wal_corruptions_total`: Total number of WAL corruptions encountered
42+
* `loki_ingester_wal_disk_full_failures_total`: Total number of disk full failures
43+
* `loki_ingester_wal_records_logged`: Counter for WAL records logged
44+
* `loki_ingester_wal_logged_bytes_total`: Total bytes written to WAL
45+
3946
## Changes to deployment
4047

4148
1. Since ingesters need to have the same persistent volume across restarts/rollout, all the ingesters should be run on [StatefulSet](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/) with fixed volumes.
@@ -120,4 +127,4 @@ By following the above steps, you can ensure a smooth scaling down process for t
120127

121128
* When the ingester restarts for any reason (upgrade, crash, etc), it should be able to attach to the same volume in order to recover back the WAL and tokens.
122129
* 2 ingesters should not be working with the same volume/directory for the WAL.
123-
* A Rollout should bring down an ingester completely and then start the new ingester, not the other way around.
130+
* A rollout should bring down an ingester completely and then start the new ingester, not the other way around.

0 commit comments

Comments
 (0)