Skip to content

Commit

Permalink
Counter+Gauge+Summary: add method references.
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikekre committed Nov 5, 2023
1 parent f442736 commit dd9e4bb
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/Prometheus.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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...)

Expand Down Expand Up @@ -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...)

Expand Down Expand Up @@ -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...)

Expand Down

0 comments on commit dd9e4bb

Please sign in to comment.