Page MenuHomeWickedGov Phorge
Files F5958138

BaseMetricInterface.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

BaseMetricInterface.php
View Options

<?php
/**
* @license GPL-2.0-or-later
* @file
*/
declare( strict_types=1 );
namespace Wikimedia\Stats\Metrics;
use Wikimedia\Stats\IBufferingStatsdDataFactory;
use Wikimedia\Stats\Sample;
/**
* Base Metric Interface
*
* Interface for defining a Base Metric.
*
* @author Cole White
* @since 1.41
*/
interface BaseMetricInterface {
/**
* @param string $component The component this metric will track.
* @param string $name The Metric Name.
*/
public function __construct( string $component, string $name );
/**
* Records a Metric Sample.
*
* @param Sample $sample
* @return void
*/
public function addSample( Sample $sample ): void;
/**
* Returns the configured sample rate.
*
* @return float
*/
public function getSampleRate(): float;
public function setSampleRate( float $sampleRate ): void;
/**
* Returns subset of samples corresponding to sample rate setting.
*
* @return Sample[]
*/
public function getSamples(): array;
/**
* Returns a count of samples recorded by the metric.
*
* @return int
*/
public function getSampleCount(): int;
/**
* Returns the Metric Name
*
* @return string
*/
public function getName(): string;
/**
* Add a label with key => value.
* Note that the order in which labels are added is significant for StatsD output.
*
* Example:
* ```php
* $statsFactory->withComponent( 'demo' )
* ->getCounter( 'testMetric_total' )
* ->setLabel( 'first', 'foo' )
* ->setLabel( 'second', 'bar' )
* ->setLabel( 'third', 'baz' )
* ->increment();
* ```
* statsd: "mediawiki.demo.testMetric_total.foo.bar.baz"
* prometheus: "mediawiki_demo_testMetric_total{first='foo',second='bar',third='baz'}
*
* @param string $key
* @param string $value
* @return void
*/
public function addLabel( string $key, string $value ): void;
/**
* Returns array of label keys.
*
* @return string[]
*/
public function getLabelKeys(): array;
/**
* Returns an array of label values in the order of label keys.
*
* @return string[]
*/
public function getLabelValues(): array;
/**
* Returns the Metric Component
*
* @return string
*/
public function getComponent(): string;
/**
* Clears the working labels.
*
* @return void
*/
public function clearLabels(): void;
/**
* Gets StatsD Data Factory instance or null.
*/
public function getStatsdDataFactory();
/**
* Validates and sets legacy StatsD namespaces.
*
* @param string|string[] $statsdNamespaces
* @return void
*/
public function setStatsdNamespaces( $statsdNamespaces ): void;
/**
* Returns the configured legacy StatsD namespaces.
*
* @return string[]
*/
public function getStatsdNamespaces(): array;
/**
* StatsD Data Factory instance to copy metrics to.
*
* @param IBufferingStatsdDataFactory|null $statsdDataFactory
*
* @return self
*/
public function withStatsdDataFactory( ?IBufferingStatsdDataFactory $statsdDataFactory );
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 05:35 (2 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
3d/31/2cd659f8d4fd5488b8f65f5d3ce7
Default Alt Text
BaseMetricInterface.php (2 KB)

Event Timeline