Merge pull request #36 from lpgauth/parse_transform

Add parse transform to pre-compute packet (best effort)

.travis.yml

@@ -15,7 +15,7 @@ language: erlang
 notifications:
   email: false
 otp_release:
+  - 19.1
   - 18.3
-  - 17.5
 script: "make travis"
 sudo: false

README.md

@@ -12,6 +12,7 @@ High Performance Erlang StatsD Client
 ### Features
 
 * Performance optimized
+* Parse transform
 
 ## API
 <a href="https://github.com/lpgauth/statsderl/blob/master/doc/statsderl.md#index" class="module">Function Index</a>
@@ -74,6 +75,13 @@ High Performance Erlang StatsD Client
   </tr>
 </table>
 
+## Parse Transform
+
+`statsderl_transform` is used to pre-compute (at compile time) the scaled sample rate and `StatsD` packet.
+
+```erlang
+-compile({parse_transform, statsderl_transform}).
+```
 ## Examples
 
 ```erlang
@@ -120,10 +128,6 @@ ok.
 make test
 ```
 
-### TODOs
-
-* parse transform for type conversion
-
 ## License
 
 ```license

doc/edoc-info

@@ -1,4 +1,5 @@
 %% encoding: UTF-8
 {application,statsderl}.
-{modules,[statsderl,statsderl_app,statsderl_protocol,statsderl_server,
-          statsderl_sup,statsderl_udp,statsderl_utils]}.
+{modules,[statsderl,statsderl_app,statsderl_pool,statsderl_protocol,
+          statsderl_server,statsderl_sup,statsderl_transform,statsderl_udp,
+          statsderl_utils]}.

doc/statsderl.md

@@ -56,7 +56,7 @@ value() = number()
 ### counter/3 ###
 
 <pre><code>
-counter(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+counter(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 
@@ -65,7 +65,7 @@ counter(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()
 ### decrement/3 ###
 
 <pre><code>
-decrement(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+decrement(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 
@@ -74,7 +74,7 @@ decrement(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value
 ### gauge/3 ###
 
 <pre><code>
-gauge(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+gauge(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 
@@ -83,7 +83,7 @@ gauge(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</
 ### gauge_decrement/3 ###
 
 <pre><code>
-gauge_decrement(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+gauge_decrement(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 
@@ -92,7 +92,7 @@ gauge_decrement(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value"
 ### gauge_increment/3 ###
 
 <pre><code>
-gauge_increment(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+gauge_increment(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 
@@ -101,7 +101,7 @@ gauge_increment(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value"
 ### increment/3 ###
 
 <pre><code>
-increment(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+increment(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 
@@ -110,7 +110,7 @@ increment(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value
 ### timing/3 ###
 
 <pre><code>
-timing(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+timing(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 
@@ -119,7 +119,7 @@ timing(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()<
 ### timing_fun/3 ###
 
 <pre><code>
-timing_fun(Key::<a href="#type-key">key()</a>, Fun::function(), SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+timing_fun(Key::<a href="#type-key">key()</a>, Fun::function(), Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 
@@ -128,7 +128,7 @@ timing_fun(Key::<a href="#type-key">key()</a>, Fun::function(), SampleRate::<a h
 ### timing_now/3 ###
 
 <pre><code>
-timing_now(Key::<a href="#type-key">key()</a>, Timestamp::<a href="erlang.md#type-timestamp">erlang:timestamp()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+timing_now(Key::<a href="#type-key">key()</a>, Timestamp::<a href="erlang.md#type-timestamp">erlang:timestamp()</a>, Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 
@@ -137,7 +137,7 @@ timing_now(Key::<a href="#type-key">key()</a>, Timestamp::<a href="erlang.md#typ
 ### timing_now_us/3 ###
 
 <pre><code>
-timing_now_us(Key::<a href="#type-key">key()</a>, Timestamp::<a href="erlang.md#type-timestamp">erlang:timestamp()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
+timing_now_us(Key::<a href="#type-key">key()</a>, Timestamp::<a href="erlang.md#type-timestamp">erlang:timestamp()</a>, Rate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; ok
 </code></pre>
 <br />
 

doc/statsderl_pool.md

@@ -0,0 +1,90 @@
+
+
+# Module statsderl_pool #
+* [Data Types](#types)
+* [Function Index](#index)
+* [Function Details](#functions)
+
+<a name="types"></a>
+
+## Data Types ##
+
+
+
+
+### <a name="type-key">key()</a> ###
+
+
+<pre><code>
+key() = iodata()
+</code></pre>
+
+
+
+
+### <a name="type-operation">operation()</a> ###
+
+
+<pre><code>
+operation() = {cast, iodata()} | {counter, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>, <a href="#type-sample_rate">sample_rate()</a>} | {gauge, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>} | {gauge_decrement, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>} | {gauge_increment, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>} | {timing, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>} | {timing_now, <a href="#type-key">key()</a>, <a href="erlang.md#type-timestamp">erlang:timestamp()</a>} | {timing_now_us, <a href="#type-key">key()</a>, <a href="erlang.md#type-timestamp">erlang:timestamp()</a>}
+</code></pre>
+
+
+
+
+### <a name="type-sample_rate">sample_rate()</a> ###
+
+
+<pre><code>
+sample_rate() = number()
+</code></pre>
+
+
+
+
+### <a name="type-value">value()</a> ###
+
+
+<pre><code>
+value() = number()
+</code></pre>
+
+<a name="index"></a>
+
+## Function Index ##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#sample-2">sample/2</a></td><td></td></tr><tr><td valign="top"><a href="#sample_scaled-2">sample_scaled/2</a></td><td></td></tr><tr><td valign="top"><a href="#server_name-1">server_name/1</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+## Function Details ##
+
+<a name="sample-2"></a>
+
+### sample/2 ###
+
+<pre><code>
+sample(Rate::<a href="#type-sample_rate">sample_rate()</a>, Operation::<a href="#type-operation">operation()</a>) -&gt; ok
+</code></pre>
+<br />
+
+<a name="sample_scaled-2"></a>
+
+### sample_scaled/2 ###
+
+<pre><code>
+sample_scaled(RateInt::non_neg_integer(), Operation::<a href="#type-operation">operation()</a>) -&gt; ok
+</code></pre>
+<br />
+
+<a name="server_name-1"></a>
+
+### server_name/1 ###
+
+<pre><code>
+server_name(X1::1..4) -&gt; atom()
+</code></pre>
+<br />
+

doc/statsderl_protocol.md

@@ -22,11 +22,11 @@ key() = iodata()
 
 
 
-### <a name="type-op_code">op_code()</a> ###
+### <a name="type-operation">operation()</a> ###
 
 
 <pre><code>
-op_code() = decrement | gauge | gauge_decrement | gauge_increment | increment | timing
+operation() = {cast, iodata()} | {counter, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>, <a href="#type-sample_rate">sample_rate()</a>} | {gauge, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>} | {gauge_decrement, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>} | {gauge_increment, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>} | {timing, <a href="#type-key">key()</a>, <a href="#type-value">value()</a>} | {timing_now, <a href="#type-key">key()</a>, <a href="erlang.md#type-timestamp">erlang:timestamp()</a>} | {timing_now_us, <a href="#type-key">key()</a>, <a href="erlang.md#type-timestamp">erlang:timestamp()</a>}
 </code></pre>
 
 
@@ -54,19 +54,19 @@ value() = number()
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#encode-4">encode/4</a></td><td></td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#encode-1">encode/1</a></td><td></td></tr></table>
 
 
 <a name="functions"></a>
 
 ## Function Details ##
 
-<a name="encode-4"></a>
+<a name="encode-1"></a>
 
-### encode/4 ###
+### encode/1 ###
 
 <pre><code>
-encode(X1::<a href="#type-op_code">op_code()</a>, Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()</a>, SampleRate::<a href="#type-sample_rate">sample_rate()</a>) -&gt; iodata()
+encode(X1::<a href="#type-operation">operation()</a>) -&gt; iodata()
 </code></pre>
 <br />
 

doc/statsderl_transform.md

@@ -0,0 +1,42 @@
+
+
+# Module statsderl_transform #
+* [Data Types](#types)
+* [Function Index](#index)
+* [Function Details](#functions)
+
+<a name="types"></a>
+
+## Data Types ##
+
+
+
+
+### <a name="type-forms">forms()</a> ###
+
+
+<pre><code>
+forms() = [<a href="erl_parse.md#type-abstract_form">erl_parse:abstract_form()</a> | <a href="erl_parse.md#type-form_info">erl_parse:form_info()</a>]
+</code></pre>
+
+<a name="index"></a>
+
+## Function Index ##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#parse_transform-2">parse_transform/2</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+## Function Details ##
+
+<a name="parse_transform-2"></a>
+
+### parse_transform/2 ###
+
+<pre><code>
+parse_transform(Forms::<a href="#type-forms">forms()</a>, Options::[<a href="compile.md#type-option">compile:option()</a>]) -&gt; <a href="#type-forms">forms()</a>
+</code></pre>
+<br />
+

doc/statsderl_udp.md

@@ -9,7 +9,7 @@
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#header-2">header/2</a></td><td></td></tr><tr><td valign="top"><a href="#send-3">send/3</a></td><td></td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#header-2">header/2</a></td><td></td></tr></table>
 
 
 <a name="functions"></a>
@@ -25,12 +25,3 @@ header(IP::<a href="inet.md#type-ip_address">inet:ip_address()</a>, Port::<a hre
 </code></pre>
 <br />
 
-<a name="send-3"></a>
-
-### send/3 ###
-
-<pre><code>
-send(Socket::<a href="inet.md#type-socket">inet:socket()</a>, Header::iodata(), Data::iodata()) -&gt; ok | {error, term()}
-</code></pre>
-<br />
-

doc/statsderl_utils.md

@@ -34,7 +34,7 @@ base_key_part() = hostname | name | sname | undefined | iodata()
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#base_key-1">base_key/1</a></td><td></td></tr><tr><td valign="top"><a href="#error_msg-2">error_msg/2</a></td><td></td></tr><tr><td valign="top"><a href="#getaddrs-1">getaddrs/1</a></td><td></td></tr><tr><td valign="top"><a href="#random-1">random/1</a></td><td></td></tr><tr><td valign="top"><a href="#random_element-1">random_element/1</a></td><td></td></tr><tr><td valign="top"><a href="#random_server-0">random_server/0</a></td><td></td></tr><tr><td valign="top"><a href="#server_name-1">server_name/1</a></td><td></td></tr><tr><td valign="top"><a href="#timestamp-0">timestamp/0</a></td><td></td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#base_key-1">base_key/1</a></td><td></td></tr><tr><td valign="top"><a href="#error_msg-2">error_msg/2</a></td><td></td></tr><tr><td valign="top"><a href="#getaddrs-1">getaddrs/1</a></td><td></td></tr><tr><td valign="top"><a href="#random_element-1">random_element/1</a></td><td></td></tr><tr><td valign="top"><a href="#timestamp-0">timestamp/0</a></td><td></td></tr><tr><td valign="top"><a href="#timing_now-1">timing_now/1</a></td><td></td></tr><tr><td valign="top"><a href="#timing_now_us-1">timing_now_us/1</a></td><td></td></tr></table>
 
 
 <a name="functions"></a>
@@ -68,15 +68,6 @@ getaddrs(Address::<a href="inet.md#type-ip_address">inet:ip_address()</a> | <a h
 </code></pre>
 <br />
 
-<a name="random-1"></a>
-
-### random/1 ###
-
-<pre><code>
-random(N::pos_integer()) -&gt; pos_integer()
-</code></pre>
-<br />
-
 <a name="random_element-1"></a>
 
 ### random_element/1 ###
@@ -86,30 +77,30 @@ random_element(List::[term()]) -&gt; term()
 </code></pre>
 <br />
 
-<a name="random_server-0"></a>
+<a name="timestamp-0"></a>
 
-### random_server/0 ###
+### timestamp/0 ###
 
 <pre><code>
-random_server() -&gt; atom()
+timestamp() -&gt; <a href="erlang.md#type-timestamp">erlang:timestamp()</a>
 </code></pre>
 <br />
 
-<a name="server_name-1"></a>
+<a name="timing_now-1"></a>
 
-### server_name/1 ###
+### timing_now/1 ###
 
 <pre><code>
-server_name(X1::pos_integer()) -&gt; atom()
+timing_now(Timestamp::<a href="erlang.md#type-timestamp">erlang:timestamp()</a>) -&gt; non_neg_integer()
 </code></pre>
 <br />
 
-<a name="timestamp-0"></a>
+<a name="timing_now_us-1"></a>
 
-### timestamp/0 ###
+### timing_now_us/1 ###
 
 <pre><code>
-timestamp() -&gt; <a href="erlang.md#type-timestamp">erlang:timestamp()</a>
+timing_now_us(Timestamp::<a href="erlang.md#type-timestamp">erlang:timestamp()</a>) -&gt; non_neg_integer()
 </code></pre>
 <br />