1. class
  2. PHPProm
  3. Storage
  4. MongoDB

MongoDB

class MongoDB extends AbstractStorage

Class MongoDB Storage implementation using MongoDB.

Methods

__construct(string $host, string $database = 'phppromdb', string $collection = 'measurements', array $options = array(), array $driverOptions = array())

MongoDB constructor.

addAvailableMetric(string $metric, string $label, string $help, string $type, string $defaultValue)

Adds a metric to the available ones.

from AbstractStorage
array
getAvailableMetrics()

Gets all available metrics in an array.

from AbstractStorage
void
storeMeasurement(string $metric, string $key, float $value)

Stores a measurement.

void
incrementMeasurement(string $metric, string $key)

Increments a measurement, starting with 1 if it doesn't exist yet.

array
getMeasurements(string $metric, array $keys, string $defaultValue = 'Nan')

Gets all measurements.

Details

at line line 53
__construct(string $host, string $database = 'phppromdb', string $collection = 'measurements', array $options = array(), array $driverOptions = array())

MongoDB constructor.

Parameters

string $host a mongodb:// connection URI
string $database the database to use, defaults to "phppromdb"
string $collection the collection to use, defaults to "measurements"
array $options connection string options, defaults to []
array $driverOptions any driver-specific options not included in MongoDB connection spec, defaults to []

in AbstractStorage at line line 48
addAvailableMetric(string $metric, string $label, string $help, string $type, string $defaultValue)

Adds a metric to the available ones.

Parameters

string $metric the metric itself as delivered by Prometheus
string $label the name of the one Prometheus label to categorize the values
string $help a helping text for the metric
string $type the Prometheus type of the metric
string $defaultValue the default value which the metric gets if there is no value stored

in AbstractStorage at line line 64
array getAvailableMetrics()

Gets all available metrics in an array.

Return Value

array the available metrics

at line line 63
void storeMeasurement(string $metric, string $key, float $value)

Stores a measurement.

Parameters

string $metric the name of the metric
string $key the key
float $value the value

Return Value

void

at line line 75
void incrementMeasurement(string $metric, string $key)

Increments a measurement, starting with 1 if it doesn't exist yet.

Parameters

string $metric the name of the metric
string $key the key

Return Value

void

at line line 91
array getMeasurements(string $metric, array $keys, string $defaultValue = 'Nan')

Gets all measurements.

Parameters

string $metric the name of the metric
array $keys the keys to retrieve
string $defaultValue the default value a key gets if there is no value for it in the storage

Return Value

array the map with the keys and values