MediaWiki  master
StatsdFormatter.php
Go to the documentation of this file.
1 <?php
20 declare( 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, name, and label values `prefix.component.name.value1.value2`
44  $stat = implode( '.', array_merge( [ $prefix, $metric->getName() ], $sample->getLabelValues() ) );
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  // combine and append to output `prefix.component.name.value1.value2:42|c|@0.5`
56  $output[] = $stat . $value . $type . $sampleRate;
57  }
58  return $output;
59  }
60 }
StatsD Wire Format Implementation.
getFormattedSamples(string $prefix, MetricInterface $metric)
Renders metric to line format.string[]
getSamples()
Returns subset of samples corresponding to sample rate setting.