MediaWiki  1.28.0
NullStatsdDataFactory Class Reference
Inheritance diagram for NullStatsdDataFactory:
Collaboration diagram for NullStatsdDataFactory:

Public Member Functions

 decrement ($key)
 This function creates a 'decrement' StatsdData object. More...
 
 gauge ($key, $value)
 This function creates a 'gauge' StatsdData. More...
 
 increment ($key)
 This function creates a 'increment' StatsdData object. More...
 
 produceStatsdData ($key, $value=1, $metric=StatsdDataInterface::STATSD_METRIC_COUNT)
 Produce a StatsdDataInterface Object. More...
 
 set ($key, $value)
 This function creates a 'set' StatsdData object A "Set" is a count of unique events. More...
 
 timing ($key, $time)
 This function creates a 'timing' StatsdData. More...
 
 updateCount ($key, $delta)
 This function creates a 'updateCount' StatsdData object. More...
 

Detailed Description

Author
Addshore
Since
1.27

Definition at line 11 of file NullStatsdDataFactory.php.

Member Function Documentation

NullStatsdDataFactory::decrement (   $key)

This function creates a 'decrement' StatsdData object.

Parameters
string | array$keyThe metric(s) to decrement.
float | 1$sampleRateThe rate (0-1) for sampling.
Returns
mixed

Definition at line 73 of file NullStatsdDataFactory.php.

NullStatsdDataFactory::gauge (   $key,
  $value 
)

This function creates a 'gauge' StatsdData.

Parameters
string | array$keyThe metric(s) to set.
float$valueThe value for the stats.

Definition at line 28 of file NullStatsdDataFactory.php.

NullStatsdDataFactory::increment (   $key)

This function creates a 'increment' StatsdData object.

Parameters
string | array$keyThe metric(s) to increment.
float | 1$sampleRateThe rate (0-1) for sampling.
Returns
array

Definition at line 60 of file NullStatsdDataFactory.php.

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

Produce a StatsdDataInterface Object.

Parameters
string$keyThe key of the metric
int$valueThe amount to increment/decrement each metric by.
string$metricThe metric type ("c" for count, "ms" for timing, "g" for gauge, "s" for set)
Returns
StatsdDataInterface

Definition at line 99 of file NullStatsdDataFactory.php.

References $value.

NullStatsdDataFactory::set (   $key,
  $value 
)

This function creates a 'set' StatsdData object A "Set" is a count of unique events.

This data type acts like a counter, but supports counting of unique occurrences of values between flushes. The backend receives the number of unique events that happened since the last flush.

The reference use case involved tracking the number of active and logged in users by sending the current userId of a user with each request with a key of "uniques" (or similar).

Parameters
string | array$keyThe metric(s) to set.
float$valueThe value for the stats.
Returns
array

Definition at line 48 of file NullStatsdDataFactory.php.

NullStatsdDataFactory::timing (   $key,
  $time 
)

This function creates a 'timing' StatsdData.

Parameters
string | array$keyThe metric(s) to set.
float$timeThe elapsed time (ms) to log

Definition at line 19 of file NullStatsdDataFactory.php.

NullStatsdDataFactory::updateCount (   $key,
  $delta 
)

This function creates a 'updateCount' StatsdData object.

Parameters
string | array$keyThe metric(s) to decrement.
integer$deltaThe delta to add to the each metric
Returns
mixed

Definition at line 85 of file NullStatsdDataFactory.php.


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