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.Note that the order in which labels are added is significant for StatsD output.Example:

$statsFactory->withComponent( 'demo' )
    ->getCounter( 'testMetric_total' )
    ->setLabel( 'first', 'foo' )
    ->setLabel( 'second', 'bar' )
    ->setLabel( 'third', 'baz' )
    ->increment();

statsd: "mediawiki.demo.testMetric_total.foo.bar.baz" prometheus: "mediawiki_demo_testMetric_total{first='foo',second='bar',third='baz'}

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 ()

Returns array of label keys.

Returns: string[]

getLabels ()

Returns the defined labels as an associative array.

Returns: array<string,string>

getLabelValues ()

Returns an array of label values in the order of label keys.

Returns: string[]

getName ()

Returns the Metric Name.

Returns: string

getSampleCount ()

Returns a count of samples recorded by the metric.

Returns: int

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.

getStatsdNamespaces ()

Returns the configured legacy StatsD namespaces.

Returns: string[]

setSampleRate (float $sampleRate)

setStatsdNamespaces ( $statsdNamespaces)

Validates and sets legacy StatsD namespaces.

Parameters

string | string[] $statsdNamespaces

Returns: void

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 31 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 49 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.Note that the order in which labels are added is significant for StatsD output.Example:

$statsFactory->withComponent( 'demo' )
    ->getCounter( 'testMetric_total' )
    ->setLabel( 'first', 'foo' )
    ->setLabel( 'second', 'bar' )
    ->setLabel( 'third', 'baz' )
    ->increment();