+[![Build Status](https://travis-ci.org/ibnfirnas/beam_stats.svg?branch=master)](https://travis-ci.org/ibnfirnas/beam_stats)
+
beam_stats
==========
-Periodically collects and pushes VM metrics to arbitrary consumers (Graphite
-and CSV by default).
+Periodically collects and pushes VM metrics to arbitrary consumers. Defaults to
+StatsD (`beam_stats_consumer_statsd`) and includes off-by-default
+implementations for Graphite (`beam_stats_consumer_graphite`) and CSV file
+(`beam_stats_consumer_csv`) consumers).
Essentially like `folsomite`, but better. Better in the following ways:
conversions, as opposed to the nearly-arbitrary term-to-string conversions
used in `folsomite`
- Spec'd, tested and Dialyzed
+
+#### Configure consumers
+
+```erlang
+{env,
+ [ {production_interval , 30000}
+ , {consumers,
+ [ {beam_stats_consumer_statsd,
+ [ {consumption_interval , 60000}
+ , {dst_host , "localhost"}
+ , {dst_port , 8125}
+ , {src_port , 8124}
+ ]}
+ , {beam_stats_consumer_graphite,
+ [ {consumption_interval , 60000}
+ , {host , "localhost"}
+ , {port , 2003}
+ , {timeout , 5000}
+ ]}
+ , {beam_stats_consumer_csv,
+ [ {consumption_interval , 60000}
+ , {path , "beam_stats.csv"}
+ ]}
+
+ , {some_custom_consumer_module,
+ [ {foo, "abc"}
+ , {bar, 123}
+ ]}
+
+ ]}
+ ]}
+```