Page MenuHomeWickedGov Phorge
Files F4142984

DogStatsdFormatter.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

DogStatsdFormatter.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\Formatters;
use Wikimedia\Stats\Metrics\MetricInterface;
/**
* DogStatsD Wire Format Implementation
*
* @author Cole White
* @since 1.41
*/
class DogStatsdFormatter implements FormatterInterface {
/** @inheritDoc */
public function getFormattedSamples( string $prefix, MetricInterface $metric ): array {
$output = [];
// append component to prefix if set
if ( $metric->getComponent() !== '' ) {
$prefix .= ".{$metric->getComponent()}";
}
foreach ( $metric->getSamples() as $sample ) {
// dot-separate prefix, component, and name `prefix.component.name`
$stat = implode( '.', [ $prefix, $metric->getName() ] );
// merge value with separator `:42`
$value = ':' . $sample->getValue();
// merge type indicator with separator `|c`
$type = '|' . $metric->getTypeIndicator();
// blank string if samplerate is 1.0, otherwise add samplerate indicator `|@0.5`
$sampleRate = $metric->getSampleRate() !== 1.0 ? '|@' . $metric->getSampleRate() : '';
// merge label keys and label values `key:value`
$labels = [];
$labelValues = $sample->getLabelValues();
foreach ( $metric->getLabelKeys() as $i => $labelKey ) {
$labels[] = $labelKey . ':' . $labelValues[$i];
}
// combine label kv pairs `|# key1:value1,key2:value2`
$tags = $labels === [] ? '' : '|#' . implode( ",", $labels );
// combine and append to output `prefix.component.name:42|c|@0.5|#key1:value1,key2:value2`
$output[] = $stat . $value . $type . $sampleRate . $tags;
}
return $output;
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 16:37 (4 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
13/cf/97c8055c58fea59e125b5b78f726
Default Alt Text
DogStatsdFormatter.php (2 KB)

Event Timeline