MediaWiki
master
MetricInterface.php
Go to the documentation of this file.
1
<?php
7
namespace
Wikimedia\Stats\Metrics
;
8
9
use Psr\Log\LoggerInterface;
10
use
Wikimedia\Stats\Sample
;
11
18
interface
MetricInterface
{
19
20
public
function
__construct
(
BaseMetricInterface
$baseMetric, LoggerInterface $logger );
21
23
public
function
getName
(): string;
24
26
public
function
getComponent
(): string;
27
29
public
function
getSampleRate
(): float;
30
32
public
function
getTypeIndicator
(): string;
33
39
public
function
getSamples
(): array;
40
46
public
function
getSampleCount
(): int;
47
54
public
function
setSampleRate
(
float
$sampleRate );
55
61
public
function
getLabelKeys
(): array;
62
81
public
function
setLabel
(
string
$key,
string
$value );
82
89
public
function
setLabels
( array $labels );
90
102
public
function
copyToStatsdAt
( $statsdNamespaces );
103
109
public
function
fresh
();
110
116
public
function
isHistogram
(): bool;
117
}
Wikimedia\Stats\Sample
A container for a metric sample to be passed to the rendering function.
Definition
Sample.php:17
Wikimedia\Stats\Metrics\BaseMetricInterface
Base Metric Interface.
Definition
BaseMetricInterface.php:22
Wikimedia\Stats\Metrics\MetricInterface
Metric Interface.
Definition
MetricInterface.php:18
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:9
includes
libs
Stats
Metrics
MetricInterface.php
Generated on Sun Dec 14 2025 16:25:25 for MediaWiki by
1.10.0