Krenor\Prometheus\Metrics\Histogram

Complexity

Total Complexity

8

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Test Coverage

Coverage

88.89%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	buckets()	0	3	1
A	observe()	0	5	1
A	__construct()	0	15	4
A	track()	0	3	1
A	type()	0	3	1

<?php

namespace Krenor\Prometheus\Metrics;

use Tightenco\Collect\Support\Collection;
use Krenor\Prometheus\Exceptions\LabelException;
use Krenor\Prometheus\Contracts\Types\Observable;
use Krenor\Prometheus\Exceptions\PrometheusException;
use Krenor\Prometheus\Metrics\Concerns\TracksExecutionTime;

abstract class Histogram extends Metric implements Observable
{
    use TracksExecutionTime;
    
    protected array $buckets = [
        .005,
        .01,
        .025,
        .05,
        .1,
        .25,
        .5,
        1,
        2.5,
        5,
        10,
    ];

    /**
     * {@inheritdoc}
     */
    public function __construct()
    {
        parent::__construct();

        foreach ($this->labels as $label) {
            if (preg_match('/^le$/', $label)) {
                throw new LabelException('The label `le` is used internally to designate buckets.');
            }
        }

        if (count($this->buckets) < 1) {
            throw new PrometheusException('Histograms must contain at least one bucket.');
        }

        sort($this->buckets);
    }

    /**
     * {@inheritdoc}
     */
    public function type(): string
    {
        return 'histogram';
    }

    /**
     * {@inheritdoc}
     *
     * @return self
     */
    public function observe(float $value, array $labels = []): self
    {
        static::$storage->observe($this, $value, $labels);

        return $this;
    }

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

    /**
     * {@inheritdoc}
     */
    protected function track(float $value, array $labels = []): void
    {
        $this->observe($value, $labels);
    }
}