Skip to content

Commit

Permalink
regen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
deadtrickster committed Aug 2, 2022
1 parent 3ad4df5 commit aaac28d
Show file tree
Hide file tree
Showing 9 changed files with 59 additions and 49 deletions.
2 changes: 1 addition & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Copyright (c) 2016,2017 Ilya Khaprov <<i.khaprov@gmail.com>>.

__Version:__ 4.8.1
__Version:__ 4.8.2

[![Hex.pm](https://img.shields.io/hexpm/v/prometheus.svg?maxAge=2592000?style=plastic)](https://hex.pm/packages/prometheus)
[![Hex.pm](https://img.shields.io/hexpm/dt/prometheus.svg?maxAge=2592000)](https://hex.pm/packages/prometheus)
Expand Down
4 changes: 2 additions & 2 deletions doc/prometheus_collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Example (simplified `prometheus_vm_memory_collector`):


<pre><code>
collect_mf_callback() = fun((<a href="prometheus_model.md#type-MetricFamily">prometheus_model:'MetricFamily'()</a>) -&gt; any())
collect_mf_callback() = fun((<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_model.html#type-MetricFamily">prometheus_model:'MetricFamily'()</a>) -&gt; any())
</code></pre>


Expand Down Expand Up @@ -123,7 +123,7 @@ data() = any()
collect_mf(Registry, Collector, Callback) -&gt; ok
</code></pre>

<ul class="definitions"><li><code>Registry = <a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a></code></li><li><code>Collector = <a href="#type-collector">collector()</a></code></li><li><code>Callback = <a href="#type-collect_mf_callback">collect_mf_callback()</a></code></li></ul>
<ul class="definitions"><li><code>Registry = <a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a></code></li><li><code>Collector = <a href="#type-collector">collector()</a></code></li><li><code>Callback = <a href="#type-collect_mf_callback">collect_mf_callback()</a></code></li></ul>

Calls `Callback` for each MetricFamily of this collector.

4 changes: 2 additions & 2 deletions doc/prometheus_http.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ HTTP instrumentation helpers.


<pre><code>
status_class() = <a href="prometheus_model_helpers.md#type-label_value">prometheus_model_helpers:label_value()</a>
status_class() = <a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_model_helpers.html#type-label_value">prometheus_model_helpers:label_value()</a>
</code></pre>


Expand Down Expand Up @@ -51,7 +51,7 @@ Returns status class for the http status code <code>SCode</code>.</td></tr></tab
### microseconds_duration_buckets/0 ###

<pre><code>
microseconds_duration_buckets() -&gt; <a href="prometheus_buckets.md#type-buckets">prometheus_buckets:buckets()</a>
microseconds_duration_buckets() -&gt; <a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_buckets.html#type-buckets">prometheus_buckets:buckets()</a>
</code></pre>
<br />

Expand Down
4 changes: 2 additions & 2 deletions doc/prometheus_mnesia.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ CCount is a number of coordinator transactions.</td></tr></table>
table_disk_size(Table) -&gt; Size
</code></pre>

<ul class="definitions"><li><code>Table = <a href="file.md#type-name_all">file:name_all()</a></code></li><li><code>Size = non_neg_integer()</code></li></ul>
<ul class="definitions"><li><code>Table = <a href="http://www.erlang.org/edoc/doc/kernel/doc/file.html#type-name_all">file:name_all()</a></code></li><li><code>Size = non_neg_integer()</code></li></ul>

Equivalent to [`table_disk_size(mnesia:system_info(directory), Table)`](#table_disk_size-2).

Expand All @@ -43,7 +43,7 @@ Equivalent to [`table_disk_size(mnesia:system_info(directory), Table)`](#table_d
table_disk_size(Dir, Table) -&gt; Size
</code></pre>

<ul class="definitions"><li><code>Dir = <a href="file.md#type-name_all">file:name_all()</a></code></li><li><code>Table = <a href="file.md#type-name_all">file:name_all()</a></code></li><li><code>Size = non_neg_integer()</code></li></ul>
<ul class="definitions"><li><code>Dir = <a href="http://www.erlang.org/edoc/doc/kernel/doc/file.html#type-name_all">file:name_all()</a></code></li><li><code>Table = <a href="http://www.erlang.org/edoc/doc/kernel/doc/file.html#type-name_all">file:name_all()</a></code></li><li><code>Size = non_neg_integer()</code></li></ul>

Returns sum of all mnesia files for the given `Table` in bytes.
Mnesia can create different files for each table:
Expand Down
62 changes: 36 additions & 26 deletions doc/prometheus_model_helpers.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/prometheus_protobuf_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Formats `default` registry using protocol buffer format.
### format/1 ###

<pre><code>
format(Registry::<a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a>) -&gt; binary()
format(Registry::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a>) -&gt; binary()
</code></pre>
<br />

Expand Down
24 changes: 12 additions & 12 deletions doc/prometheus_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ batch jobs.


<pre><code>
collect_callback() = fun((<a href="#type-registry">registry()</a>, <a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a>) -&gt; any())
collect_callback() = fun((<a href="#type-registry">registry()</a>, <a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a>) -&gt; any())
</code></pre>


Expand Down Expand Up @@ -74,7 +74,7 @@ Equivalent to [`clear(default)`](#clear-1).
### clear/1 ###

<pre><code>
clear(Registry::<a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a>) -&gt; ok
clear(Registry::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a>) -&gt; ok
</code></pre>
<br />

Expand All @@ -88,7 +88,7 @@ Unregisters all collectors.
collect(Registry, Callback) -&gt; ok
</code></pre>

<ul class="definitions"><li><code>Registry = <a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a></code></li><li><code>Callback = <a href="#type-collect_callback">collect_callback()</a></code></li></ul>
<ul class="definitions"><li><code>Registry = <a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a></code></li><li><code>Callback = <a href="#type-collect_callback">collect_callback()</a></code></li></ul>

Calls `Callback` for each collector with two arguments:
`Registry` and `Collector`.
Expand All @@ -101,7 +101,7 @@ Calls `Callback` for each collector with two arguments:
collector_registeredp(Collector) -&gt; boolean()
</code></pre>

<ul class="definitions"><li><code>Collector = <a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a></code></li></ul>
<ul class="definitions"><li><code>Collector = <a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a></code></li></ul>

Equivalent to [`collector_registeredp(default, Collector)`](#collector_registeredp-2).

Expand All @@ -113,7 +113,7 @@ Equivalent to [`collector_registeredp(default, Collector)`](#collector_registere
collector_registeredp(Registry, Collector) -&gt; boolean()
</code></pre>

<ul class="definitions"><li><code>Registry = <a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a></code></li><li><code>Collector = <a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a></code></li></ul>
<ul class="definitions"><li><code>Registry = <a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a></code></li><li><code>Collector = <a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a></code></li></ul>

Checks whether `Collector` is registered.

Expand All @@ -122,7 +122,7 @@ Checks whether `Collector` is registered.
### collectors/1 ###

<pre><code>
collectors(Registry::<a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a>) -&gt; [Collector::<a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a>]
collectors(Registry::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a>) -&gt; [Collector::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a>]
</code></pre>
<br />

Expand All @@ -133,7 +133,7 @@ Returns collectors registered in `Registry`.
### deregister_collector/1 ###

<pre><code>
deregister_collector(Collector::<a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a>) -&gt; ok
deregister_collector(Collector::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a>) -&gt; ok
</code></pre>
<br />

Expand All @@ -144,7 +144,7 @@ Equivalent to [`deregister_collector(default, Collector)`](#deregister_collector
### deregister_collector/2 ###

<pre><code>
deregister_collector(Registry::<a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a>, Collector::<a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a>) -&gt; ok
deregister_collector(Registry::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a>, Collector::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a>) -&gt; ok
</code></pre>
<br />

Expand All @@ -171,7 +171,7 @@ atoms) and returns atom or false. This operation is O(n).
### register_collector/1 ###

<pre><code>
register_collector(Collector::<a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a>) -&gt; ok
register_collector(Collector::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a>) -&gt; ok
</code></pre>
<br />

Expand All @@ -182,7 +182,7 @@ Equivalent to [`register_collector(default, Collector)`](#register_collector-2).
### register_collector/2 ###

<pre><code>
register_collector(Registry::<a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a>, Collector::<a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a>) -&gt; ok
register_collector(Registry::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a>, Collector::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a>) -&gt; ok
</code></pre>
<br />

Expand All @@ -193,7 +193,7 @@ Register a collector.
### register_collectors/1 ###

<pre><code>
register_collectors(Collectors::[<a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a>]) -&gt; ok
register_collectors(Collectors::[<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a>]) -&gt; ok
</code></pre>
<br />

Expand All @@ -204,7 +204,7 @@ Equivalent to [`register_collectors(default, Collectors)`](#register_collectors-
### register_collectors/2 ###

<pre><code>
register_collectors(Registry::<a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a>, Collectors::[<a href="prometheus_collector.md#type-collector">prometheus_collector:collector()</a>]) -&gt; ok
register_collectors(Registry::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a>, Collectors::[<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_collector.html#type-collector">prometheus_collector:collector()</a>]) -&gt; ok
</code></pre>
<br />

Expand Down
2 changes: 1 addition & 1 deletion doc/prometheus_text_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Formats `default` registry using the latest text format.
### format/1 ###

<pre><code>
format(Registry::<a href="prometheus_registry.md#type-registry">prometheus_registry:registry()</a>) -&gt; binary()
format(Registry::<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_registry.html#type-registry">prometheus_registry:registry()</a>) -&gt; binary()
</code></pre>
<br />

Expand Down
4 changes: 2 additions & 2 deletions doc/prometheus_vm_statistics_collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The total number of bytes reclaimed by GC since the system started.
Type: counter.<br />
Total reductions count.

* `erlang_vm_statistics_run_queues_length_total`<br />
* `erlang_vm_statistics_run_queues_length`<br />
Type: gauge.<br />
The total length of all normal run-queues. That is, the number of
processes and ports that are ready to run on all available normal
Expand Down Expand Up @@ -94,7 +94,7 @@ for `erlang_vm_statistics_garbage_collection_number_of_gcs`,

* `reductions` for `erlang_vm_statistics_reductions_total`;

* `run_queue` for `erlang_vm_statistics_run_queues_length_total`;
* `run_queue` for `erlang_vm_statistics_run_queues_length`;

* `runtime` for `erlang_vm_statistics_runtime_milliseconds`;

Expand Down

0 comments on commit aaac28d

Please sign in to comment.