3 * @defgroup StatCounter StatCounter
5 * StatCounter is used to increment arbitrary keys for profiling reasons.
6 * The key/values are persisted in several possible ways (see $wgStatsMethod).
10 * Aggregator for wfIncrStats() that batches updates per request.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 * http://www.gnu.org/copyleft/gpl.html
28 * @ingroup StatCounter
29 * @author Aaron Schulz
33 * Aggregator for wfIncrStats() that batches updates per request.
34 * This avoids spamming the collector many times for the same key.
36 * @ingroup StatCounter
40 protected $deltas = array(); // (key => count)
42 protected function __construct() {
48 public static function singleton() {
49 static $instance = null;
51 $instance = new self();
57 * Increment a key by delta $count
63 public function incr( $key, $count = 1 ) {
64 $this->deltas
[$key] = isset( $this->deltas
[$key] ) ?
$this->deltas
[$key] : 0;
65 $this->deltas
[$key] +
= $count;
66 if ( PHP_SAPI
=== 'cli' ) {
72 * Flush all pending deltas to persistent storage
76 public function flush() {
77 global $wgStatsMethod;
79 $deltas = array_filter( $this->deltas
); // remove 0 valued entries
80 if ( $wgStatsMethod === 'udp' ) {
81 $this->sendDeltasUDP( $deltas );
82 } elseif ( $wgStatsMethod === 'cache' ) {
83 $this->sendDeltasMemc( $deltas );
87 $this->deltas
= array();
91 * @param array $deltas
94 protected function sendDeltasUDP( array $deltas ) {
95 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgAggregateStatsID,
98 $id = strlen( $wgAggregateStatsID ) ?
$wgAggregateStatsID : wfWikiID();
101 foreach ( $deltas as $key => $count ) {
102 $lines[] = sprintf( $wgStatsFormatString, $id, $count, $key );
105 if ( count( $lines ) ) {
106 static $socket = null;
108 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
112 foreach ( $lines as $line ) {
113 if ( ( strlen( $packet ) +
strlen( $line ) ) > 1450 ) {
114 $packets[] = $packet;
119 if ( $packet != '' ) {
120 $packets[] = $packet;
122 foreach ( $packets as $packet ) {
123 wfSuppressWarnings();
138 * @param array $deltas
141 protected function sendDeltasMemc( array $deltas ) {
144 foreach ( $deltas as $key => $count ) {
145 $ckey = wfMemcKey( 'stats', $key );
146 if ( $wgMemc->incr( $ckey, $count ) === null ) {
147 $wgMemc->add( $ckey, $count );