daaku.metrics — org.clojars.daaku/metrics 1.1.0

Clojure API over the Prometheus Java SDK.

This API doesn't try to keep you far away from the Java API. You will likely end up using that API directly. The functions here provide idiomatic (and performant) access to the Collectors.

All Collector creation functions take the same set of options. :name and :help are required, :namespace, :subsystem & :labels are optional.

The expected usage pattern is to create a long lived Collector instance, and use the functions in this package to track the metrics. Most commonly, you will create a package level private var to keep a reference to a metric.

(require '[daaku.metrics :as m])

(def ^:private m-emails-sent (m/counter {:name :emails-sent
                                         :help "emails we sent"}))

(defn- send-email []
  (println "sending email")
  (m/inc m-emails-sent))

counter clj

(counter opts)

Create a Counter Collector.

Decrement clj protocol

dec clj

(dec m)

(dec m amount)

Decrement a Collector by 1 or the given amount.

enumeration clj

(enumeration {:keys [states] :as opts})

Create Enumeration Collector. Also requires :states.

gauge clj

(gauge opts)

Create Gauge Collector.

histogram clj

(histogram opts)

Create Histogram Collector.

Increment clj protocol

inc clj

(inc this)

(inc this amount)

Increment a Collector by 1 or the given amount.

info clj

(info opts)

Create Info Collector.

Observe clj protocol

observe clj

(observe this amount)

Observe a given value.

start-timer clj

(start-timer this)

Start a timer. Returns a function that when called will stop the timer.

register clj

(register r c)

Register into a CollectorRegistry the given Collector.

sanitize-name clj

(sanitize-name v)

Sanitize a name to create a safe string suitable as a name, namespace, subsystem or label.

sanitize-value clj

(sanitize-value v)

Sanitize a value. Keywords are special and their name is used, everything else is transformed to using str.

SetInfo clj protocol

set-info clj

(set-info this info)

Set the information of an Info Collector. Info keys and values will be sanitized.

Settable clj protocol

set clj

(set m amount)

Set a Collector's value to the given amount.

State clj protocol

set-state clj

(set-state this state)

Set the state of an Enumeration Collector. State value will be sanitized.

summary clj

(summary opts)

Create Summary Collector.

time clj macro

(time collector & body)

Measure in the Collector the run time duration of the given forms.

WithLabels clj protocol

with-labels clj

(with-labels this labels)

Create a child with the provided labels.