Page MenuHomeWickedGov Phorge
Files F5981309

MetricTrait.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

MetricTrait.php
View Options

<?php
/**
* @license GPL-2.0-or-later
* @file
*/
declare( strict_types=1 );
namespace Wikimedia\Stats\Metrics;
use InvalidArgumentException;
use Psr\Log\LoggerInterface;
use Wikimedia\Stats\Exceptions\IllegalOperationException;
/**
* Implementation code common to all metric types.
*
* @internal
* @since 1.43
*/
trait MetricTrait {
private BaseMetricInterface $baseMetric;
private LoggerInterface $logger;
private ?string $bucket = null;
/** @inheritDoc */
public function __construct( $baseMetric, $logger ) {
$this->baseMetric = $baseMetric;
$this->logger = $logger;
}
/** @inheritDoc */
public function getName(): string {
return $this->baseMetric->getName();
}
/** @inheritDoc */
public function getComponent(): string {
return $this->baseMetric->getComponent();
}
/** @inheritDoc */
public function getSamples(): array {
return $this->baseMetric->getSamples();
}
/** @inheritDoc */
public function getSampleCount(): int {
return $this->baseMetric->getSampleCount();
}
/** @inheritDoc */
public function getSampleRate(): float {
return $this->baseMetric->getSampleRate();
}
/** @inheritDoc */
public function setSampleRate( float $sampleRate ) {
try {
$this->baseMetric->setSampleRate( $sampleRate );
} catch ( IllegalOperationException | InvalidArgumentException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( "Stats: ({$this->getName()}) {$ex->getMessage()}", E_USER_WARNING );
return new NullMetric;
}
return $this;
}
/** @inheritDoc */
public function getLabelKeys(): array {
$labelKeys = $this->baseMetric->getLabelKeys();
if ( $this->bucket ) {
$labelKeys[] = 'le';
}
return $labelKeys;
}
/** @inheritDoc */
public function setLabel( string $key, string $value ) {
if ( strcasecmp( $key, 'le' ) === 0 ) {
trigger_error( "Stats: ({$this->getName()}) 'le' cannot be used as a label key", E_USER_WARNING );
return new NullMetric();
}
try {
$this->baseMetric->addLabel( $key, $value );
} catch ( IllegalOperationException | InvalidArgumentException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( "Stats: ({$this->getName()}) {$ex->getMessage()}", E_USER_WARNING );
return new NullMetric;
}
return $this;
}
/** @inheritDoc */
public function setLabels( array $labels ) {
foreach ( $labels as $key => $value ) {
$metric = $this->setLabel( $key, $value );
if ( $metric instanceof NullMetric ) {
return $metric;
}
}
return $this;
}
/** @inheritDoc */
public function copyToStatsdAt( $statsdNamespaces ) {
try {
$this->baseMetric->setStatsdNamespaces( $statsdNamespaces );
} catch ( InvalidArgumentException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( "Stats: ({$this->getName()}) {$ex->getMessage()}", E_USER_WARNING );
return new NullMetric;
}
return $this;
}
/** @inheritDoc */
public function fresh(): self {
$this->baseMetric->clearLabels();
return $this;
}
/** @inheritDoc */
public function isHistogram(): bool {
return ( $this instanceof CounterMetric && $this->bucket !== null );
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 21:49 (1 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
09/46/3d8328a1b391076453efb3369b6f
Default Alt Text
MetricTrait.php (3 KB)

Event Timeline