Skip to content

Commit

Permalink
Update README with info on reserved labels and :all aggregation
Browse files Browse the repository at this point in the history
Signed-off-by: Chris Sinjakli <[email protected]>
  • Loading branch information
Chris Sinjakli committed Jun 12, 2019
1 parent b0a49cd commit e66ab1b
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,15 @@ class MyComponent
end
```

### Reserved labels

The following labels are reserved by the client library, and attempting to use them in a
metric definition will result in a
`Prometheus::Client::LabelSetValidator::ReservedLabelError` being raised:

- `:job`
- `:instance`
- `:pid`

## Data Stores

Expand Down Expand Up @@ -362,7 +371,8 @@ summing the values of each process.

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

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

0 comments on commit e66ab1b

Please sign in to comment.