Wikimedia\Stats\Metrics\MetricInterface Interface Reference

Metric Interface. More...

Inherited by Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

Public Member Functions
	__construct (BaseMetricInterface $baseMetric, LoggerInterface $logger)
	copyToStatsdAt ( $statsdNamespaces)
	Copies metric operation to StatsD at provided namespace.
	fresh ()
	Returns metric with cleared labels.
	getComponent ()
	getLabelKeys ()
	Returns the list of defined label keys.
	getName ()
	getSampleCount ()
	Returns a count of samples recorded by the metric.
	getSampleRate ()
	getSamples ()
	Returns subset of samples corresponding to sample rate setting.
	getTypeIndicator ()
	setLabel (string $key, string $value)
	Adds a label $key with $value.
	setSampleRate (float $sampleRate)
	Sets sample rate on a new metric instance.

Detailed Description

Metric Interface.

Author

Cole White

Since

1.41

Definition at line 31 of file MetricInterface.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\Stats\Metrics\MetricInterface::__construct	(	BaseMetricInterface	$baseMetric,
		LoggerInterface	$logger )

Parameters

BaseMetricInterface	$baseMetric
LoggerInterface	$logger

Member Function Documentation

copyToStatsdAt()

Wikimedia\Stats\Metrics\MetricInterface::copyToStatsdAt

(

$statsdNamespaces

)

Copies metric operation to StatsD at provided namespace.

Takes a namespace or multiple namespaces.

Parameters

string | string[]

$statsdNamespaces

Returns

CounterMetric|GaugeMetric|TimingMetric|NullMetric

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

fresh()

Wikimedia\Stats\Metrics\MetricInterface::fresh

(

)

Returns metric with cleared labels.

Returns

CounterMetric|GaugeMetric|TimingMetric|NullMetric

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

getComponent()

Wikimedia\Stats\Metrics\MetricInterface::getComponent

(

)

Returns

string

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

getLabelKeys()

Wikimedia\Stats\Metrics\MetricInterface::getLabelKeys

(

)

Returns the list of defined label keys.

Returns

string[]

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

getName()

Wikimedia\Stats\Metrics\MetricInterface::getName

(

)

Returns

string

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

getSampleCount()

Wikimedia\Stats\Metrics\MetricInterface::getSampleCount

(

)

Returns a count of samples recorded by the metric.

Returns

int

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

getSampleRate()

Wikimedia\Stats\Metrics\MetricInterface::getSampleRate

(

)

Returns

float

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

getSamples()

Wikimedia\Stats\Metrics\MetricInterface::getSamples

(

)

Returns subset of samples corresponding to sample rate setting.

Returns

Sample[]

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

getTypeIndicator()

Wikimedia\Stats\Metrics\MetricInterface::getTypeIndicator

(

)

Returns

string

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

setLabel()

Wikimedia\Stats\Metrics\MetricInterface::setLabel	(	string	$key,
		string	$value )

Adds a label $key with $value.

Note that the order in which labels are added is significant for StatsD output.

Example:

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

statsd: "mediawiki.testMetric_total.foo.bar" prometheus: "mediawiki_testMetric_total{ first='foo', second='bar' }

Parameters

string	$key
string	$value

Returns

CounterMetric|GaugeMetric|TimingMetric|NullMetric

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

setSampleRate()

Wikimedia\Stats\Metrics\MetricInterface::setSampleRate

(

float

$sampleRate

)

Sets sample rate on a new metric instance.

Parameters

float

$sampleRate

Returns

CounterMetric|GaugeMetric|TimingMetric|NullMetric

Implemented in Wikimedia\Stats\Metrics\CounterMetric, Wikimedia\Stats\Metrics\GaugeMetric, and Wikimedia\Stats\Metrics\TimingMetric.

---

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

• includes/libs/Stats/Metrics/MetricInterface.php