OutputFormats.php

Go to the documentation of this file.

<?php
declare( strict_types=1 );
 
namespace Wikimedia\Stats;
 
use Wikimedia\Stats\Emitters\EmitterInterface;
use Wikimedia\Stats\Emitters\NullEmitter;
use Wikimedia\Stats\Emitters\UDPEmitter;
use Wikimedia\Stats\Exceptions\UnsupportedFormatException;
use Wikimedia\Stats\Formatters\DogStatsdFormatter;
use Wikimedia\Stats\Formatters\FormatterInterface;
use Wikimedia\Stats\Formatters\NullFormatter;
use Wikimedia\Stats\Formatters\StatsdFormatter;
 
class OutputFormats {
 
    public const NULL = 1;
    public const STATSD = 2;
    public const DOGSTATSD = 3;
 
    private const SUPPORTED_FORMATS = [
        'null' => self::NULL,
        'statsd' => self::STATSD,
        'dogstatsd' => self::DOGSTATSD
    ];
 
    public static function getFormatFromString( string $format ): int {
        if ( self::SUPPORTED_FORMATS[$format] ?? false ) {
            return self::SUPPORTED_FORMATS[$format];
        }
        throw new UnsupportedFormatException(
            "Format '" . $format . "' not supported. Expected one of "
            . json_encode( array_keys( self::SUPPORTED_FORMATS ) )
        );
    }
 
    public static function getNewFormatter( int $format ): FormatterInterface {
        switch ( $format ) {
            case self::DOGSTATSD:
                return new DogStatsdFormatter();
            case self::STATSD:
                return new StatsdFormatter();
            case self::NULL:
                return new NullFormatter();
            default:
                throw new UnsupportedFormatException(
                    "Unsupported metrics format '{$format}' - See OutputFormats::class."
                );
        }
    }
 
    public static function getNewEmitter(
        string $prefix,
        StatsCache $cache,
        FormatterInterface $formatter,
        ?string $target = null
    ): EmitterInterface {
        $formatterClass = get_class( $formatter );
        switch ( $formatterClass ) {
            case StatsdFormatter::class:
            case DogStatsdFormatter::class:
                return new UDPEmitter( $prefix, $cache, $formatter, $target );
            case NullFormatter::class:
                return new NullEmitter;
            default:
                throw new UnsupportedFormatException( "Unsupported metrics formatter '{$formatterClass}'" );
        }
    }
}