Wikimedia\Stats\StatsFactory Class Reference

This is the primary interface for validating metrics definitions, caching defined metrics, and returning metric instances from cache if previously defined. More...

Public Member Functions
	__construct (StatsCache $cache, EmitterInterface $emitter, LoggerInterface $logger, ?string $component=null)
	StatsFactory builds, configures, and caches Metrics.
	flush ()
	Send all buffered metrics to the target and destroy the cache.
	getCounter (string $name)
	Makes a new CounterMetric or fetches one from cache.
	getGauge (string $name)
	Makes a new GaugeMetric or fetches one from cache.
	getTiming (string $name)
	Makes a new TimingMetric or fetches one from cache.
	withComponent (string $component)
	Returns a new StatsFactory instance prefixed by component.
	withStatsdDataFactory (?IBufferingStatsdDataFactory $statsdDataFactory)

Static Public Member Functions
static	newNull ()
	Returns an instance of StatsFactory as a NULL value object as a default for consumer code to fall back to.

Detailed Description

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

Definition at line 45 of file StatsFactory.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\Stats\StatsFactory::__construct	(	StatsCache	$cache,
		EmitterInterface	$emitter,
		LoggerInterface	$logger,
		?string	$component = null )

StatsFactory builds, configures, and caches Metrics.

Definition at line 57 of file StatsFactory.php.

References Wikimedia\Stats\StatsUtils\normalizeString().

Member Function Documentation

flush()

Wikimedia\Stats\StatsFactory::flush

(

)

Send all buffered metrics to the target and destroy the cache.

Definition at line 126 of file StatsFactory.php.

Referenced by MediaWiki\MediaWikiEntryPoint\emitBufferedStats().

getCounter()

Wikimedia\Stats\StatsFactory::getCounter

(

string

$name

)

Makes a new CounterMetric or fetches one from cache.

If a collision occurs, returns a NullMetric to suppress exceptions.

Parameters

string

$name

Returns

CounterMetric|NullMetric

Definition at line 95 of file StatsFactory.php.

getGauge()

Wikimedia\Stats\StatsFactory::getGauge

(

string

$name

)

Makes a new GaugeMetric or fetches one from cache.

If a collision occurs, returns a NullMetric to suppress exceptions.

Parameters

string

$name

Returns

GaugeMetric|NullMetric

Definition at line 107 of file StatsFactory.php.

getTiming()

Wikimedia\Stats\StatsFactory::getTiming

(

string

$name

)

Makes a new TimingMetric or fetches one from cache.

If a collision occurs, returns a NullMetric to suppress exceptions.

Parameters

string

$name

Returns

TimingMetric|NullMetric

Definition at line 119 of file StatsFactory.php.

newNull()

static Wikimedia\Stats\StatsFactory::newNull ( )

static

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

Returns

self

Definition at line 182 of file StatsFactory.php.

withComponent()

Wikimedia\Stats\StatsFactory::withComponent

(

string

$component

)

Returns a new StatsFactory instance prefixed by component.

Parameters

string

$component

Returns

StatsFactory

Definition at line 77 of file StatsFactory.php.

withStatsdDataFactory()

Wikimedia\Stats\StatsFactory::withStatsdDataFactory

(

?IBufferingStatsdDataFactory

$statsdDataFactory

)

Definition at line 82 of file StatsFactory.php.

---

The documentation for this class was generated from the following file:

• includes/libs/Stats/StatsFactory.php