From dd9e4bbc155aa5d703e92051f764a1d325c2465f Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Sun, 5 Nov 2023 23:27:51 +0100 Subject: [PATCH] Counter+Gauge+Summary: add method references. --- src/Prometheus.jl | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/Prometheus.jl b/src/Prometheus.jl index 16b0394..ce5433e 100644 --- a/src/Prometheus.jl +++ b/src/Prometheus.jl @@ -138,6 +138,9 @@ Construct a Counter collector. - `registry :: Prometheus.CollectorRegistry`: the registry in which to register the collector. If not specified the default registry is used. Pass `registry = nothing` to skip registration. + +**Methods** + - [`Prometheus.inc`](@ref): increment the counter. """ Counter(::String, ::String; kwargs...) @@ -214,6 +217,14 @@ Construct a Gauge collector. - `registry :: Prometheus.CollectorRegistry`: the registry in which to register the collector. If not specified the default registry is used. Pass `registry = nothing` to skip registration. + +**Methods** + - [`Prometheus.inc`](@ref inc(::Gauge, ::Any)): increment the value + of the gauge. + - [`Prometheus.dec`](@ref): decrement the value of the gauge. + - [`Prometheus.set`](@ref): set the value of the gauge. + - [`Prometheus.set_to_current_time`](@ref): set the value of the gauge to the + current unixtime. """ Gauge(::String, ::String; kwargs...) @@ -318,6 +329,9 @@ Construct a Summary collector. - `registry :: Prometheus.CollectorRegistry`: the registry in which to register the collector. If not specified the default registry is used. Pass `registry = nothing` to skip registration. + +**Methods** + - [`Prometheus.observe`](@ref): add an observation to the summary. """ Summary(::String, ::String; kwargs...)