BufferingStatsdDataFactory.php

Go to the documentation of this file.

<?php
use Liuggio\StatsdClient\Entity\StatsdData;
use Liuggio\StatsdClient\Entity\StatsdDataInterface;
use Liuggio\StatsdClient\Factory\StatsdDataFactory;
 
class BufferingStatsdDataFactory extends StatsdDataFactory implements IBufferingStatsdDataFactory {
    protected $buffer = [];
    protected $enabled = true;
    private $prefix;
 
    public function __construct( $prefix ) {
        parent::__construct();
        $this->prefix = $prefix;
    }
 
    private static function normalizeMetricKey( $key ) {
        $key = preg_replace( '/[:.]+/', '.', $key );
        $key = preg_replace( '/[^a-z0-9.]+/i', '_', $key );
        $key = trim( $key, '_.' );
        return str_replace( [ '._', '_.' ], '.', $key );
    }
 
    public function produceStatsdData(
        $key, $value = 1, $metric = StatsdDataInterface::STATSD_METRIC_COUNT
    ) {
        $entity = $this->produceStatsdDataEntity();
        if ( !$this->enabled ) {
            return $entity;
        }
        if ( $key !== null ) {
            $key = self::normalizeMetricKey( "{$this->prefix}.{$key}" );
            $entity->setKey( $key );
        }
        if ( $value !== null ) {
            $entity->setValue( $value );
        }
        if ( $metric !== null ) {
            $entity->setMetric( $metric );
        }
        // Don't bother buffering a counter update with a delta of zero.
        if ( !( $metric === StatsdDataInterface::STATSD_METRIC_COUNT && !$value ) ) {
            $this->buffer[] = $entity;
        }
        return $entity;
    }
 
    public function getBuffer() {
        wfDeprecated( __METHOD__, '1.30' );
        return $this->buffer;
    }
 
    public function hasData() {
        return !empty( $this->buffer );
    }
 
    public function getData() {
        return $this->buffer;
    }
 
    public function clearData() {
        $this->buffer = [];
    }
 
    public function getDataCount() {
        return count( $this->buffer );
    }
 
    public function setEnabled( $enabled ) {
        $this->enabled = $enabled;
    }
}