Wikimedia\Stats\StatsUtils Class Reference

Functionality common to all metric types. More...

Static Public Member Functions
static	getFilteredSamples (float $sampleRate, array $samples)
	Returns a subset of samples based on configured sample rate.
static	normalizeArray (array $entities)
	Normalize an array of strings.
static	normalizeString (string $entity)
	Normalize strings to a metrics-compatible format.
static	validateLabelKey (string $key)
	Determines if provided string is a valid label key.
static	validateLabelValue (string $value)
static	validateMetricName (string $name)
	Determines if provided string is a valid name.
static	validateNewSampleRate (float $newSampleRate)
	Validates the new sample rate.

Public Attributes
const	DEFAULT_SAMPLE_RATE = 1.0
const	RE_VALID_NAME_AND_LABEL_NAME = "/^[a-zA-Z_][a-zA-Z0-9_]*$/"

Detailed Description

Functionality common to all metric types.

Author

Cole White

Since

1.38

Definition at line 33 of file StatsUtils.php.

Member Function Documentation

getFilteredSamples()

static Wikimedia\Stats\StatsUtils::getFilteredSamples ( float $sampleRate, array $samples )

static

Returns a subset of samples based on configured sample rate.

Parameters

float	$sampleRate
array	$samples

Returns

array

Definition at line 57 of file StatsUtils.php.

normalizeArray()

static Wikimedia\Stats\StatsUtils::normalizeArray ( array $entities )

static

Normalize an array of strings.

Parameters

string[]

$entities

Returns

string[]

Definition at line 117 of file StatsUtils.php.

normalizeString()

static Wikimedia\Stats\StatsUtils::normalizeString ( string $entity )

static

Normalize strings to a metrics-compatible format.

Replace all other non-alphanumeric characters with an underscore. Trim leading or trailing underscores.

Parameters

string

$entity

Returns

string

Definition at line 134 of file StatsUtils.php.

Referenced by Wikimedia\Stats\StatsFactory\__construct(), and Wikimedia\Stats\Metrics\BaseMetric\__construct().

validateLabelKey()

static Wikimedia\Stats\StatsUtils::validateLabelKey ( string $key )

static

Determines if provided string is a valid label key.

Parameters

string

$key

Returns

void

Exceptions

InvalidArgumentException
InvalidConfigurationException

Definition at line 96 of file StatsUtils.php.

validateLabelValue()

static Wikimedia\Stats\StatsUtils::validateLabelValue ( string $value )

static

Definition at line 105 of file StatsUtils.php.

validateMetricName()

static Wikimedia\Stats\StatsUtils::validateMetricName ( string $name )

static

Determines if provided string is a valid name.

Parameters

string

$name

Returns

void

Exceptions

InvalidArgumentException
InvalidConfigurationException

Definition at line 79 of file StatsUtils.php.

validateNewSampleRate()

static Wikimedia\Stats\StatsUtils::validateNewSampleRate ( float $newSampleRate )

static

Validates the new sample rate.

Throws InvalidArgumentException if provided an invalid rate.

Parameters

float

$newSampleRate

Exceptions

InvalidArgumentException

Definition at line 44 of file StatsUtils.php.

Member Data Documentation

DEFAULT_SAMPLE_RATE

const Wikimedia\Stats\StatsUtils::DEFAULT_SAMPLE_RATE = 1.0

Definition at line 36 of file StatsUtils.php.

RE_VALID_NAME_AND_LABEL_NAME

const Wikimedia\Stats\StatsUtils::RE_VALID_NAME_AND_LABEL_NAME = "/^[a-zA-Z_][a-zA-Z0-9_]*$/"

Definition at line 35 of file StatsUtils.php.

---

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

• includes/libs/Stats/StatsUtils.php