Wikimedia\Stats\StatsFactory Class Reference

StatsFactory Implementation. More...

Public Member Functions
	__construct (string $component, StatsCache $cache, EmitterInterface $emitter, LoggerInterface $logger)
	StatsFactory builds, configures, and caches Metrics. More...
	flush ()
	Send all buffered metrics to the target and destroy the cache. More...
	getCounter (string $name)
	Makes a new CounterMetric or fetches one from cache. More...
	getGauge (string $name)
	Makes a new GaugeMetric or fetches one from cache. More...
	getTiming (string $name)
	Makes a new TimingMetric or fetches one from cache. More...
	withStaticLabel (string $key, string $value)
	Adds a label key-value pair to all metrics created by this StatsFactory instance. More...
	withStatsdDataFactory (IBufferingStatsdDataFactory $statsdDataFactory)

Detailed Description

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

Definition at line 47 of file StatsFactory.php.

Constructor & Destructor Documentation

__construct()

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

StatsFactory builds, configures, and caches Metrics.

Parameters

string	$component
StatsCache	$cache
EmitterInterface	$emitter
LoggerInterface	$logger

Definition at line 78 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 164 of file StatsFactory.php.

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 133 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 145 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 157 of file StatsFactory.php.

withStaticLabel()

Wikimedia\Stats\StatsFactory::withStaticLabel	(	string	$key,
		string	$value
	)

Adds a label key-value pair to all metrics created by this StatsFactory instance.

Parameters

string	$key
string	$value

Returns

$this

Definition at line 109 of file StatsFactory.php.

withStatsdDataFactory()

Wikimedia\Stats\StatsFactory::withStatsdDataFactory

(

IBufferingStatsdDataFactory

$statsdDataFactory

)

Definition at line 120 of file StatsFactory.php.

---

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

• includes/libs/Stats/StatsFactory.php