87dfc20b1e
This patch adds a metric data service object to the IContextSource interface,
with full support for StatsD meters, gauges, counters and timing metrics, via
the liuggio/statsd-php-client, which this patch also introduces.
Usage example:
$stats = $context->getStats();
$stats->increment( 'resourceloader.cache.hits' );
$stats->timing( 'resourceloader.cache.rtt', $rtt );
The metrics are flushed to a StatsD server, which may be specified via the
'StatsdServer' configuration key. If no such configuration key exists, the
metrics are discarded.
The StatsD client supplants MediaWiki's StatCounter class. wfIncrStats()
will continue to work, but it will delegate to the StatsD data object.
Change-Id: Ie10db1c154d225971398e189737de7c560bf0f90
59 lines
1.7 KiB
PHP
59 lines
1.7 KiB
PHP
<?php
|
|
/**
|
|
* Copyright 2015
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use Liuggio\StatsdClient\Factory\StatsdDataFactory;
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
class BufferingStatsdDataFactory extends StatsdDataFactory {
|
|
protected $buffer = array();
|
|
|
|
public function __construct( $prefix ) {
|
|
parent::__construct();
|
|
$this->prefix = $prefix;
|
|
}
|
|
|
|
public function produceStatsdData( $key, $value = 1, $metric = self::STATSD_METRIC_COUNT ) {
|
|
$this->buffer[] = $entity = $this->produceStatsdDataEntity();
|
|
if ( $key !== null ) {
|
|
$prefixedKey = ltrim( $this->prefix . '.' . $key, '.' );
|
|
$entity->setKey( $prefixedKey );
|
|
}
|
|
if ( $value !== null ) {
|
|
$entity->setValue( $value );
|
|
}
|
|
if ( $metric !== null ) {
|
|
$entity->setMetric( $metric );
|
|
}
|
|
return $entity;
|
|
}
|
|
|
|
public function getBuffer() {
|
|
return $this->buffer;
|
|
}
|
|
}
|