01938ae7db
Follows-up I2874175647e (7fdc3d09a3).
* Avoid "MediaWiki" in class names. If unavoidable, always camelcase.
* Use a more descriptive name, matching the implementing the class ("Buffering").
* Use "I" prefix for consistency with other MediaWiki-provided interfaces.
(Avoid "Interface" suffix, which is foreign to MediaWiki and is only used
in the StatsdClient namespace, which this interface is not in).
Bug: T166354
Change-Id: I06de59122625f9c23e7c1a1bfa69a7ddabbf379e
135 lines
3.2 KiB
PHP
135 lines
3.2 KiB
PHP
<?php
|
|
|
|
use Liuggio\StatsdClient\Entity\StatsdData;
|
|
use Liuggio\StatsdClient\Entity\StatsdDataInterface;
|
|
use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
|
|
|
|
/**
|
|
* @author Addshore
|
|
* @since 1.27
|
|
*/
|
|
class NullStatsdDataFactory implements IBufferingStatsdDataFactory {
|
|
|
|
/**
|
|
* This function creates a 'timing' StatsdData.
|
|
*
|
|
* @param string|array $key The metric(s) to set.
|
|
* @param float $time The elapsed time (ms) to log
|
|
*/
|
|
public function timing( $key, $time ) {
|
|
}
|
|
|
|
/**
|
|
* This function creates a 'gauge' StatsdData.
|
|
*
|
|
* @param string|array $key The metric(s) to set.
|
|
* @param float $value The value for the stats.
|
|
*/
|
|
public function gauge( $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).
|
|
*
|
|
* @param string|array $key The metric(s) to set.
|
|
* @param float $value The value for the stats.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function set( $key, $value ) {
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* This function creates a 'increment' StatsdData object.
|
|
*
|
|
* @param string|array $key The metric(s) to increment.
|
|
* @param float|1 $sampleRate The rate (0-1) for sampling.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function increment( $key ) {
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* This function creates a 'decrement' StatsdData object.
|
|
*
|
|
*
|
|
* @param string|array $key The metric(s) to decrement.
|
|
* @param float|1 $sampleRate The rate (0-1) for sampling.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function decrement( $key ) {
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* This function creates a 'updateCount' StatsdData object.
|
|
*
|
|
* @param string|array $key The metric(s) to decrement.
|
|
* @param integer $delta The delta to add to the each metric
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function updateCount( $key, $delta ) {
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Produce a StatsdDataInterface Object.
|
|
*
|
|
* @param string $key The key of the metric
|
|
* @param int $value The amount to increment/decrement each metric by.
|
|
* @param string $metric The metric type
|
|
* ("c" for count, "ms" for timing, "g" for gauge, "s" for set)
|
|
*
|
|
* @return StatsdDataInterface
|
|
*/
|
|
public function produceStatsdData(
|
|
$key,
|
|
$value = 1,
|
|
$metric = StatsdDataInterface::STATSD_METRIC_COUNT
|
|
) {
|
|
$data = new StatsdData();
|
|
$data->setKey( $key );
|
|
$data->setValue( $value );
|
|
$data->setMetric( $metric );
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Check whether this data factory has any data.
|
|
* @return boolean
|
|
*/
|
|
public function hasData() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Return data from the factory.
|
|
* @return StatsdData[]
|
|
*/
|
|
public function getData() {
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Set collection enable status.
|
|
* @param bool $enabled Will collection be enabled?
|
|
* @return void
|
|
*/
|
|
public function setEnabled( $enabled ) {
|
|
// Nothing to do, null factory is always disabled.
|
|
}
|
|
}
|