A factory for application metric data. More...

Inheritance diagram for BufferingStatsdDataFactory:

[legend]

Collaboration diagram for BufferingStatsdDataFactory:

[legend]

Public Member Functions
	__construct ( $prefix)

	clearData ()
	Clear all buffered data from the factory.

	getBuffer ()

	getData ()
	Return the buffered data from the factory.

	getDataCount ()
	Return the number of buffered statsd data entries.

	hasData ()
	Check whether this data factory has any buffered data.

	produceStatsdData ( $key, $value=1, $metric=StatsdDataInterface::STATSD_METRIC_COUNT)

	setEnabled ( $enabled)
	Set collection enable status.

Protected Attributes
	$buffer = []

bool	$enabled = true
	Collection enabled?

Static Private Member Functions
static	normalizeMetricKey ( $key)
	Normalize a metric key for StatsD.

Private Attributes
string	$prefix

Detailed Description

A factory for application metric data.

This class prepends a context-specific prefix to each metric key and keeps a reference to each constructed metric in an internal array buffer.

Since: 1.25

Definition at line 35 of file BufferingStatsdDataFactory.php.

Constructor & Destructor Documentation

◆ __construct()

BufferingStatsdDataFactory::__construct ( $prefix )

Definition at line 47 of file BufferingStatsdDataFactory.php.

References $prefix.

Member Function Documentation

◆ clearData()

BufferingStatsdDataFactory::clearData ( )

Clear all buffered data from the factory.

Since: 1.31

Implements IBufferingStatsdDataFactory.

Definition at line 110 of file BufferingStatsdDataFactory.php.

◆ getBuffer()

BufferingStatsdDataFactory::getBuffer ( )

Deprecated: Use getData()

Returns: StatsdData[]

Definition at line 98 of file BufferingStatsdDataFactory.php.

References $buffer.

◆ getData()

BufferingStatsdDataFactory::getData ( )

Return the buffered data from the factory.

Returns: StatsdData[]

Implements IBufferingStatsdDataFactory.

Definition at line 106 of file BufferingStatsdDataFactory.php.

References $buffer.

◆ getDataCount()

BufferingStatsdDataFactory::getDataCount ( )

Return the number of buffered statsd data entries.

Returns: int

Since: 1.31

Implements IBufferingStatsdDataFactory.

Definition at line 114 of file BufferingStatsdDataFactory.php.

◆ hasData()

BufferingStatsdDataFactory::hasData ( )

Check whether this data factory has any buffered data.

Returns: bool

Implements IBufferingStatsdDataFactory.

Definition at line 102 of file BufferingStatsdDataFactory.php.

◆ normalizeMetricKey()

static BufferingStatsdDataFactory::normalizeMetricKey ( $key )

staticprivate

Normalize a metric key for StatsD.

Replace occurences of '::' with dots and any other non-alphanumeric characters with underscores. Combine runs of dots or underscores. Then trim leading or trailing dots or underscores.

Parameters

string $key