sync the doc

Author: benoitc

README.md

@@ -4,7 +4,7 @@
 
 Copyright (c) 2016 Benoît Chesneau.
 
-__Version:__ 2.0.1
+__Version:__ 2.1.0
 
 # metrics
 

doc/README.md

@@ -4,7 +4,7 @@
 
 Copyright (c) 2016 Benoît Chesneau.
 
-__Version:__ 2.0.1
+__Version:__ 2.1.0
 
 # metrics
 

doc/metrics.md

@@ -56,7 +56,7 @@ value() = any()
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#backend-0">backend/0</a></td><td>retrieve the current backend name.</td></tr><tr><td valign="top"><a href="#backend-1">backend/1</a></td><td>set the backend to use.</td></tr><tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td></td></tr><tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr><tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr><tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr><tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr><tr><td valign="top"><a href="#new-2">new/2</a></td><td> initialise a metric.</td></tr><tr><td valign="top"><a href="#start-2">start/2</a></td><td></td></tr><tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td></td></tr><tr><td valign="top"><a href="#stop-1">stop/1</a></td><td></td></tr><tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr><tr><td valign="top"><a href="#update-1">update/1</a></td><td>increment a counter with 1.</td></tr><tr><td valign="top"><a href="#update-2">update/2</a></td><td>update a metric.</td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#backend-0">backend/0</a></td><td>retrieve the current backend name.</td></tr><tr><td valign="top"><a href="#backend-1">backend/1</a></td><td>set the backend to use.</td></tr><tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td></td></tr><tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr><tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr><tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr><tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr><tr><td valign="top"><a href="#new-2">new/2</a></td><td> initialise a metric.</td></tr><tr><td valign="top"><a href="#start-2">start/2</a></td><td></td></tr><tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td></td></tr><tr><td valign="top"><a href="#stop-1">stop/1</a></td><td></td></tr><tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr><tr><td valign="top"><a href="#update-1">update/1</a></td><td>increment a counter with 1.</td></tr><tr><td valign="top"><a href="#update-2">update/2</a></td><td>update a metric.</td></tr><tr><td valign="top"><a href="#update_or_create-3">update_or_create/3</a></td><td>update a metric and create it if it doesn't exists.</td></tr></table>
 
 
 <a name="functions"></a>
@@ -199,3 +199,14 @@ update(Name::list(), Probe::<a href="#type-probe">probe()</a>) -&gt; ok | any()
 
 update a metric
 
+<a name="update_or_create-3"></a>
+
+### update_or_create/3 ###
+
+<pre><code>
+update_or_create(Name::list(), Probe::<a href="#type-probe">probe()</a>, Type::<a href="#type-metric">metric()</a>) -&gt; ok | any()
+</code></pre>
+<br />
+
+update a metric and create it if it doesn't exists
+

doc/metrics_exometer.md

@@ -12,7 +12,7 @@ exometer backend.
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#new-3">new/3</a></td><td></td></tr><tr><td valign="top"><a href="#update-3">update/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="#new-3">new/3</a></td><td></td></tr><tr><td valign="top"><a href="#update-3">update/3</a></td><td></td></tr><tr><td valign="top"><a href="#update_or_create-4">update_or_create/4</a></td><td></td></tr></table>
 
 
 <a name="functions"></a>
@@ -34,3 +34,9 @@ new(X1::atom(), Name::any(), Config::#{}) -&gt; ok | {error, metric_exists | uns
 
 `update(Name, Val, Config) -> any()`
 
+<a name="update_or_create-4"></a>
+
+### update_or_create/4 ###
+
+`update_or_create(Name, Val, Type, Config) -> any()`
+

doc/metrics_folsom.md

@@ -12,7 +12,7 @@ folsom backend.
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#new-3">new/3</a></td><td></td></tr><tr><td valign="top"><a href="#update-3">update/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="#new-3">new/3</a></td><td></td></tr><tr><td valign="top"><a href="#update-3">update/3</a></td><td></td></tr><tr><td valign="top"><a href="#update_or_create-4">update_or_create/4</a></td><td></td></tr></table>
 
 
 <a name="functions"></a>
@@ -34,3 +34,9 @@ new(X1::atom(), Name::any(), Config::#{}) -&gt; ok | {error, term()}
 
 `update(Name, Val, Config) -> any()`
 
+<a name="update_or_create-4"></a>
+
+### update_or_create/4 ###
+
+`update_or_create(Name, Probe, Type, Config) -> any()`
+

doc/metrics_grapherl.md

@@ -20,7 +20,7 @@ This backend can be set via the barrel_metrics env:
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#init-0">init/0</a></td><td></td></tr><tr><td valign="top"><a href="#new-3">new/3</a></td><td></td></tr><tr><td valign="top"><a href="#send_metrics-3">send_metrics/3</a></td><td></td></tr><tr><td valign="top"><a href="#update-3">update/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="#init-0">init/0</a></td><td></td></tr><tr><td valign="top"><a href="#new-3">new/3</a></td><td></td></tr><tr><td valign="top"><a href="#send_metrics-3">send_metrics/3</a></td><td></td></tr><tr><td valign="top"><a href="#update-3">update/3</a></td><td></td></tr><tr><td valign="top"><a href="#update_or_create-4">update_or_create/4</a></td><td></td></tr></table>
 
 
 <a name="functions"></a>
@@ -51,3 +51,9 @@ This backend can be set via the barrel_metrics env:
 
 `update(Name, Probe, Config) -> any()`
 
+<a name="update_or_create-4"></a>
+
+### update_or_create/4 ###
+
+`update_or_create(Name, Probe, Type, Config) -> any()`
+

doc/metrics_noop.md

@@ -12,7 +12,7 @@ noop backend.
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#new-3">new/3</a></td><td></td></tr><tr><td valign="top"><a href="#update-3">update/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="#new-3">new/3</a></td><td></td></tr><tr><td valign="top"><a href="#update-3">update/3</a></td><td></td></tr><tr><td valign="top"><a href="#update_or_create-4">update_or_create/4</a></td><td></td></tr></table>
 
 
 <a name="functions"></a>
@@ -31,3 +31,9 @@ noop backend.
 
 `update(Name, Probe, Config) -> any()`
 
+<a name="update_or_create-4"></a>
+
+### update_or_create/4 ###
+
+`update_or_create(Name, Probe, Type, Config) -> any()`
+