Skip to content

Commit a9294ae

Browse files
committed
sync the doc
1 parent 32eea5e commit a9294ae

File tree

7 files changed

+42
-7
lines changed

7 files changed

+42
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Copyright (c) 2016 Benoît Chesneau.
66

7-
__Version:__ 2.0.1
7+
__Version:__ 2.1.0
88

99
# metrics
1010

doc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Copyright (c) 2016 Benoît Chesneau.
66

7-
__Version:__ 2.0.1
7+
__Version:__ 2.1.0
88

99
# metrics
1010

doc/metrics.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ value() = any()
5656
## Function Index ##
5757

5858

59-
<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>
59+
<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>
6060

6161

6262
<a name="functions"></a>
@@ -199,3 +199,14 @@ update(Name::list(), Probe::<a href="#type-probe">probe()</a>) -&gt; ok | any()
199199

200200
update a metric
201201

202+
<a name="update_or_create-3"></a>
203+
204+
### update_or_create/3 ###
205+
206+
<pre><code>
207+
update_or_create(Name::list(), Probe::<a href="#type-probe">probe()</a>, Type::<a href="#type-metric">metric()</a>) -&gt; ok | any()
208+
</code></pre>
209+
<br />
210+
211+
update a metric and create it if it doesn't exists
212+

doc/metrics_exometer.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ exometer backend.
1212
## Function Index ##
1313

1414

15-
<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>
15+
<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>
1616

1717

1818
<a name="functions"></a>
@@ -34,3 +34,9 @@ new(X1::atom(), Name::any(), Config::#{}) -&gt; ok | {error, metric_exists | uns
3434

3535
`update(Name, Val, Config) -> any()`
3636

37+
<a name="update_or_create-4"></a>
38+
39+
### update_or_create/4 ###
40+
41+
`update_or_create(Name, Val, Type, Config) -> any()`
42+

doc/metrics_folsom.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ folsom backend.
1212
## Function Index ##
1313

1414

15-
<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>
15+
<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>
1616

1717

1818
<a name="functions"></a>
@@ -34,3 +34,9 @@ new(X1::atom(), Name::any(), Config::#{}) -&gt; ok | {error, term()}
3434

3535
`update(Name, Val, Config) -> any()`
3636

37+
<a name="update_or_create-4"></a>
38+
39+
### update_or_create/4 ###
40+
41+
`update_or_create(Name, Probe, Type, Config) -> any()`
42+

doc/metrics_grapherl.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This backend can be set via the barrel_metrics env:
2020
## Function Index ##
2121

2222

23-
<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>
23+
<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>
2424

2525

2626
<a name="functions"></a>
@@ -51,3 +51,9 @@ This backend can be set via the barrel_metrics env:
5151

5252
`update(Name, Probe, Config) -> any()`
5353

54+
<a name="update_or_create-4"></a>
55+
56+
### update_or_create/4 ###
57+
58+
`update_or_create(Name, Probe, Type, Config) -> any()`
59+

doc/metrics_noop.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ noop backend.
1212
## Function Index ##
1313

1414

15-
<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>
15+
<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>
1616

1717

1818
<a name="functions"></a>
@@ -31,3 +31,9 @@ noop backend.
3131

3232
`update(Name, Probe, Config) -> any()`
3333

34+
<a name="update_or_create-4"></a>
35+
36+
### update_or_create/4 ###
37+
38+
`update_or_create(Name, Probe, Type, Config) -> any()`
39+

0 commit comments

Comments
 (0)