High Performance Erlang StatsD Client
Erlang Makefile
Latest commit 6c1f703 Nov 6, 2016 @lpgauth Bump version to 0.5.0
Permalink
Failed to load latest commit information.
bin
doc
include
src
test
.gitignore
.travis.yml
LICENSE
Makefile
README.md
elvis.config
rebar.config Add statsderl_transform Nov 6, 2016
rebar.config.script
rebar.lock Add statsderl_transform Nov 6, 2016

README.md

statsderl

High Performance Erlang StatsD Client

Build Status Coverage Status

Requirements

  • Erlang 16.0 +

Features

  • Performance optimized
  • Parse transform

API

Function Index

Environment variables

Name Type Default Description
base_key base_key() undefined key prefix
hostname inet:ip_address() | inet:hostname() | binary() {127,0,0,1} server hostname
port inet:port_number() 8125 server port

base_key options

Option Source Description Example
hostname inet:gethostname/0 use the hostname "h033"
name erl -name use the long node name "nonode@nohost"
sname erl -sname use the short node name "nonode"

Parse Transform

statsderl_transform is used to pre-compute (at compile time) the scaled sample rate and StatsD packet.

-compile({parse_transform, statsderl_transform}).

Examples

1> statsderl_app:start().
ok.

2> statsderl:counter(["test", $., "counter"], 1, 0.23).
ok.

3> statsderl:decrement("test.decrement", 1, 0.5).
ok.

4> statsderl:gauge([<<"test">>, $., "gauge"], 333, 1.0).
ok.

5> statsderl:gauge_decrement([<<"test.gauge_decrement">>], 15, 0.001).
ok.

6> statsderl:gauge_increment(<<"test.gauge_increment">>, 32, 1).
ok.

7> statsderl:increment(<<"test.increment">>, 1, 1).
ok.

8> statsderl:timing("test.timing", 5, 0.5).
ok.

9> statsderl:timing_fun(<<"test.timing_fun">>, fun() -> timer:sleep(100) end, 0.5).
ok.

10> Timestamp = os:timestamp().
{1448,591778,258983}

11> statsderl:timing_now("test.timing_now", Timestamp, 0.15).
ok.

12> statsderl_app:stop().
ok.

Tests

make test

License

The MIT License (MIT)

Copyright (c) 2011-2016 Louis-Philippe Gauthier

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.