Base Metric Implementation V1. More...

Inherits Wikimedia\Stats\Metrics\BaseMetricInterface.

Collaboration diagram for Wikimedia\Stats\Metrics\BaseMetric:

Public Member Functions

__construct (string $component, string $name)

Parameters

string	$component	The component this metric will track.
string	$name	The Metric Name.

addLabel (string $key, string $value)

Add a label with key => value.

Parameters

string	$key
string	$value

Returns: void

addSample (Sample $sample)

Records a Metric Sample.

Parameters

Sample $sample

Returns: void

clearLabels ()

Clears the working labels.

Returns: void

getComponent ()

Returns the Metric Component.

Returns: string

getLabelKeys ()

getLabelValues ()

Combines the provided associative array of labels with the associative array of staticLabels and returns the values in the order of labelKeys.

getName ()

Returns the Metric Name.

Returns: string

getSampleRate ()

Returns the configured sample rate.

Returns: float

getSamples ()

Returns subset of samples corresponding to sample rate setting.

Returns: Sample[]

getStatsdDataFactory ()

Gets StatsD Data Factory instance or null.

setSampleRate (float $sampleRate)

Sets the sample rate.

Parameters

float $sampleRate

withStaticLabels (array $labelKeys, array $labelValues)

Configures the metric with static labels.

Parameters

string[]	$labelKeys
string[]	$labelValues

Returns: BaseMetricInterface

withStatsdDataFactory ( $statsdDataFactory)

Public Member Functions inherited from Wikimedia\Stats\Metrics\BaseMetricInterface

withStatsdDataFactory (IBufferingStatsdDataFactory $statsdDataFactory)

StatsD Data Factory instance to copy metrics to.

Detailed Description

Base Metric Implementation V1.

Implements shared Metric functionality:

Label validation and handling
Sample rate validation and handling
Sample generation
Common properties
StatsD transition support

Author: Cole White

Since: 1.41

Definition at line 42 of file BaseMetric.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Stats\Metrics\BaseMetric::__construct	(	string	$component,
		string	$name )

Parameters

string	$component	The component this metric will track.
string	$name	The Metric Name.

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 69 of file BaseMetric.php.

References Wikimedia\Stats\StatsUtils\normalizeString().

Member Function Documentation

◆ addLabel()

Wikimedia\Stats\Metrics\BaseMetric::addLabel	(	string	$key,
		string	$value )

Add a label with key => value.

Parameters

string	$key
string	$value

Returns: void

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 112 of file BaseMetric.php.

◆ addSample()

Wikimedia\Stats\Metrics\BaseMetric::addSample ( Sample $sample )

Records a Metric Sample.

Parameters

Sample $sample

Returns: void

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 75 of file BaseMetric.php.

◆ clearLabels()

Wikimedia\Stats\Metrics\BaseMetric::clearLabels ( )

Clears the working labels.

Returns: void

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 176 of file BaseMetric.php.

◆ getComponent()

Wikimedia\Stats\Metrics\BaseMetric::getComponent ( )

Returns the Metric Component.

Returns: string

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 181 of file BaseMetric.php.

◆ getLabelKeys()

Wikimedia\Stats\Metrics\BaseMetric::getLabelKeys ( )

Returns: string[]

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 155 of file BaseMetric.php.

◆ getLabelValues()

Wikimedia\Stats\Metrics\BaseMetric::getLabelValues ( )

Combines the provided associative array of labels with the associative array of staticLabels and returns the values in the order of labelKeys.

Returns: string[]

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 166 of file BaseMetric.php.

◆ getName()

Wikimedia\Stats\Metrics\BaseMetric::getName ( )

Returns the Metric Name.

Returns: string

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 90 of file BaseMetric.php.

◆ getSampleRate()

Wikimedia\Stats\Metrics\BaseMetric::getSampleRate ( )

Returns the configured sample rate.

Returns: float

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 95 of file BaseMetric.php.

◆ getSamples()

Wikimedia\Stats\Metrics\BaseMetric::getSamples ( )

Returns subset of samples corresponding to sample rate setting.

Returns: Sample[]

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 100 of file BaseMetric.php.

◆ getStatsdDataFactory()

Wikimedia\Stats\Metrics\BaseMetric::getStatsdDataFactory ( )

Gets StatsD Data Factory instance or null.

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 121 of file BaseMetric.php.

◆ setSampleRate()

Wikimedia\Stats\Metrics\BaseMetric::setSampleRate ( float $sampleRate )

Sets the sample rate.

Parameters

float $sampleRate

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 80 of file BaseMetric.php.

◆ withStaticLabels()

Wikimedia\Stats\Metrics\BaseMetric::withStaticLabels	(	array	$labelKeys,
		array	$labelValues )

Configures the metric with static labels.

Parameters

string[]	$labelKeys
string[]	$labelValues

Returns: BaseMetricInterface

Implements Wikimedia\Stats\Metrics\BaseMetricInterface.

Definition at line 105 of file BaseMetric.php.

◆ withStatsdDataFactory()

Wikimedia\Stats\Metrics\BaseMetric::withStatsdDataFactory ( $statsdDataFactory )

Definition at line 126 of file BaseMetric.php.

The documentation for this class was generated from the following file:

includes/libs/Stats/Metrics/BaseMetric.php