erlang-metrics-2.5.0/ 0000755 0001750 0001750 00000000000 13346161244 013416 5 ustar james james erlang-metrics-2.5.0/README.md 0000644 0001750 0001750 00000005244 13346161244 014702 0 ustar james james # 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 |