registry: Metric Registries

In atheriel/openmetrics: A 'Prometheus' Client for R Using the 'OpenMetrics' Format

Description

A registry is a collection of one or more metrics. By default, metrics are added to the object returned by global_registry(), but new registries can also be created with registry(). Use collect_metrics() to return all metrics that a registry is aware of, or render_metrics() to render all of them in aggregate.

Usage

registry()

global_registry()

collect_metrics(registry = global_registry())

render_metrics(registry = global_registry())

Arguments

registry

A Registry object, defaulting to the shared global one.

Details

Registry objects have methods, but they are not intended to be called by users and have no stable API.

Value

registry() and global_registry() return Registry objects (see Details), while collect_metrics() returns a list of metrics and render_metrics() returns a string.

atheriel/openmetrics documentation built on July 8, 2021, 3:34 a.m.