X-Git-Url: https://git.xandkar.net/?a=blobdiff_plain;f=README.md;h=783ed08f2bac096cfa2b508dccedbd933b31eef3;hb=010bff4874ddc0eee49d65edd03bcfbe0a702198;hp=aba81ede12da8306dffd7074c80e3785bb6fd4ac;hpb=ef2b90d72ab3f226ffc9d71acea77d6e9597b2a5;p=beam_stats.git diff --git a/README.md b/README.md index aba81ed..783ed08 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,9 @@ Essentially like `folsomite`, but different. Different in the following ways: nearly-arbitrary term-to-string conversions used in `folsomite` + Spec'd, tested and Dialyzed -#### Configure consumers +### Adding consumers + +#### At app config time ```erlang {env, @@ -33,6 +35,11 @@ Essentially like `folsomite`, but different. Different in the following ways: , {dst_host , "localhost"} , {dst_port , 8125} , {src_port , 8124} + , {num_msgs_per_packet , 10} + + % If you want to name your node something other than what + % erlang:node() returns: + , {static_node_name , <<"unicorn_at_rainbow">>} ]} , {beam_stats_consumer_graphite, [ {consumption_interval , 60000} @@ -52,3 +59,13 @@ Essentially like `folsomite`, but different. Different in the following ways: ]} ]} ``` + +#### Dynamically + +```erlang +beam_stats_consumer:add(consumer_module, ConsumerOptions). +``` + +### Removing consumers + +Not yet implemented.