summaryrefslogtreecommitdiff
path: root/includes/StatCounter.php
blob: 5fc8f2f5d8242cef7630e254418dc6e5fa07b62a (plain)
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php
/**
 * @defgroup StatCounter StatCounter
 *
 * StatCounter is used to increment arbitrary keys for profiling reasons.
 * The key/values are persisted in several possible ways (see $wgStatsMethod).
 */

/**
 * Aggregator for wfIncrStats() that batches updates per request.
 *
 * 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
 * @ingroup StatCounter
 * @author Aaron Schulz
 */

/**
 * Aggregator for wfIncrStats() that batches updates per request.
 * This avoids spamming the collector many times for the same key.
 *
 * @ingroup StatCounter
 */
class StatCounter {
	/** @var array */
	protected $deltas = array(); // (key => count)

	/** @var Config */
	protected $config;

	protected function __construct( Config $config ) {
		$this->config = $config;
	}

	/**
	 * @return StatCounter
	 */
	public static function singleton() {
		static $instance = null;
		if ( !$instance ) {
			$instance = new self(
				ConfigFactory::getDefaultInstance()->makeConfig( 'main' )
			);
		}
		return $instance;
	}

	/**
	 * Increment a key by delta $count
	 *
	 * @param string $key
	 * @param int $count
	 * @return void
	 */
	public function incr( $key, $count = 1 ) {
		$this->deltas[$key] = isset( $this->deltas[$key] ) ? $this->deltas[$key] : 0;
		$this->deltas[$key] += $count;
		if ( PHP_SAPI === 'cli' ) {
			$this->flush();
		}
	}

	/**
	 * Flush all pending deltas to persistent storage
	 *
	 * @return void
	 */
	public function flush() {
		$statsMethod = $this->config->get( 'StatsMethod' );
		$deltas = array_filter( $this->deltas ); // remove 0 valued entries
		if ( $statsMethod === 'udp' ) {
			$this->sendDeltasUDP( $deltas );
		} elseif ( $statsMethod === 'cache' ) {
			$this->sendDeltasMemc( $deltas );
		} else {
			// disabled
		}
		$this->deltas = array();
	}

	/**
	 * @param array $deltas
	 * @return void
	 */
	protected function sendDeltasUDP( array $deltas ) {
		$aggregateStatsID = $this->config->get( 'AggregateStatsID' );
		$id = strlen( $aggregateStatsID ) ? $aggregateStatsID : wfWikiID();

		$lines = array();
		foreach ( $deltas as $key => $count ) {
			$lines[] = sprintf( $this->config->get( 'StatsFormatString' ), $id, $count, $key );
		}

		if ( count( $lines ) ) {
			static $socket = null;
			if ( !$socket ) {
				$socket = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
			}
			$packet = '';
			$packets = array();
			foreach ( $lines as $line ) {
				if ( ( strlen( $packet ) + strlen( $line ) ) > 1450 ) {
					$packets[] = $packet;
					$packet = '';
				}
				$packet .= $line;
			}
			if ( $packet != '' ) {
				$packets[] = $packet;
			}
			foreach ( $packets as $packet ) {
				wfSuppressWarnings();
				socket_sendto(
					$socket,
					$packet,
					strlen( $packet ),
					0,
					$this->config->get( 'UDPProfilerHost' ),
					$this->config->get( 'UDPProfilerPort' )
				);
				wfRestoreWarnings();
			}
		}
	}

	/**
	 * @param array $deltas
	 * @return void
	 */
	protected function sendDeltasMemc( array $deltas ) {
		global $wgMemc;

		foreach ( $deltas as $key => $count ) {
			$ckey = wfMemcKey( 'stats', $key );
			if ( $wgMemc->incr( $ckey, $count ) === null ) {
				$wgMemc->add( $ckey, $count );
			}
		}
	}
}