Tarantool Lua API

metrics.collector

Methods11 

function collector.new_class(kind: string, method_names: string[] | nil) -> metrics.collector
 
function collector.new<T>(self: T, name: string, help: nil | string, metainfo: metrics.metainfo | nil, label_keys: string[] | nil) -> T
 
function collector.set_registry(registry: metrics.registry)
 
function collector.make_key(label_pairs: metrics.label_pairs | nil, label_keys: string[] | nil) -> string
 
function collector.remove(label_pairs: metrics.label_pairs | nil)

Remove the observation for label_pairs.

function collector.set(num: nil | number, label_pairs: metrics.label_pairs | nil)

Set the observation for label_pairs to num.

function collector.inc(num: nil | number, label_pairs: metrics.label_pairs | nil)

Increment the observation for label_pairs.

function collector.dec(num: nil | number, label_pairs: metrics.label_pairs | nil)

Decrement the observation for label_pairs.

function collector.observe_latency(label_pairs: metrics.label_pairs | fun(ok: boolean, result: any, ...: any) -> metrics.label_pairs | nil, fn: function, ...) -> value any

Measure latency of function call

Parameters
label_pairsmetrics.label_pairs | fun(ok: boolean, result: any, ...: any) -> metrics.label_pairs | nil
fnfunction

function for pcall to instrument

...
Returns
valueany

from fn

@vararg any args for function fn

function collector.append_global_labels(label_pairs: metrics.label_pairs | nil) -> metrics.label_pairs
 
function collector.collect() -> metrics.observation[]

Return an array of observation objects for the collector.

Fields7

collector.name : string
 
collector.help : string
 
collector.observations : {string, number}
 
collector.label_pairs : {string, metrics.label_pairs}
 
collector.label_keys : string[] | nil
 
collector.metainfo : metrics.metainfo
 
collector.registry : metrics.registry | nil