Krenor\Prometheus\Contracts\Metric

Complexity

Total Complexity

11

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Test Coverage

Coverage

95.45%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	key()	0	3	1
A	name()	0	3	1
A	labels()	0	3	1
A	description()	0	3	1
A	storeUsing()	0	3	1
A	__construct()	0	10	4
A	namespace()	0	3	1
A	storage()	0	3	1

<?php

namespace Krenor\Prometheus\Contracts;

use Tightenco\Collect\Support\Collection;
use Krenor\Prometheus\Exceptions\LabelException;
use Krenor\Prometheus\Exceptions\PrometheusException;

abstract class Metric
{
    /**
     * @var string
     */
    protected $namespace;

    /**
     * @var string
     */
    protected $name;

    /**
     * @var string
     */
    protected $description;

    /**
     * @var string[]
     */
    protected $labels = [];

    /**
     * @var Storage
     */
    protected static $storage;

    /**
     * Metric constructor.
     *
     * @throws LabelException
     */
    public function __construct()
    {
        foreach ($this->labels as $label) {
            if (!preg_match('/^(?![_]{2})[a-zA-Z_][a-zA-Z0-9_]*$/', $label)) {
                throw new LabelException("The label `{$label}` contains invalid characters.");
            }
        }

        if (!preg_match('/^[a-zA-Z_:][a-zA-Z0-9_:]*$/', $this->key())) {
            throw new PrometheusException("The metric name `{$this->key()}` contains invalid characters.");
        }
    }

    /**
     * @return string
     */
    final public function key(): string
    {
        return "{$this->namespace()}_{$this->name()}";
    }

    /**
     * @return string
     */
    abstract public function type(): string;

    /**
     * @return string
     */
    public function namespace(): string
    {
        return $this->namespace;
    }

    /**
     * @return string
     */
    public function name(): string
    {
        return $this->name;
    }

    /**
     * @return string
     */
    public function description(): string
    {
        return $this->description;
    }

    /**
     * @return Collection
     */
    public function labels(): Collection
    {
        return new Collection($this->labels);
    }

    /**
     * @param Storage $storage
     */
    public static function storeUsing(Storage $storage): void
    {
        static::$storage = $storage;
    }

    /**
     * @return Storage
     */
    public static function storage(): Storage
    {
        return static::$storage;
    }
}