Tarantool Lua API

metrics.registry

Methods12

function registry.new() -> metrics.registry

Create a new registry.

function registry.find(kind: string, name: string) -> metrics.collector | nil

Find a collector in the registry.

function registry.find_or_create(class: metrics.collector, name: string, ...) -> metrics.collector

@vararg any

function registry.register(collector: metrics.collector) -> metrics.collector
function registry.unregister(collector: metrics.collector)

Remove a collector from the registry.

function registry.is_enabled(item: metrics.collector | metrics.metainfo | nil) -> boolean
function registry.filtered_collectors() -> {string, metrics.collector}
function registry.collect() -> metrics.observation[]

Collect observations from each collector.

function registry.register_callback(callback: function, metainfo: metrics.metainfo | nil)

Register a callback that is called right before metric collection.

function registry.unregister_callback(callback: function)

Unregister a callback.

function registry.set_labels(label_pairs: metrics.label_pairs)

Set global labels applied to every observation.

function registry.set_filter(include: nil | table | string, exclude: nil | table | string)

Set a runtime filter for collectors and callbacks by metric selectors.

Fields4

registry.collectors : {string, metrics.collector}
registry.callbacks : {function, metrics.metainfo}
registry.label_pairs : metrics.label_pairs
registry.filter : metrics.registry.filter