MediaWiki master
DogStatsdFormatter.php
Go to the documentation of this file.
1<?php
20declare( strict_types=1 );
21
23
25
34 public function getFormattedSamples( string $prefix, MetricInterface $metric ): array {
35 $output = [];
36
37 // append component to prefix if set
38 if ( $metric->getComponent() !== '' ) {
39 $prefix .= ".{$metric->getComponent()}";
40 }
41
42 foreach ( $metric->getSamples() as $sample ) {
43 // dot-separate prefix, component, and name `prefix.component.name`
44 $stat = implode( '.', [ $prefix, $metric->getName() ] );
45
46 // merge value with separator `:42`
47 $value = ':' . $sample->getValue();
48
49 // merge type indicator with separator `|c`
50 $type = '|' . $metric->getTypeIndicator();
51
52 // blank string if samplerate is 1.0, otherwise add samplerate indicator `|@0.5`
53 $sampleRate = $metric->getSampleRate() !== 1.0 ? '|@' . $metric->getSampleRate() : '';
54
55 // merge label keys and label values `key:value`
56 $labels = [];
57 $labelValues = $sample->getLabelValues();
58 foreach ( $metric->getLabelKeys() as $i => $labelKey ) {
59 $labels[] = $labelKey . ':' . $labelValues[$i];
60 }
61
62 // combine label kv pairs `|# key1:value1,key2:value2`
63 $tags = $labels === [] ? '' : '|#' . implode( ",", $labels );
64
65 // combine and append to output `prefix.component.name:42|c|@0.5|#key1:value1,key2:value2`
66 $output[] = $stat . $value . $type . $sampleRate . $tags;
67 }
68 return $output;
69 }
70}
DogStatsD Wire Format Implementation.
getFormattedSamples(string $prefix, MetricInterface $metric)
Renders metric to line format.string[]
getSamples()
Returns subset of samples corresponding to sample rate setting.
getLabelKeys()
Returns the list of defined label keys.