Skip to content

Commit 2525d2e

Browse files
committed
docs: update prometheus docs with metrics labels
1 parent 82e6ce6 commit 2525d2e

1 file changed

Lines changed: 40 additions & 9 deletions

File tree

docs/content/docs/plugins/prometheus.md

Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,39 +61,70 @@ This may be a good practice if you have a lot of keys, because [high cardinality
6161

6262
## Exposed metrics
6363

64-
Every metric is prefixed with the `prefix` option.
64+
Every metric is prefixed with the `prefix` option (default: `bentocache`).
6565

6666
### `graced_hits`
6767

68-
The number of [graced values](../grace_periods.md) that were returned from the cache.
68+
Counter. The number of [graced values](../grace_periods.md) that were returned from the cache.
69+
70+
| Label | Description |
71+
| ------- | ------------------------------------------------------ |
72+
| `store` | The name of the cache store |
73+
| `key` | The cache key (or grouped key if using `keyGroups`) |
74+
| `layer` | The cache layer that returned the value (`l1` or `l2`) |
6975

7076
### `hits`
7177

72-
The number of cache hits.
78+
Counter. The number of cache hits.
79+
80+
| Label | Description |
81+
| ------- | ------------------------------------------------------ |
82+
| `store` | The name of the cache store |
83+
| `key` | The cache key (or grouped key if using `keyGroups`) |
84+
| `layer` | The cache layer that returned the value (`l1` or `l2`) |
7385

7486
### `misses`
7587

76-
The number of cache misses.
88+
Counter. The number of cache misses.
89+
90+
| Label | Description |
91+
| ------- | --------------------------------------------------- |
92+
| `store` | The name of the cache store |
93+
| `key` | The cache key (or grouped key if using `keyGroups`) |
7794

7895
### `writes`
7996

80-
The number of cache writes.
97+
Counter. The number of cache writes.
98+
99+
| Label | Description |
100+
| ------- | --------------------------------------------------- |
101+
| `store` | The name of the cache store |
102+
| `key` | The cache key (or grouped key if using `keyGroups`) |
81103

82104
### `deletes`
83105

84-
The number of cache deletes.
106+
Counter. The number of cache deletes.
107+
108+
| Label | Description |
109+
| ------- | --------------------------------------------------- |
110+
| `store` | The name of the cache store |
111+
| `key` | The cache key (or grouped key if using `keyGroups`) |
85112

86113
### `clears`
87114

88-
The number of cache clears.
115+
Counter. The number of cache clears.
116+
117+
| Label | Description |
118+
| ------- | --------------------------- |
119+
| `store` | The name of the cache store |
89120

90121
### `bus_messages_published`
91122

92-
The number of messages published to the bus.
123+
Counter. The number of messages published to the bus. No labels.
93124

94125
### `bus_messages_received`
95126

96-
The number of messages received from the bus.
127+
Counter. The number of messages received from the bus. No labels.
97128

98129
## Grafana dashboard
99130

0 commit comments

Comments
 (0)