Skip to main content

Prometheus

Nauthilus has basic support for some Prometheus metrics.

dynamic_loader("nauthilus_prometheus")
local nauthilus_prometheus = require("nauthilus_prometheus")

Gauge vector​

You must create a gauge vector first before using it. This should be done in an init script.

nauthilus_prometheus.create_gauge_vec​

Create a gauge vec

local name = "http_client_concurrent_requests_total"
local help = "Measure the number of total concurrent HTTP client requests"
local labels = { "service" }

nauthilus_prometheus.create_gauge_vec(name, help, labels)

nauthilus_prometheus.add_gauge​

Add a value to some gauge with labels

local name = "some_gauge_name"
local value = 42
local labels = { "some label" }

nauthilus_prometheus.add_gauge(name, value, labels)

nauthilus_prometheus.sub_gauge​

Substract a value from some gauge with labels

local name = "some_gauge_name"
local value = 42
local labels = { "some label" }

nauthilus_prometheus.sub_gauge(name, value, labels)

nauthilus_prometheus.set_gauge​

Set a value to some gauge with labels

local name = "some_gauge_name"
local value = 42
local labels = { "some label" }

nauthilus_prometheus.set_gauge(name, value, labels)

nauthilus_prometheus.increment_gauge​

Increment a gauge counter

local name = "http_client_concurrent_requests_total"

nauthilus_prometheus.increment_gauge(name, { service = "some_service_name" })

nauthilus_prometheus.decrement_gauge​

Decrement a gauge counter

local name = "http_client_concurrent_requests_total"

nauthilus_prometheus.decrement_gauge(name, { service = "some_service_name" })

Counter vector​

You must create a counter vector first before using it. This should be done in an init script.

nauthilus_prometheus.create_counter_vec​

Create a counter vec

local name = "some_name"
local help = "Some description for this summary vector"
local labels = { "some_label"}

nauthilus_prometheus.create_counter_vec(name, help, labels)

nauthilus_prometheus.increment_counter​

Increment a counter by its labels

local name = "some_counter_name"
local labels = { "some_label" }

nauthilus_prometheus.increment_counter(name, labels)

Summary vector​

You must create a summary vector first before using it. This should be done in an init script.

nauthilus_prometheus.create_summary_vec​

Create a summary vec

local name = "some_name"
local help = "Some description for this summary vector"
local labels = { "some_label"}

nauthilus_prometheus.create_summary_vec(name, help, labels)

nauthilus_prometheus.start_summary_timer​

Start a summary timer

local name = "some_name"
local labels = { "some_label" }

local user_data_timer = nauthilus.prometheus.start_summary_timer(name, labels)

nauthilus_prometheus.stop_timer​

Stop a summary timer

local user_data_timer -- From a start_summary_timer-call

nauthilus_prometheus.stop_timer(user_data_timer)

Histogram vector​

You must create a histogram vector first before using it. This should be done in an init script.

nauthilus_prometheus.create_histogram_vec​

Create a histogram vec

local name = "some_name"
local help = "Some description for this summary vector"
local labels = { "some_label"}

nauthilus_prometheus.create_histogram_vec(name, help, labels)

nauthilus_prometheus.start_histogram_timer​

Start a histogram timer

local name = "some_name"
local labels = { "some_label" }

local user_data_timer = nauthilus.prometheus.start_histogram_timer(name, labels)

nauthilus_prometheus.stop_timer​

Stop a histogram timer

local user_data_timer -- From a start_histogram_timer-call

nauthilus_prometheus.stop_timer(user_data_timer)