Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benoitc/erlang-metrics
A generic interface to different metrics systems in Erlang.
https://github.com/benoitc/erlang-metrics
Last synced: 13 days ago
JSON representation
A generic interface to different metrics systems in Erlang.
- Host: GitHub
- URL: https://github.com/benoitc/erlang-metrics
- Owner: benoitc
- License: other
- Created: 2015-12-06T22:25:58.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-12T09:56:17.000Z (about 6 years ago)
- Last Synced: 2024-10-10T23:38:11.843Z (29 days ago)
- Language: Erlang
- Size: 716 KB
- Stars: 71
- Watchers: 10
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Erlang - A generic interface to different metrics systems in Erlang. (Instrumenting / Monitoring)
- fucking-awesome-elixir - erlang-metrics - A generic interface to different metrics systems in Erlang. (Instrumenting / Monitoring)
- awesome-beam-monitoring - `metrics` - generic interface to to a different metrics systems in Erlang (Metrics)
- awesome-elixir - erlang-metrics - A generic interface to different metrics systems in Erlang. (Instrumenting / Monitoring)
README
# metrics: A generic interface to different metrics systems in Erlang. #
Copyright (c) 2017-2018 Benoît Chesneau.
__Version:__ 2.5.0
# metrics
A generic interface to folsom, exometer, grapherl or any compliant interface. This
application has been extracted from
[hackney](https://github.com/benoitc/hackney).
Currently supported backend are:
- [Folsom](https://github.com/folsom-project/folsom): `metrics_folsom`
- [Exometer](https://github.com/Feuerlabs/exometer): `metrics_exometer`
> If you need the support for another backend, please [open a ticket](https://github.com/benoitc/erlang-metrics/issues).
[](https://hex.pm/packages/metrics)
## Usage
### Set a backend
The backend can be set in the application environment using the `metrics_mod` setting or using `metrics:backend/1`.
### register a new metric:
```
metrics:new(counter, "c").
```
Depending on the backend the following metrics types can be passed: counter | histogram | gauge | meter | spiral
### update a metric
A counter can simply be incremented by 1 using `metrics:update/1`. or by passing a positive or negative integer like this:
```
metrics:update("c", {c, 1}).
```
Other metrics are updated via `metrics:update/2`.
## Example:
```erlang
1> application:ensure_all_started(metrics).
{ok,[metrics]}
2> application:ensure_all_started(folsom).
{ok,[bear,folsom]}
3> metrics:backend(metrics_folsom).
ok
4> metrics:new(counter, "c").
ok
5> metrics:update("c").
ok
6> folsom_metrics:get_metric_value("c").
1
7> metrics:update("c", {c, 1}).
ok
8> folsom_metrics:get_metric_value("c").
2
```
## Documentation
Full doc is available in the [`metrics`](http://github.com/benoitc/erlang-metrics/blob/master/doc/metrics.md) module.
## Build
```
$ rebar3 compile
```
## Modules ##
metrics
metrics_exometer
metrics_folsom
metrics_noop
metrics_process_tracker
metrics_sup