MediaWiki REL1_40
BaseMetricInterface.php
Go to the documentation of this file.
1<?php
20declare( strict_types=1 );
21
23
26
36
41 public function __construct( string $component, string $name );
42
49 public function addSample( Sample $sample ): void;
50
56 public function getSampleRate(): float;
57
63 public function setSampleRate( float $sampleRate ): void;
64
70 public function getSamples(): array;
71
77 public function getName(): string;
78
86 public function withStaticLabels( array $labelKeys, array $labelValues ): BaseMetricInterface;
87
95 public function addLabel( string $key, string $value ): void;
96
102 public function getLabelKeys(): array;
103
109 public function getLabelValues(): array;
110
116 public function getComponent(): string;
117
123 public function clearLabels(): void;
124
128 public function getStatsdDataFactory();
129
136 public function withStatsdDataFactory( IBufferingStatsdDataFactory $statsdDataFactory );
137}
Sample Data Class.
Definition Sample.php:32
MediaWiki adaptation of StatsdDataFactory that provides buffering functionality.
addLabel(string $key, string $value)
Add a label with key => value.
withStaticLabels(array $labelKeys, array $labelValues)
Configures the metric with static labels.
__construct(string $component, string $name)
setSampleRate(float $sampleRate)
Sets the sample rate.
clearLabels()
Clears the working labels.
getLabelKeys()
Returns array of label keys.
getSamples()
Returns subset of samples corresponding to sample rate setting.
getStatsdDataFactory()
Gets StatsD Data Factory instance or null.
getLabelValues()
Returns an array of label values with static label values in the order of label keys.
withStatsdDataFactory(IBufferingStatsdDataFactory $statsdDataFactory)
StatsD Data Factory instance to copy metrics to.
addSample(Sample $sample)
Records a Metric Sample.
getSampleRate()
Returns the configured sample rate.
getComponent()
Returns the Metric Component.