GaugeMetric.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

GaugeMetric.php
View Options

	<?php
	/**
	* @license GPL-2.0-or-later
	* @file
	*/

	declare( strict_types=1 );

	namespace Wikimedia\Stats\Metrics;

	use Wikimedia\Stats\Exceptions\IllegalOperationException;
	use Wikimedia\Stats\Sample;

	/**
	* Gauge Metric Implementation
	*
	* Gauge Metrics can be set to any numeric value and are identified by type "g".
	*
	* @author Cole White
	* @since 1.38
	*/
	class GaugeMetric implements MetricInterface {
	use MetricTrait;

	/**
	* The StatsD protocol type indicator:
	* https://github.com/statsd/statsd/blob/v0.9.0/docs/metric_types.md
	* https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=metrics
	*/
	private const TYPE_INDICATOR = "g";

	/**
	* Sets metric to value.
	*
	* @param float $value
	* @return void
	*/
	public function set( float $value ): void {
	foreach ( $this->baseMetric->getStatsdNamespaces() as $namespace ) {
	$this->baseMetric->getStatsdDataFactory()->gauge( $namespace, $value );
	}

	try {
	$this->baseMetric->addSample( new Sample( $this->baseMetric->getLabelValues(), $value ) );
	} catch ( IllegalOperationException $ex ) {
	// Log the condition and give the caller something that will absorb calls.
	trigger_error( "Stats: ({$this->getName()}): {$ex->getMessage()}", E_USER_WARNING );
	}
	}

	/** @inheritDoc */
	public function getTypeIndicator(): string {
	return self::TYPE_INDICATOR;
	}
	}