CollectorRegistry: Prometheus collector registry

In cfmack/pRometheus: Client Prometheus Library for R

Description

Allows an object for collecting and registering gauges, counters, etc

Methods

Public methods

• CollectorRegistry$new()

• CollectorRegistry$getMetricFamilySamples()

• CollectorRegistry$registerGauge()

• CollectorRegistry$getGauge()

• CollectorRegistry$registerCounter()

• CollectorRegistry$getCounter()

• CollectorRegistry$clone()

---

Method new()

Usage

CollectorRegistry$new(storage_adapter = NULL)

Arguments

storage_adapter

instance of the storage adapter to how you want to persist metrics

Returns

instance of CollectorRegistry

Examples

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
Return the list of samples CollectorRegistry, typically to render after

---

Method getMetricFamilySamples()

Usage

CollectorRegistry$getMetricFamilySamples()

Returns

list of MetricFamilySamples

Examples

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
renderer <- PrometheusRenderMetrics$new()
out <- renderer$render(registry$getMetricFamilySamples())
Registers a gauge to be leveraged later

---

Method registerGauge()

Usage

CollectorRegistry$registerGauge(name, help, namespace = NULL, labels = list())

Arguments

name

name of the gauge

help

help text of the gauge

namespace

optional namespace that will be help keep the name unique

labels

list of label names to be used in the gauge

Examples

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
registry$registerGauge( name = 'test', help = 'some_gauge', namespace = "my_space" )
Retrieves the gauge to be leveraged

---

Method getGauge()

Usage

CollectorRegistry$getGauge(name, namespace = NULL)

Arguments

name

name of the gauge

namespace

optional namespace that will be help keep the name unique

Examples

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
registry$registerGauge( name = 'test', help = 'my_gauge', namespace = "my_space" )
count <- registry$getGauge(name = 'my_gauge', namespace = "my_space")
count$incBy(5)
Registers a counter to be leveraged later

---

Method registerCounter()

Usage

CollectorRegistry$registerCounter(
  name,
  help,
  namespace = NULL,
  labels = list()
)

Arguments

name

name of the counter

help

help text of the counter

namespace

optional namespace that will be help keep the name unique

labels

list of label names to be used in the counter

Examples

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
registry$registerCounter( name = 'test', help = 'some_counter', namespace = "my_space" )
Retrieves the counter to be leveraged

---

Method getCounter()

Usage

CollectorRegistry$getCounter(name, namespace = NULL)

Arguments

name

name of the counter

namespace

optional namespace that will be help keep the name unique

Examples

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
registry$registerCounter( name = 'test', help = 'my_counter', namespace = "my_space" )
count <- registry$getCounter(name = 'my_counter', namespace = "my_space")
count$inc()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CollectorRegistry$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `CollectorRegistry$new`
## ------------------------------------------------

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
Return the list of samples CollectorRegistry, typically to render after


## ------------------------------------------------
## Method `CollectorRegistry$getMetricFamilySamples`
## ------------------------------------------------

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
renderer <- PrometheusRenderMetrics$new()
out <- renderer$render(registry$getMetricFamilySamples())
Registers a gauge to be leveraged later


## ------------------------------------------------
## Method `CollectorRegistry$registerGauge`
## ------------------------------------------------

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
registry$registerGauge( name = 'test', help = 'some_gauge', namespace = "my_space" )
Retrieves the gauge to be leveraged


## ------------------------------------------------
## Method `CollectorRegistry$getGauge`
## ------------------------------------------------

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
registry$registerGauge( name = 'test', help = 'my_gauge', namespace = "my_space" )
count <- registry$getGauge(name = 'my_gauge', namespace = "my_space")
count$incBy(5)
Registers a counter to be leveraged later


## ------------------------------------------------
## Method `CollectorRegistry$registerCounter`
## ------------------------------------------------

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
registry$registerCounter( name = 'test', help = 'some_counter', namespace = "my_space" )
Retrieves the counter to be leveraged


## ------------------------------------------------
## Method `CollectorRegistry$getCounter`
## ------------------------------------------------

registry <- CollectorRegistry$new() # default to a new PrometheusMemoryAdapter
registry$registerCounter( name = 'test', help = 'my_counter', namespace = "my_space" )
count <- registry$getCounter(name = 'my_counter', namespace = "my_space")
count$inc()

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