README.md

### Folsomite

[![Hex pm](http://img.shields.io/hexpm/v/folsomite.svg?style=flat)](https://hex.pm/packages/folsomite)

[Folsom][1] is an Erlang based metrics system inspired by Coda Hale's
metrics (https://github.com/codahale/metrics/).

[Graphite][2] is a realtime graphing system.

Folsomite runs in your Erlang virtual machine, periodically aggregates
all present Folsom metrics and forwards them to Graphite.

[1]: https://github.com/boundary/folsom
[2]: http://graphite.wikidot.com/

#### Building and running

Any version of erlang suitable to run Folsom should be supported. Use
rebar to build like:

```shell
    rebar3 compile
```

#### Example config

```erlang
    {application, my_app,
     [{description, "my_app"},
      {vsn, git},
      {registered, []},
      {applications, [kernel,
                      stdlib,
                      folsomite]},
      {mod, []},
      {env,
       [{folsom, [{counter, [{my_app, my_counter}, {my_app, my_counter2}]},
                  {gauge, [my_gauge]},
                  {histogram, [{my_app, my_histo}, slide_uniform, {60, 1028}]}
                 ]}
        {folsomite,
         [{graphite_host, "graphite.example.com"},
          {node_key, "billing-prod-us-east-1"}
         ]}
       ]}
     ]}.
```