From: addshore <addshorewiki@gmail.com>
Date: Sat, 2 Apr 2016 09:22:00 +0000 (+0300)
Subject: Move statsd files in libs to own directory
X-Git-Tag: 1.31.0-rc.0~7418
X-Git-Url: http://git.cyclocoop.org//%22javascript:ModifierStyle%28%27%22.%24id.%22%27%29/%22?a=commitdiff_plain;h=737e83edf59bdd9cb909cdc65c34c64f7ac07b85;p=lhc%2Fweb%2Fwiklou.git

Move statsd files in libs to own directory

Change-Id: Ia3ac9441d7548fedb672e3f2567be7c4eafae208
---

diff --git a/autoload.php b/autoload.php
index c62e99d3ee..df38b3a2a2 100644
--- a/autoload.php
+++ b/autoload.php
@@ -185,7 +185,7 @@ $wgAutoloadLocalClasses = [
 	'BmpHandler' => __DIR__ . '/includes/media/BMP.php',
 	'BotPassword' => __DIR__ . '/includes/user/BotPassword.php',
 	'BrokenRedirectsPage' => __DIR__ . '/includes/specials/SpecialBrokenRedirects.php',
-	'BufferingStatsdDataFactory' => __DIR__ . '/includes/libs/BufferingStatsdDataFactory.php',
+	'BufferingStatsdDataFactory' => __DIR__ . '/includes/libs/stats/BufferingStatsdDataFactory.php',
 	'CLIParser' => __DIR__ . '/maintenance/parse.php',
 	'CSSMin' => __DIR__ . '/includes/libs/CSSMin.php',
 	'CacheDependency' => __DIR__ . '/includes/cache/CacheDependency.php',
@@ -893,7 +893,7 @@ $wgAutoloadLocalClasses = [
 	'NullJob' => __DIR__ . '/includes/jobqueue/jobs/NullJob.php',
 	'NullLockManager' => __DIR__ . '/includes/filebackend/lockmanager/LockManager.php',
 	'NullRepo' => __DIR__ . '/includes/filerepo/NullRepo.php',
-	'NullStatsdDataFactory' => __DIR__ . '/includes/libs/NullStatsdDataFactory.php',
+	'NullStatsdDataFactory' => __DIR__ . '/includes/libs/stats/NullStatsdDataFactory.php',
 	'OOUIHTMLForm' => __DIR__ . '/includes/htmlform/OOUIHTMLForm.php',
 	'ORAField' => __DIR__ . '/includes/db/DatabaseOracle.php',
 	'ORAResult' => __DIR__ . '/includes/db/DatabaseOracle.php',
diff --git a/includes/libs/BufferingStatsdDataFactory.php b/includes/libs/BufferingStatsdDataFactory.php
deleted file mode 100644
index 9c18b10f10..0000000000
--- a/includes/libs/BufferingStatsdDataFactory.php
+++ /dev/null
@@ -1,87 +0,0 @@
-<?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\Entity\StatsdData;
-use Liuggio\StatsdClient\Entity\StatsdDataInterface;
-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 = [];
-
-	public function __construct( $prefix ) {
-		parent::__construct();
-		$this->prefix = $prefix;
-	}
-
-	/**
-	 * 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.
-	 *
-	 * @param string $key
-	 * @since 1.26
-	 */
-	private static function normalizeMetricKey( $key ) {
-		$key = preg_replace( '/[:.]+/', '.', $key );
-		$key = preg_replace( '/[^a-z0-9.]+/i', '_', $key );
-		$key = trim( $key, '_.' );
-		return str_replace( [ '._', '_.' ], '.', $key );
-	}
-
-	public function produceStatsdData(
-		$key, $value = 1, $metric = StatsdDataInterface::STATSD_METRIC_COUNT
-	) {
-		$entity = $this->produceStatsdDataEntity();
-		if ( $key !== null ) {
-			$key = self::normalizeMetricKey( "{$this->prefix}.{$key}" );
-			$entity->setKey( $key );
-		}
-		if ( $value !== null ) {
-			$entity->setValue( $value );
-		}
-		if ( $metric !== null ) {
-			$entity->setMetric( $metric );
-		}
-		// Don't bother buffering a counter update with a delta of zero.
-		if ( !( $metric === StatsdDataInterface::STATSD_METRIC_COUNT && !$value ) ) {
-			$this->buffer[] = $entity;
-		}
-		return $entity;
-	}
-
-	/**
-	 * @return StatsdData[]
-	 */
-	public function getBuffer() {
-		return $this->buffer;
-	}
-}
diff --git a/includes/libs/NullStatsdDataFactory.php b/includes/libs/NullStatsdDataFactory.php
deleted file mode 100644
index 3b272e216e..0000000000
--- a/includes/libs/NullStatsdDataFactory.php
+++ /dev/null
@@ -1,111 +0,0 @@
-<?php
-
-use Liuggio\StatsdClient\Entity\StatsdData;
-use Liuggio\StatsdClient\Entity\StatsdDataInterface;
-use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
-
-/**
- * @author Addshore
- * @since 1.27
- */
-class NullStatsdDataFactory implements StatsdDataFactoryInterface {
-
-	/**
-	 * 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;
-	}
-
-}
diff --git a/includes/libs/stats/BufferingStatsdDataFactory.php b/includes/libs/stats/BufferingStatsdDataFactory.php
new file mode 100644
index 0000000000..9c18b10f10
--- /dev/null
+++ b/includes/libs/stats/BufferingStatsdDataFactory.php
@@ -0,0 +1,87 @@
+<?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\Entity\StatsdData;
+use Liuggio\StatsdClient\Entity\StatsdDataInterface;
+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 = [];
+
+	public function __construct( $prefix ) {
+		parent::__construct();
+		$this->prefix = $prefix;
+	}
+
+	/**
+	 * 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.
+	 *
+	 * @param string $key
+	 * @since 1.26
+	 */
+	private static function normalizeMetricKey( $key ) {
+		$key = preg_replace( '/[:.]+/', '.', $key );
+		$key = preg_replace( '/[^a-z0-9.]+/i', '_', $key );
+		$key = trim( $key, '_.' );
+		return str_replace( [ '._', '_.' ], '.', $key );
+	}
+
+	public function produceStatsdData(
+		$key, $value = 1, $metric = StatsdDataInterface::STATSD_METRIC_COUNT
+	) {
+		$entity = $this->produceStatsdDataEntity();
+		if ( $key !== null ) {
+			$key = self::normalizeMetricKey( "{$this->prefix}.{$key}" );
+			$entity->setKey( $key );
+		}
+		if ( $value !== null ) {
+			$entity->setValue( $value );
+		}
+		if ( $metric !== null ) {
+			$entity->setMetric( $metric );
+		}
+		// Don't bother buffering a counter update with a delta of zero.
+		if ( !( $metric === StatsdDataInterface::STATSD_METRIC_COUNT && !$value ) ) {
+			$this->buffer[] = $entity;
+		}
+		return $entity;
+	}
+
+	/**
+	 * @return StatsdData[]
+	 */
+	public function getBuffer() {
+		return $this->buffer;
+	}
+}
diff --git a/includes/libs/stats/NullStatsdDataFactory.php b/includes/libs/stats/NullStatsdDataFactory.php
new file mode 100644
index 0000000000..3b272e216e
--- /dev/null
+++ b/includes/libs/stats/NullStatsdDataFactory.php
@@ -0,0 +1,111 @@
+<?php
+
+use Liuggio\StatsdClient\Entity\StatsdData;
+use Liuggio\StatsdClient\Entity\StatsdDataInterface;
+use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
+
+/**
+ * @author Addshore
+ * @since 1.27
+ */
+class NullStatsdDataFactory implements StatsdDataFactoryInterface {
+
+	/**
+	 * 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;
+	}
+
+}