Page MenuHomeWickedGov Phorge
Files F5966950

CounterMetric.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

CounterMetric.php
View Options

<?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
*/
declare( strict_types=1 );
namespace Wikimedia\Stats\Metrics;
use Wikimedia\Stats\Exceptions\IllegalOperationException;
use Wikimedia\Stats\Sample;
/**
* Counter Metric Implementation
*
* Counter Metrics only ever increase and are identified by type "c".
*
* @author Cole White
* @since 1.38
*/
class CounterMetric implements MetricInterface {
use MetricTrait;
/**
* The StatsD protocol type indicator:
* https://github.com/statsd/statsd/blob/v0.9.0/docs/metric_types.md
* https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=metrics
*/
private const TYPE_INDICATOR = "c";
/**
* Increments metric by one.
*
* @return void
*/
public function increment(): void {
$this->incrementBy( 1 );
}
/**
* Increments metric by provided value.
*
* @param float $value
* @return void
*/
public function incrementBy( float $value ): void {
foreach ( $this->baseMetric->getStatsdNamespaces() as $namespace ) {
$this->baseMetric->getStatsdDataFactory()->updateCount( $namespace, $value );
}
try {
$this->baseMetric->addSample( new Sample( $this->baseMetric->getLabelValues(), $value ) );
} catch ( IllegalOperationException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( $ex->getMessage(), E_USER_WARNING );
}
}
/** @inheritDoc */
public function getTypeIndicator(): string {
return self::TYPE_INDICATOR;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 12:02 (3 d, 15 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
58/44/b60379bd0bdb1086306b5c4d936b
Default Alt Text
CounterMetric.php (2 KB)

Event Timeline