File: PrefixingStatsdDataFactoryProxy.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (101 lines) | stat: -rw-r--r-- 2,647 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<?php
/**
 * 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
 */

namespace Wikimedia\Stats;

use Liuggio\StatsdClient\Entity\StatsdDataInterface;
use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;

/**
 * Proxy to prefix metric keys sent to a StatsdDataFactoryInterface
 *
 * @since 1.32
 */
class PrefixingStatsdDataFactoryProxy implements StatsdDataFactoryInterface {

	/**
	 * @var string
	 */
	private $prefix;

	/**
	 * @var StatsdDataFactoryInterface
	 */
	private $factory;

	/**
	 * @param StatsdDataFactoryInterface $factory
	 * @param string $prefix
	 */
	public function __construct(
		StatsdDataFactoryInterface $factory,
		$prefix
	) {
		$this->factory = $factory;
		$this->prefix = rtrim( $prefix, '.' );
	}

	/**
	 * @param string $key
	 * @return string
	 */
	private function addPrefixToKey( $key ) {
		return $this->prefix . '.' . $key;
	}

	public function timing( $key, $time ) {
		return $this->factory->timing( $this->addPrefixToKey( $key ), $time );
	}

	public function gauge( $key, $value ) {
		return $this->factory->gauge( $this->addPrefixToKey( $key ), $value );
	}

	public function set( $key, $value ) {
		return $this->factory->set( $this->addPrefixToKey( $key ), $value );
	}

	public function increment( $key ) {
		return $this->factory->increment( $this->addPrefixToKey( $key ) );
	}

	public function decrement( $key ) {
		return $this->factory->decrement( $this->addPrefixToKey( $key ) );
	}

	public function updateCount( $key, $delta ) {
		return $this->factory->updateCount( $this->addPrefixToKey( $key ), $delta );
	}

	public function produceStatsdData(
		$key,
		$value = 1,
		$metric = StatsdDataInterface::STATSD_METRIC_COUNT
	) {
		return $this->factory->produceStatsdData(
			$this->addPrefixToKey( $key ),
			$value,
			$metric
		);
	}
}

/** @deprecated class alias since 1.43 */
class_alias( PrefixingStatsdDataFactoryProxy::class, 'PrefixingStatsdDataFactoryProxy' );