Skip to content

Commit

Permalink
Document custom struct tags supported
Browse files Browse the repository at this point in the history
Document the list of custom struct tags supported.
  • Loading branch information
masih committed Jun 16, 2023
1 parent 5ddf551 commit 72c5208
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
* Periodically fetches and caches FoundationDB status.
* Exposes a REST endpoint at `/status` to serve the raw JSON for further debugging.
* Supports custom struct tags to customize metric reporting using the key `fdbmeter`; see [`model`](model.go).

* `fdbmeter:"attr"` explicitly includes a `string` field as an attribute.
* Note that strings in array or map are automatically added as Prometheus metric attributes.
* `fdbmeter:"skip"` excludes a field from metric reporting or an attribute.
* `fdbmeter:"key=<custom-key>"` customizes the `key` attribute of `map` fields.
## Metrics

Below is the current list of metrics exposed by `fdbmeter`:
Expand Down

0 comments on commit 72c5208

Please sign in to comment.