MediaWiki master
Wikimedia\Stats\Metrics\CounterMetric Class Reference

Counter Metric Implementation. More...

Inherits Wikimedia\Stats\Metrics\MetricInterface.

Collaboration diagram for Wikimedia\Stats\Metrics\CounterMetric:

Public Member Functions

 __construct ( $baseMetric, $logger)
 
 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

 
 fresh ()
 Returns metric with cleared labels.
Returns
CounterMetric|GaugeMetric|TimingMetric|NullMetric

 
 getComponent ()
 
Returns
string

 
 getLabelKeys ()
 Returns the list of defined label keys.
Returns
string[]

 
 getName ()
 
Returns
string

 
 getSampleCount ()
 Returns a count of samples recorded by the metric.
Returns
int

 
 getSampleRate ()
 
Returns
float

 
 getSamples ()
 Returns subset of samples corresponding to sample rate setting.
Returns
Sample[]

 
 getTypeIndicator ()
 
Returns
string

 
 increment ()
 Increments metric by one.
 
 incrementBy (float $value)
 Increments metric by provided value.
 
 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

 
 setSampleRate (float $sampleRate)
 Sets sample rate on a new metric instance.
Parameters
float$sampleRate
Returns
CounterMetric|GaugeMetric|TimingMetric|NullMetric

 
- Public Member Functions inherited from Wikimedia\Stats\Metrics\MetricInterface
 __construct (BaseMetricInterface $baseMetric, LoggerInterface $logger)
 

Detailed Description

Counter Metric Implementation.

Counter Metrics only ever increase and are identified by type "c".

Author
Cole White
Since
1.38

Definition at line 37 of file CounterMetric.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Stats\Metrics\CounterMetric::__construct (   $baseMetric,
  $logger 
)

Definition at line 55 of file CounterMetric.php.

Member Function Documentation

◆ copyToStatsdAt()

Wikimedia\Stats\Metrics\CounterMetric::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

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 148 of file CounterMetric.php.

◆ fresh()

Wikimedia\Stats\Metrics\CounterMetric::fresh ( )

Returns metric with cleared labels.

Returns
CounterMetric|GaugeMetric|TimingMetric|NullMetric

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 160 of file CounterMetric.php.

◆ getComponent()

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

Returns
string

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 94 of file CounterMetric.php.

◆ getLabelKeys()

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

Returns the list of defined label keys.

Returns
string[]

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 131 of file CounterMetric.php.

◆ getName()

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

Returns
string

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 89 of file CounterMetric.php.

◆ getSampleCount()

Wikimedia\Stats\Metrics\CounterMetric::getSampleCount ( )

Returns a count of samples recorded by the metric.

Returns
int

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 109 of file CounterMetric.php.

◆ getSampleRate()

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

Returns
float

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 114 of file CounterMetric.php.

◆ getSamples()

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

Returns subset of samples corresponding to sample rate setting.

Returns
Sample[]

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 104 of file CounterMetric.php.

◆ getTypeIndicator()

Wikimedia\Stats\Metrics\CounterMetric::getTypeIndicator ( )

Returns
string

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 99 of file CounterMetric.php.

◆ increment()

Wikimedia\Stats\Metrics\CounterMetric::increment ( )

Increments metric by one.

Returns
void

Definition at line 65 of file CounterMetric.php.

◆ incrementBy()

Wikimedia\Stats\Metrics\CounterMetric::incrementBy ( float  $value)

Increments metric by provided value.

Parameters
float$value
Returns
void

Definition at line 75 of file CounterMetric.php.

◆ setLabel()

Wikimedia\Stats\Metrics\CounterMetric::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

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 136 of file CounterMetric.php.

◆ setSampleRate()

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

Sets sample rate on a new metric instance.

Parameters
float$sampleRate
Returns
CounterMetric|GaugeMetric|TimingMetric|NullMetric

Implements Wikimedia\Stats\Metrics\MetricInterface.

Definition at line 119 of file CounterMetric.php.


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