triadev / LaravelPrometheusExporter

src/PrometheusExporter.php

<?php

Filename "PrometheusExporter.php" doesn't match the expected filename "prometheusexporter.php"

namespace Triadev\PrometheusExporter;

use Prometheus\PushGateway;
use Triadev\PrometheusExporter\Contract\PrometheusExporterContract;
use Prometheus\CollectorRegistry;
use Prometheus\MetricFamilySamples;
use Prometheus\Exception\MetricNotFoundException;

class PrometheusExporter implements PrometheusExporterContract
{
    /**

Missing short description in doc comment

     * @var CollectorRegistry
     */
    private $registry;

Expected 1 blank line before member var; 0 found

Private member variable "registry" must contain a leading underscore

Private member variable "registry" must be prefixed with an underscore

    /**
     * LpeManager constructor.
     *
     * @param CollectorRegistry $registry

Missing parameter comment

     */
    public function __construct(CollectorRegistry $registry)

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        $this->registry = $registry;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**
     * Get metric family samples
     *
     * @return MetricFamilySamples[]
     */
    public function getMetricFamilySamples()
    {

Opening brace should be on the same line as the declaration

        return $this->registry->getMetricFamilySamples();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getMetricFamilySamples()

    
    /**

Missing short description in doc comment

Parameter $name should have a doc-comment as per coding-style.

Parameter $help should have a doc-comment as per coding-style.

Parameter $namespace should have a doc-comment as per coding-style.

Parameter $labelKeys should have a doc-comment as per coding-style.

Parameter $labelValues should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function incCounter($name, $help, $namespace = null, array $labelKeys = [], array $labelValues = [])

Incorrect spacing between argument "$namespace" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$namespace"; expected 0 but found 1

Incorrect spacing between argument "$labelKeys" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelKeys"; expected 0 but found 1

Short array syntax is not allowed

Incorrect spacing between argument "$labelValues" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelValues"; expected 0 but found 1

This line exceeds maximum limit of 100 characters; contains 111 characters

    {

Opening brace should be on the same line as the declaration

        $namespace = $this->getNamespace($namespace);
        
        try {
            $counter = $this->registry->getCounter($namespace, $name);
        } catch (MetricNotFoundException $e) {
            $counter = $this->registry->registerCounter($namespace, $name, $help, $labelKeys);
        }

        $counter->inc($labelValues);

        $this->pushGateway($this->registry, 'inc');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end incCounter()

    
    /**

Missing short description in doc comment

Parameter $name should have a doc-comment as per coding-style.

Parameter $help should have a doc-comment as per coding-style.

Parameter $value should have a doc-comment as per coding-style.

Parameter $namespace should have a doc-comment as per coding-style.

Parameter $labelKeys should have a doc-comment as per coding-style.

Parameter $labelValues should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function incByCounter(
        $name,
        $help,
        $value,
        $namespace = null,

Incorrect spacing between argument "$namespace" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$namespace"; expected 0 but found 1

        array $labelKeys = [],

Incorrect spacing between argument "$labelKeys" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelKeys"; expected 0 but found 1

Short array syntax is not allowed

        array $labelValues = []

Incorrect spacing between argument "$labelValues" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelValues"; expected 0 but found 1

Short array syntax is not allowed

    ) {

Opening brace should be on a new line

        $namespace = $this->getNamespace($namespace);

        try {
            $counter = $this->registry->getCounter($namespace, $name);
        } catch (MetricNotFoundException $e) {
            $counter = $this->registry->registerCounter($namespace, $name, $help, $labelKeys);
        }

        $counter->incBy($value, $labelValues);

        $this->pushGateway($this->registry, 'incBy');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end incByCounter()

    
    /**

Missing short description in doc comment

Parameter $name should have a doc-comment as per coding-style.

Parameter $help should have a doc-comment as per coding-style.

Parameter $value should have a doc-comment as per coding-style.

Parameter $namespace should have a doc-comment as per coding-style.

Parameter $labelKeys should have a doc-comment as per coding-style.

Parameter $labelValues should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function setGauge($name, $help, $value, $namespace = null, array $labelKeys = [], array $labelValues = [])

Incorrect spacing between argument "$namespace" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$namespace"; expected 0 but found 1

Incorrect spacing between argument "$labelKeys" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelKeys"; expected 0 but found 1

Short array syntax is not allowed

Incorrect spacing between argument "$labelValues" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelValues"; expected 0 but found 1

This line exceeds maximum limit of 100 characters; contains 117 characters

    {

Opening brace should be on the same line as the declaration

        $namespace = $this->getNamespace($namespace);

        try {
            $gauge = $this->registry->getGauge($namespace, $name);
        } catch (MetricNotFoundException $e) {
            $gauge = $this->registry->registerGauge($namespace, $name, $help, $labelKeys);
        }

        $gauge->set($value, $labelValues);

        $this->pushGateway($this->registry, 'gauge');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setGauge()

    
    /**

Missing short description in doc comment

Parameter $name should have a doc-comment as per coding-style.

Parameter $help should have a doc-comment as per coding-style.

Parameter $namespace should have a doc-comment as per coding-style.

Parameter $labelKeys should have a doc-comment as per coding-style.

Parameter $labelValues should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function incGauge($name, $help, $namespace = null, array $labelKeys = [], array $labelValues = [])

Incorrect spacing between argument "$namespace" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$namespace"; expected 0 but found 1

Incorrect spacing between argument "$labelKeys" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelKeys"; expected 0 but found 1

Short array syntax is not allowed

Incorrect spacing between argument "$labelValues" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelValues"; expected 0 but found 1

This line exceeds maximum limit of 100 characters; contains 109 characters

    {

Opening brace should be on the same line as the declaration

        $namespace = $this->getNamespace($namespace);

        try {
            $gauge = $this->registry->getGauge($namespace, $name);
        } catch (MetricNotFoundException $e) {
            $gauge = $this->registry->registerGauge($namespace, $name, $help, $labelKeys);
        }

        $gauge->inc($labelValues);

        $this->pushGateway($this->registry, 'inc');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end incGauge()

    
    /**

Missing short description in doc comment

Parameter $name should have a doc-comment as per coding-style.

Parameter $help should have a doc-comment as per coding-style.

Parameter $value should have a doc-comment as per coding-style.

Parameter $namespace should have a doc-comment as per coding-style.

Parameter $labelKeys should have a doc-comment as per coding-style.

Parameter $labelValues should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function incByGauge(
        $name,
        $help,
        $value,
        $namespace = null,

Incorrect spacing between argument "$namespace" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$namespace"; expected 0 but found 1

        array $labelKeys = [],

Incorrect spacing between argument "$labelKeys" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelKeys"; expected 0 but found 1

Short array syntax is not allowed

        array $labelValues = []

Incorrect spacing between argument "$labelValues" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelValues"; expected 0 but found 1

Short array syntax is not allowed

    ) {

Opening brace should be on a new line

        $namespace = $this->getNamespace($namespace);

        try {
            $gauge = $this->registry->getGauge($namespace, $name);
        } catch (MetricNotFoundException $e) {
            $gauge = $this->registry->registerGauge($namespace, $name, $help, $labelKeys);
        }

        $gauge->incBy($value, $labelValues);

        $this->pushGateway($this->registry, 'incBy');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end incByGauge()

    
    /**

Missing short description in doc comment

Parameter $name should have a doc-comment as per coding-style.

Parameter $help should have a doc-comment as per coding-style.

Parameter $value should have a doc-comment as per coding-style.

Parameter $namespace should have a doc-comment as per coding-style.

Parameter $labelKeys should have a doc-comment as per coding-style.

Parameter $labelValues should have a doc-comment as per coding-style.

Parameter $buckets should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function setHistogram(
        $name,
        $help,
        $value,
        $namespace = null,

Incorrect spacing between argument "$namespace" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$namespace"; expected 0 but found 1

        array $labelKeys = [],

Incorrect spacing between argument "$labelKeys" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelKeys"; expected 0 but found 1

Short array syntax is not allowed

        array $labelValues = [],

Incorrect spacing between argument "$labelValues" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$labelValues"; expected 0 but found 1

Short array syntax is not allowed

        ?array $buckets = null

Incorrect spacing between argument "$buckets" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$buckets"; expected 0 but found 1

    ) {

Opening brace should be on a new line

        $namespace = $this->getNamespace($namespace);

        try {
            $histogram = $this->registry->getHistogram($namespace, $name);
        } catch (MetricNotFoundException $e) {
            $histogram = $this->registry->registerHistogram($namespace, $name, $help, $labelKeys, $buckets);

This line exceeds maximum limit of 100 characters; contains 108 characters

        }

        $histogram->observe($value, $labelValues);

        $this->pushGateway($this->registry, 'histogram');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setHistogram()

    
    private function getNamespace(?string $namespace = null) : string

Private method name "PrometheusExporter::getNamespace" must be prefixed with an underscore

Missing function doc comment

Incorrect spacing between argument "$namespace" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$namespace"; expected 0 but found 1

    {

Opening brace should be on the same line as the declaration

        if (!$namespace) {

There must be a single space after a NOT operator; 0 found

            $namespace = config('prometheus-exporter.namespace');
        }

        return $namespace;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getNamespace()

    
    private function pushGateway(CollectorRegistry $registry, string $job, ?array $groupingKey = null)

Private method name "PrometheusExporter::pushGateway" must be prefixed with an underscore

Missing function doc comment

Incorrect spacing between argument "$groupingKey" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$groupingKey"; expected 0 but found 1

This line exceeds maximum limit of 100 characters; contains 102 characters

    {

Opening brace should be on the same line as the declaration

        if (config('prometheus-exporter.adapter') == 'push') {

Operator == prohibited; use === instead

            $pushGateway = new PushGateway(config('prometheus-exporter.push_gateway.address'));
            
            $pushGateway->push(
                $registry,
                $job,
                $groupingKey
            );
        }
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end pushGateway()

}

Expected //end class

As per coding style, files should not end with a newline character.