MediaWiki master
|
Counter Metric Implementation. More...
Inherits Wikimedia\Stats\Metrics\MetricInterface.
Public Member Functions | |||||||
__construct ( $baseMetric, $logger) | |||||||
copyToStatsdAt ( $statsdNamespaces) | |||||||
Copies metric operation to StatsD at provided namespace.Takes a namespace or multiple namespaces.
| |||||||
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 () | |||||||
| |||||||
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' }
| |||||||
setSampleRate (float $sampleRate) | |||||||
Sets sample rate on a new metric instance.
| |||||||
Public Member Functions inherited from Wikimedia\Stats\Metrics\MetricInterface | |||||||
__construct (BaseMetricInterface $baseMetric, LoggerInterface $logger) | |||||||
Counter Metric Implementation.
Counter Metrics only ever increase and are identified by type "c".
Definition at line 37 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::__construct | ( | $baseMetric, | |
$logger | |||
) |
Definition at line 55 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::copyToStatsdAt | ( | $statsdNamespaces | ) |
Copies metric operation to StatsD at provided namespace.Takes a namespace or multiple namespaces.
string | string[] | $statsdNamespaces |
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 148 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::fresh | ( | ) |
Returns metric with cleared labels.
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 160 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::getComponent | ( | ) |
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 94 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::getLabelKeys | ( | ) |
Returns the list of defined label keys.
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 131 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::getName | ( | ) |
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 89 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::getSampleCount | ( | ) |
Returns a count of samples recorded by the metric.
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 109 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::getSampleRate | ( | ) |
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 114 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::getSamples | ( | ) |
Returns subset of samples corresponding to sample rate setting.
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 104 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::getTypeIndicator | ( | ) |
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 99 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::increment | ( | ) |
Wikimedia\Stats\Metrics\CounterMetric::incrementBy | ( | float | $value | ) |
Increments metric by provided value.
float | $value |
Definition at line 75 of file CounterMetric.php.
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:
statsd: "mediawiki.testMetric_total.foo.bar" prometheus: "mediawiki_testMetric_total{ first='foo', second='bar' }
string | $key | |
string | $value |
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 136 of file CounterMetric.php.
Wikimedia\Stats\Metrics\CounterMetric::setSampleRate | ( | float | $sampleRate | ) |
Sets sample rate on a new metric instance.
float | $sampleRate |
Implements Wikimedia\Stats\Metrics\MetricInterface.
Definition at line 119 of file CounterMetric.php.