PrometheusRenderMetrics: Output for Prometheus to parse

In cfmack/pRometheus: Client Prometheus Library for R

Description

Generally call this as a /metrics end point in plumber

Methods

Public methods

• PrometheusRenderMetrics$new()

• PrometheusRenderMetrics$render()

• PrometheusRenderMetrics$clone()

---

Method new()

Usage

PrometheusRenderMetrics$new()

Returns

instance of PrometheusRenderMetrics Render text in the Prometheus format

---

Method render()

Usage

PrometheusRenderMetrics$render(metrics)

Arguments

metrics

list of MetricFamilySample

Returns

string

Examples

registry <<- CollectorRegistry$new()
renderer <- PrometheusRenderMetrics$new()
out <- renderer$render(registry$getMetricFamilySamples())

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PrometheusRenderMetrics$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `PrometheusRenderMetrics$render`
## ------------------------------------------------

registry <<- CollectorRegistry$new()
renderer <- PrometheusRenderMetrics$new()
out <- renderer$render(registry$getMetricFamilySamples())

cfmack/pRometheus documentation built on Jan. 25, 2021, 3:45 a.m.