MetricFamilySample: Object to retain sample of the same time together (i.e. all...

In cfmack/pRometheus: Client Prometheus Library for R

Description

Object to retain sample of the same time together (i.e. all gauges, counters, etc)

Object to retain sample of the same time together (i.e. all gauges, counters, etc)

Methods

Public methods

• MetricFamilySample$new()

• MetricFamilySample$getName()

• MetricFamilySample$setName()

• MetricFamilySample$getLabelNames()

• MetricFamilySample$setLabelNames()

• MetricFamilySample$getType()

• MetricFamilySample$setType()

• MetricFamilySample$getHelp()

• MetricFamilySample$setHelp()

• MetricFamilySample$getSamples()

• MetricFamilySample$setSamples()

• MetricFamilySample$clone()

---

Method new()

Usage

MetricFamilySample$new(name, type, help, label_names = list())

Arguments

name

name of the gauge metric you are collecting

type

type of metric in this family

help

helper text to display to Prometheus

label_names

the names of the labels.

Returns

instance of MetricFamilySample Getter for the family name

---

Method getName()

Usage

MetricFamilySample$getName()

Returns

fully qualified name of the family Setter for the family name

---

Method setName()

Usage

MetricFamilySample$setName(val)

Arguments

val

string to set the name Getter for the label names

---

Method getLabelNames()

Usage

MetricFamilySample$getLabelNames()

Returns

list of label names Setter for the label names

---

Method setLabelNames()

Usage

MetricFamilySample$setLabelNames(val)

Arguments

val

list to set the list of label names Getter for the family type

---

Method getType()

Usage

MetricFamilySample$getType()

Returns

type of the family Setter for the family type

---

Method setType()

Usage

MetricFamilySample$setType(val)

Arguments

val

string to set the family type Getter for the family help

---

Method getHelp()

Usage

MetricFamilySample$getHelp()

Returns

fully qualif of the family Setter for the family help text

---

Method setHelp()

Usage

MetricFamilySample$setHelp(val)

Arguments

val

string to set the help Getter for list of PrometheusSample objects

---

Method getSamples()

Usage

MetricFamilySample$getSamples()

Returns

returns list of PrometheusSample objects Setter for the family samples

---

Method setSamples()

Usage

MetricFamilySample$setSamples(val)

Arguments

val

list of PrometheusSample objects

---

Method clone()

The objects of this class are cloneable with this method.

Usage

MetricFamilySample$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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