You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/prometheus_buckets.md
+22-1Lines changed: 22 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,8 @@ Creates <code>Count</code> buckets, where the lowest bucket has an
40
40
upper bound of <code>Start</code> and each following bucket's upper bound is <code>Factor</code>
41
41
times the previous bucket's upper bound.</td></tr><tr><tdvalign="top"><ahref="#linear-3">linear/3</a></td><td>
42
42
Creates <code>Count</code> buckets, each <code>Width</code> wide, where the lowest
43
-
bucket has an upper bound of <code>Start</code>.</td></tr></table>
43
+
bucket has an upper bound of <code>Start</code>.</td></tr><tr><tdvalign="top"><ahref="#new-0">new/0</a></td><td></td></tr><tr><tdvalign="top"><ahref="#new-1">new/1</a></td><td>
Copy file name to clipboardExpand all lines: doc/prometheus_collector.md
+1-45Lines changed: 1 addition & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,7 +108,7 @@ data() = any()
108
108
## Function Index ##
109
109
110
110
111
-
<tablewidth="100%"border="1"cellspacing="0"cellpadding="2"summary="function index"><tr><tdvalign="top"><ahref="#collect_mf-3">collect_mf/3</a></td><td>Calls <code>Callback</code> for each MetricFamily of this collector.</td></tr><tr><tdvalign="top"><ahref="#deregister-1">deregister/1</a></td><td>(<em>Deprecated</em>.) Equivalent to <ahref="#deregister-2"><tt>deregister(Collector, default)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#deregister-2">deregister/2</a></td><td>(<em>Deprecated</em>.) </td></tr><tr><tdvalign="top"><ahref="#register-1">register/1</a></td><td>(<em>Deprecated</em>.) Equivalent to <ahref="#register-2"><tt>register(Collector, default)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#register-2">register/2</a></td><td>(<em>Deprecated</em>.) </td></tr></table>
111
+
<tablewidth="100%"border="1"cellspacing="0"cellpadding="2"summary="function index"><tr><tdvalign="top"><ahref="#collect_mf-3">collect_mf/3</a></td><td>Calls <code>Callback</code> for each MetricFamily of this collector.</td></tr></table>
112
112
113
113
114
114
<aname="functions"></a>
@@ -127,47 +127,3 @@ collect_mf(Registry, Collector, Callback) -> ok
127
127
128
128
Calls `Callback` for each MetricFamily of this collector.
129
129
130
-
<aname="deregister-1"></a>
131
-
132
-
### deregister/1 ###
133
-
134
-
`deregister(Collector) -> any()`
135
-
136
-
Equivalent to [`deregister(Collector, default)`](#deregister-2).
137
-
138
-
__This function is deprecated:__ Please use [`prometheus_registry:deregister_collector/1`](prometheus_registry.md#deregister_collector-1)
<tablewidth="100%"border="1"cellspacing="0"cellpadding="2"summary="function index"><tr><tdvalign="top"><ahref="#declare-1">declare/1</a></td><td>Creates a counter using <code>Spec</code>, if a counter with the same <code>Spec</code> exists
70
-
returns <code>false</code>.</td></tr><tr><tdvalign="top"><ahref="#declare-2">declare/2</a></td><td>(<em>Deprecated</em>.) </td></tr><tr><tdvalign="top"><ahref="#deregister-1">deregister/1</a></td><td>Equivalent to <ahref="#deregister-2"><tt>deregister(default, Name)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#deregister-2">deregister/2</a></td><td>
70
+
returns <code>false</code>.</td></tr><tr><tdvalign="top"><ahref="#deregister-1">deregister/1</a></td><td>Equivalent to <ahref="#deregister-2"><tt>deregister(default, Name)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#deregister-2">deregister/2</a></td><td>
71
71
Removes all counter series with name <code>Name</code> and
72
-
removes Metric Family from <code>Registry</code>.</td></tr><tr><tdvalign="top"><ahref="#dinc-1">dinc/1</a></td><td>Equivalent to <ahref="#dinc-4"><tt>dinc(default, Name, [], 1)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#dinc-2">dinc/2</a></td><td>If the second argument is a list, equivalent to
<ahref="#dinc-4"><tt>dinc(default, Name, [], Value)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#dinc-3">dinc/3</a></td><td>Equivalent to <ahref="#dinc-4"><tt>dinc(default, Name, LabelValues, Value)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#dinc-4">dinc/4</a></td><td>Increments the counter identified by <code>Registry</code>, <code>Name</code>
76
-
and <code>LabelValues</code> by <code>Value</code>.</td></tr><tr><tdvalign="top"><ahref="#inc-1">inc/1</a></td><td>Equivalent to <ahref="#inc-4"><tt>inc(default, Name, [], 1)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#inc-2">inc/2</a></td><td>If the second argument is a list, equivalent to
72
+
removes Metric Family from <code>Registry</code>.</td></tr><tr><tdvalign="top"><ahref="#inc-1">inc/1</a></td><td>Equivalent to <ahref="#inc-4"><tt>inc(default, Name, [], 1)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#inc-2">inc/2</a></td><td>If the second argument is a list, equivalent to
<ahref="#inc-4"><tt>inc(default, Name, [], Value)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#inc-3">inc/3</a></td><td>Equivalent to <ahref="#inc-4"><tt>inc(default, Name, LabelValues, Value)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#inc-4">inc/4</a></td><td>Increments the counter identified by <code>Registry</code>, <code>Name</code>
80
-
and <code>LabelValues</code> by <code>Value</code>.</td></tr><tr><tdvalign="top"><ahref="#new-1">new/1</a></td><td>Creates a counter using <code>Spec</code>.</td></tr><tr><tdvalign="top"><ahref="#new-2">new/2</a></td><td>(<em>Deprecated</em>.) </td></tr><tr><tdvalign="top"><ahref="#remove-1">remove/1</a></td><td>Equivalent to <ahref="#remove-3"><tt>remove(default, Name, [])</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#remove-2">remove/2</a></td><td>Equivalent to <ahref="#remove-3"><tt>remove(default, Name, LabelValues)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#remove-3">remove/3</a></td><td>Removes counter series identified by <code>Registry</code>, <code>Name</code>
76
+
and <code>LabelValues</code> by <code>Value</code>.</td></tr><tr><tdvalign="top"><ahref="#new-1">new/1</a></td><td>Creates a counter using <code>Spec</code>.</td></tr><tr><tdvalign="top"><ahref="#remove-1">remove/1</a></td><td>Equivalent to <ahref="#remove-3"><tt>remove(default, Name, [])</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#remove-2">remove/2</a></td><td>Equivalent to <ahref="#remove-3"><tt>remove(default, Name, LabelValues)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#remove-3">remove/3</a></td><td>Removes counter series identified by <code>Registry</code>, <code>Name</code>
81
77
and <code>LabelValues</code>.</td></tr><tr><tdvalign="top"><ahref="#reset-1">reset/1</a></td><td>Equivalent to <ahref="#reset-3"><tt>reset(default, Name, [])</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#reset-2">reset/2</a></td><td>Equivalent to <ahref="#reset-3"><tt>reset(default, Name, LabelValues)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#reset-3">reset/3</a></td><td>Resets the value of the counter identified by <code>Registry</code>, <code>Name</code>
82
78
and <code>LabelValues</code>.</td></tr><tr><tdvalign="top"><ahref="#value-1">value/1</a></td><td>Equivalent to <ahref="#value-3"><tt>value(default, Name, [])</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#value-2">value/2</a></td><td>Equivalent to <ahref="#value-3"><tt>value(default, Name, LabelValues)</tt></a>.</td></tr><tr><tdvalign="top"><ahref="#value-3">value/3</a></td><td>Returns the value of the counter identified by <code>Registry</code>, <code>Name</code>
83
79
and <code>LabelValues</code>.</td></tr></table>
@@ -107,15 +103,6 @@ isn't a list.<br />
107
103
Raises `{invalid_label_name, Name, Message}` error if `Name` isn't a valid
108
104
label name.
109
105
110
-
<aname="declare-2"></a>
111
-
112
-
### declare/2 ###
113
-
114
-
`declare(Spec, Registry) -> any()`
115
-
116
-
__This function is deprecated:__ Please use [`declare/1`](#declare-1) with registry
117
-
key instead.
118
-
119
106
<aname="deregister-1"></a>
120
107
121
108
### deregister/1 ###
@@ -138,51 +125,6 @@ After this call new/1 for `Name` and `Registry` will succeed.
138
125
Returns `{true, _}` if `Name` was a registered counter.
139
126
Otherwise returns `{true, _}`.
140
127
141
-
<aname="dinc-1"></a>
142
-
143
-
### dinc/1 ###
144
-
145
-
`dinc(Name) -> any()`
146
-
147
-
Equivalent to [`dinc(default, Name, [], 1)`](#dinc-4).
148
-
149
-
<aname="dinc-2"></a>
150
-
151
-
### dinc/2 ###
152
-
153
-
`dinc(Name, LabelValues) -> any()`
154
-
155
-
If the second argument is a list, equivalent to
156
-
[`dinc(default, Name, LabelValues, 1)`](#dinc-4)
157
-
otherwise equivalent to
158
-
[`dinc(default, Name, [], Value)`](#dinc-4).
159
-
160
-
<aname="dinc-3"></a>
161
-
162
-
### dinc/3 ###
163
-
164
-
`dinc(Name, LabelValues, Value) -> any()`
165
-
166
-
Equivalent to [`dinc(default, Name, LabelValues, Value)`](#dinc-4).
0 commit comments