Skip to content

Commit faa7e89

Browse files
author
Chris Sinjakli
committed
Update README with info on reserved labels and :all aggregation
1 parent b0a49cd commit faa7e89

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,15 @@ class MyComponent
256256
end
257257
```
258258

259+
### Reserved labels
260+
261+
The following labels are reserved by the client library, and attempting to use them in a
262+
metric definition will result in a
263+
`Prometheus::Client::LabelSetValidator::ReservedLabelError` being raised:
264+
265+
- `:job`
266+
- `:instance`
267+
- `:pid`
259268

260269
## Data Stores
261270

@@ -362,7 +371,8 @@ summing the values of each process.
362371

363372
For Gauges, however, this may not be the right thing to do, depending on what they're
364373
measuring. You might want to take the maximum or minimum value observed in any process,
365-
rather than the sum of all of them.
374+
rather than the sum of all of them. You may also want to export each process's individual
375+
value.
366376

367377
In those cases, you should use the `store_settings` parameter when registering the
368378
metric, to specify an `:aggregation` setting.

0 commit comments

Comments
 (0)