Page MenuHomeWickedGov Phorge
Files F1427391

StatsFactory.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

StatsFactory.php
View Options

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
* @file
*/
declare( strict_types=1 );
namespace Wikimedia\Stats;
use InvalidArgumentException;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use TypeError;
use Wikimedia\Stats\Emitters\EmitterInterface;
use Wikimedia\Stats\Emitters\NullEmitter;
use Wikimedia\Stats\Exceptions\InvalidConfigurationException;
use Wikimedia\Stats\Metrics\BaseMetric;
use Wikimedia\Stats\Metrics\CounterMetric;
use Wikimedia\Stats\Metrics\GaugeMetric;
use Wikimedia\Stats\Metrics\NullMetric;
use Wikimedia\Stats\Metrics\TimingMetric;
/**
* StatsFactory Implementation
*
* This is the primary interface for validating metrics definitions
* caching defined metrics, and returning metric instances from cache
* if previously defined.
*
* @author Cole White
* @since 1.41
*/
class StatsFactory {
/** @var string */
private string $component;
/** @var StatsCache */
private StatsCache $cache;
/** @var EmitterInterface */
private EmitterInterface $emitter;
/** @var LoggerInterface */
private LoggerInterface $logger;
/** @var IBufferingStatsdDataFactory|null */
private ?IBufferingStatsdDataFactory $statsdDataFactory = null;
/**
* StatsFactory builds, configures, and caches Metrics.
*
* @param StatsCache $cache
* @param EmitterInterface $emitter
* @param LoggerInterface $logger
* @param string $component
*/
public function __construct(
StatsCache $cache,
EmitterInterface $emitter,
LoggerInterface $logger,
string $component = ''
) {
$this->component = StatsUtils::normalizeString( $component );
$this->cache = $cache;
$this->emitter = $emitter;
$this->logger = $logger;
}
/**
* Returns a new StatsFactory instance prefixed by component.
*
* @param string $component
* @return StatsFactory
*/
public function withComponent( string $component ): StatsFactory {
$statsFactory = new StatsFactory( $this->cache, $this->emitter, $this->logger, $component );
return $statsFactory->withStatsdDataFactory( $this->statsdDataFactory );
}
public function withStatsdDataFactory( ?IBufferingStatsdDataFactory $statsdDataFactory ): StatsFactory {
$this->statsdDataFactory = $statsdDataFactory;
return $this;
}
/**
* Makes a new CounterMetric or fetches one from cache.
*
* If a collision occurs, returns a NullMetric to suppress exceptions.
*
* @param string $name
* @return CounterMetric|NullMetric
*/
public function getCounter( string $name ) {
return $this->getMetric( $name, CounterMetric::class );
}
/**
* Makes a new GaugeMetric or fetches one from cache.
*
* If a collision occurs, returns a NullMetric to suppress exceptions.
*
* @param string $name
* @return GaugeMetric|NullMetric
*/
public function getGauge( string $name ) {
return $this->getMetric( $name, GaugeMetric::class );
}
/**
* Makes a new TimingMetric or fetches one from cache.
*
* If a collision occurs, returns a NullMetric to suppress exceptions.
*
* @param string $name
* @return TimingMetric|NullMetric
*/
public function getTiming( string $name ) {
return $this->getMetric( $name, TimingMetric::class );
}
/**
* Send all buffered metrics to the target and destroy the cache.
*/
public function flush(): void {
$this->trackUsage();
$this->emitter->send();
$this->cache->clear();
}
/**
* Create a metric totaling all samples in the cache.
*/
private function trackUsage(): void {
$accumulator = 0;
foreach ( $this->cache->getAllMetrics() as $metric ) {
$accumulator += $metric->getSampleCount();
}
$this->getCounter( 'stats_buffered_total' )
->copyToStatsdAt( 'stats.statslib.buffered' )
->incrementBy( $accumulator );
}
/**
* Fetches a metric from cache or makes a new metric.
*
* If a metric name collision occurs, returns a NullMetric to suppress runtime exceptions.
*
* @param string $name
* @param string $className
* @return CounterMetric|TimingMetric|GaugeMetric|NullMetric
*/
private function getMetric( string $name, string $className ) {
$name = StatsUtils::normalizeString( $name );
StatsUtils::validateMetricName( $name );
try {
$metric = $this->cache->get( $this->component, $name, $className );
} catch ( TypeError | InvalidArgumentException | InvalidConfigurationException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( $ex->getMessage(), E_USER_WARNING );
return new NullMetric;
}
if ( $metric === null ) {
$baseMetric = new BaseMetric( $this->component, $name );
$metric = new $className( $baseMetric->withStatsdDataFactory( $this->statsdDataFactory ), $this->logger );
$this->cache->set( $this->component, $name, $metric );
}
return $metric->fresh();
}
/**
* Returns an instance of StatsFactory as a NULL value object
* as a default for consumer code to fall back to. This can also
* be used in tests environment where we don't need the full
* UDP emitter object.
*
* @since 1.42
*
* @return self
*/
public static function newNull(): self {
return new self( new StatsCache(), new NullEmitter(), new NullLogger() );
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 14:34 (1 d, 8 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
1e/a8/1cbc127803c2c3f489a6f3a2ab52
Default Alt Text
StatsFactory.php (5 KB)

Event Timeline