MediaWiki
master
MetricInterface.php
Go to the documentation of this file.
1
<?php
20
namespace
Wikimedia\Stats\Metrics
;
21
22
use Psr\Log\LoggerInterface;
23
use
Wikimedia\Stats\Sample
;
24
31
interface
MetricInterface
{
32
33
public
function
__construct
(
BaseMetricInterface
$baseMetric, LoggerInterface $logger );
34
36
public
function
getName
(): string;
37
39
public
function
getComponent
(): string;
40
42
public
function
getSampleRate
(): float;
43
45
public
function
getTypeIndicator
(): string;
46
52
public
function
getSamples
(): array;
53
59
public
function
getSampleCount
(): int;
60
67
public
function
setSampleRate
(
float
$sampleRate );
68
74
public
function
getLabelKeys
(): array;
75
94
public
function
setLabel
(
string
$key,
string
$value );
95
102
public
function
setLabels
( array $labels );
103
112
public
function
copyToStatsdAt
( $statsdNamespaces );
113
119
public
function
fresh
();
120
126
public
function
isHistogram
(): bool;
127
}
Wikimedia\Stats\Sample
A container for a metric sample to be passed to the rendering function.
Definition
Sample.php:30
Wikimedia\Stats\Metrics\BaseMetricInterface
Base Metric Interface.
Definition
BaseMetricInterface.php:35
Wikimedia\Stats\Metrics\MetricInterface
Metric Interface.
Definition
MetricInterface.php:31
Wikimedia\Stats\Metrics\MetricInterface\fresh
fresh()
Returns metric with cleared labels.
Wikimedia\Stats\Metrics\MetricInterface\getSamples
getSamples()
Returns subset of samples corresponding to sample rate setting.
Wikimedia\Stats\Metrics\MetricInterface\getTypeIndicator
getTypeIndicator()
Wikimedia\Stats\Metrics\MetricInterface\getSampleCount
getSampleCount()
Returns a count of samples recorded by the metric.
Wikimedia\Stats\Metrics\MetricInterface\isHistogram
isHistogram()
Indicates the metric instance is used in a Histogram.
Wikimedia\Stats\Metrics\MetricInterface\setLabels
setLabels(array $labels)
Convenience function to set a number of labels at once.
Wikimedia\Stats\Metrics\MetricInterface\__construct
__construct(BaseMetricInterface $baseMetric, LoggerInterface $logger)
Wikimedia\Stats\Metrics\MetricInterface\copyToStatsdAt
copyToStatsdAt( $statsdNamespaces)
Copies metric operation to StatsD at provided namespace.
Wikimedia\Stats\Metrics\MetricInterface\getSampleRate
getSampleRate()
Wikimedia\Stats\Metrics\MetricInterface\setLabel
setLabel(string $key, string $value)
Adds a label $key with $value.
Wikimedia\Stats\Metrics\MetricInterface\getComponent
getComponent()
Wikimedia\Stats\Metrics\MetricInterface\setSampleRate
setSampleRate(float $sampleRate)
Sets sample rate on a new metric instance.
Wikimedia\Stats\Metrics\MetricInterface\getLabelKeys
getLabelKeys()
Returns the list of defined label keys.
Wikimedia\Stats\Metrics\MetricInterface\getName
getName()
Wikimedia\Stats\Metrics
Definition
BaseMetric.php:22
includes
libs
Stats
Metrics
MetricInterface.php
Generated on Fri Apr 25 2025 18:26:05 for MediaWiki by
1.10.0