prometheus.alpha — prom-metrics 0.5-alpha2

Clear clj protocol

clear- clj

(clear- x)

clear! clj

(clear! x)

Clears all metrics of the collector. After calling clear! captured labeled instances are detached.

collector clj

(collector x)

(collector x label)

(collector x label-1 label-2)

(collector x label-1 label-2 label-3)

(collector x label-1 label-2 label-3 & labels)

Coerce to collector.

collector-fn clj macro

(collector-fn n)

Generates the collector- function for SimpleCollector with a max arity of n.

collector? clj

(collector? x)

counter? clj

(counter? x)

create-counter clj

(create-counter name help & more)

create-gauge clj

(create-gauge name help & more)

create-histogram clj

(create-histogram name help & more)

Dec clj protocol

dec- clj

(dec- x amount)

dec! clj

(dec! gauge & labels-and-amount)

Decrements a gauge by the given amount or 1.

defcounter clj macro

(defcounter name help attr-map? & label-names)

Defines a counter as var with name.

Metrics are required to have a name and a help text. An optional :namespace and :subsystem can be defined via attr-map. The metrics name can be overridden by :name in attr-map. Per default, the var name is used with dashes replaced by underscores. The full name of the metric is namespace_subsystem_name and has to conform to /[a-zA-Z_:][a-zA-Z0-9_:]*/.

Labels are used to provide dimensions to metrics. For example: a counter defined with two labels has two dimensions for which you have to supply values when incrementing.

Counters have to be registered in a CollectorRegistry in order to be available for dump-metrics.

defgauge clj macro

(defgauge name help attr-map? & label-names)

Defines a gauge as var with name.

Metrics are required to have a name and a help text. An optional :namespace and :subsystem can be defined via attr-map. The metrics name can be overridden by :name in attr-map. Per default the var name is used with dashes replaced by underscores. The full name of the metric is namespace_subsystem_name and has to conform to /[a-zA-Z_:][a-zA-Z0-9_:]*/.

Labels are used to provide dimensions to metrics. For example: a gauge defined with two labels has two dimensions for which you have to supply values when incrementing.

Gauges have to be registered in a CollectorRegistry in order to be available for dump-metrics.

defhistogram clj macro

(defhistogram name help attr-map? buckets & label-names)

Defines a histogram as var with name.

Metrics are required to have a name and a help text. An optional :namespace and :subsystem can be defined via attr-map. The metrics name can be overridden by :name in attr-map. Per default the var name is used with dashes replaced by underscores. The full name of the metric is namespace_subsystem_name and has to conform to /[a-zA-Z_:][a-zA-Z0-9_:]*/.

Buckets is a collection of upper bounds of buckets for the histogram.

Labels are used to provide dimensions to metrics. For example: a histogram defined with two labels has two dimensions for which you have to supply values when incrementing.

Histograms have to be registered in a CollectorRegistry in order to be available for dump-metrics.

dump-metrics clj

(dump-metrics)

(dump-metrics registry)

Dumps metrics of the given or default registry using simple client's text format.

extend-protocol-dec clj macro

(extend-protocol-dec & classes)

extend-protocol-get clj macro

(extend-protocol-get & classes)

extend-protocol-inc clj macro

(extend-protocol-inc & classes)

extend-protocol-observe clj macro

(extend-protocol-observe & classes)

extend-protocol-set clj macro

(extend-protocol-set & classes)

extend-protocol-start-timer clj macro

(extend-protocol-start-timer & classes)

extend-protocol-timer clj macro

(extend-protocol-timer & classes)

gauge? clj

(gauge? x)

Get clj protocol

get- clj

(get- x)

get clj

(get collector & labels)

Gets the current value of a counter, gauge, histogram or summary.

For a counter and a gauge the value is a double. For a histogram the value is a map containing a :histogram/sum and a :histogram/buckets value.

histogram? clj

(histogram? x)

Inc clj protocol

inc- clj

(inc- x amount)

inc! clj

(inc! collector & labels-and-amount)

Increments a counter or gauge by the given amount or 1.

Observe clj protocol

observe- clj

(observe- x amount)

observe! clj

(observe! collector & labels-and-amount)

Observes a given amount to a histogram or summary.

observe-duration! clj

(observe-duration! timer)

Observes the duration of a histogram or summary timer.

Set clj protocol

set- clj

(set- x amount)

set! clj

(set! gauge amount)

(set! gauge label amount)

(set! gauge & labels amount)

Sets a gauge to the given amount.

StartTimer clj protocol

start-timer- clj

(start-timer- x)

summary? clj

(summary? x)

Timer clj protocol

observe-duration- clj

(observe-duration- x)

timer clj

(timer collector & labels)

Returns a timer of a gauge, histogram or summary.

The timer is closeable and observes the time at close. It can be used with with-open.

timer? clj

(timer? x)

Returns true if x is a timer, else false.

ToCollector clj protocol

collector- clj

(collector- x)

(collector- x label)

(collector- x label-1 label-2)

(collector- x label-1 label-2 label-3)

(collector- x label-1 label-2 label-3 labels)