diff --git a/v1.0.0/.documenter-siteinfo.json b/v1.0.0/.documenter-siteinfo.json index 7064652..214d8fb 100644 --- a/v1.0.0/.documenter-siteinfo.json +++ b/v1.0.0/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-11-06T18:11:35","documenter_version":"1.1.2"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-11-06T20:05:14","documenter_version":"1.1.2"}} \ No newline at end of file diff --git a/v1.0.0/index.html b/v1.0.0/index.html index e520ac7..4e1fb5f 100644 --- a/v1.0.0/index.html +++ b/v1.0.0/index.html @@ -23,4 +23,4 @@ counter_family = Prometheus.Family{Counter}( ) # Increment the counter for the labels status_code = "200" and endpoint = "/api" -Prometheus.inc(Prometheus.labels(counter_family, ["200", "/api"]))source
Prometheus.labels — Method
Prometheus.labels(family::Family{C}, labelvalues::Tuple{String, ...}) where C

Return the collector of type C from the family corresponding to the labels given by labelvalues.

Note

This method does an acquire/release of a lock, and a dictionary lookup, to find the collector matching the label names. For typical applications this overhead does not matter (below 100ns for some basic benchmarks) but it is safe to cache the returned collector if required.

source
Prometheus.remove — Method
Prometheus.remove(family::Family, labelvalues::Tuple{String, ...})

Remove the collector corresponding to labelvalues. Effectively this resets the collector since Prometheus.labels will recreate the collector when called with the same label names.

Note

This method invalidates cached collectors for the label names.

source
Prometheus.clear — Method
Prometheus.clear(family::Family)

Remove all collectors in the family. Effectively this resets the collectors since Prometheus.labels will recreate them when needed.

Note

This method invalidates all cached collectors.

source

Registries

Default registry

Exposition

Prometheus support

Prometheus.expose — Function
Prometheus.expose(file::String, reg::CollectorRegistry = DEFAULT_REGISTRY)

Export all metrics in reg by writing them to the file file.

source
expose(io::IO, reg::CollectorRegistry = DEFAULT_REGISTRY)

Export all metrics in reg by writing them to the I/O stream io.

source
expose(http::HTTP.Stream, reg::CollectorRegistry = DEFAULT_REGISTRY; kwargs...)

Export all metrics in reg by writing them to the HTTP stream http.

The caller is responsible for checking e.g. the HTTP method and URI target. For HEAD requests this method do not write a body, however.

source
+Prometheus.inc(Prometheus.labels(counter_family, ["200", "/api"]))source
Prometheus.labels — Method
Prometheus.labels(family::Family{C}, labelvalues::Tuple{String, ...}) where C

Return the collector of type C from the family corresponding to the labels given by labelvalues.

Note

This method does an acquire/release of a lock, and a dictionary lookup, to find the collector matching the label names. For typical applications this overhead does not matter (below 100ns for some basic benchmarks) but it is safe to cache the returned collector if required.

source
Prometheus.remove — Method
Prometheus.remove(family::Family, labelvalues::Tuple{String, ...})

Remove the collector corresponding to labelvalues. Effectively this resets the collector since Prometheus.labels will recreate the collector when called with the same label names.

Note

This method invalidates cached collectors for the label names.

source
Prometheus.clear — Method
Prometheus.clear(family::Family)

Remove all collectors in the family. Effectively this resets the collectors since Prometheus.labels will recreate them when needed.

Note

This method invalidates all cached collectors.

source

Registries

Default registry

Exposition

Prometheus support

Prometheus.expose — Function
Prometheus.expose(file::String, reg::CollectorRegistry = DEFAULT_REGISTRY)

Export all metrics in reg by writing them to the file file.

source
expose(io::IO, reg::CollectorRegistry = DEFAULT_REGISTRY)

Export all metrics in reg by writing them to the I/O stream io.

source
expose(http::HTTP.Stream, reg::CollectorRegistry = DEFAULT_REGISTRY; kwargs...)

Export all metrics in reg by writing them to the HTTP stream http.

The caller is responsible for checking e.g. the HTTP method and URI target. For HEAD requests this method do not write a body, however.

source