triadev / LaravelPrometheusExporter

src/Middleware/RequestPerRoute.php

<?php

Filename "RequestPerRoute.php" doesn't match the expected filename "requestperroute.php"

namespace Triadev\PrometheusExporter\Middleware;

use Illuminate\Http\Request;
use Closure;
use Illuminate\Http\Response;
use Prometheus\Exception\MetricsRegistrationException;
use Triadev\PrometheusExporter\Contract\PrometheusExporterContract;

class RequestPerRoute
{
    /** @var PrometheusExporterContract */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    private $prometheusExporter;

Private member variable "prometheusExporter" must contain a leading underscore

Expected 1 blank line before member var; 0 found

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

    
    /**
     * RequestPerRoute constructor.
     * @param PrometheusExporterContract $prometheusExporter

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

     */
    public function __construct(PrometheusExporterContract $prometheusExporter)

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        $this->prometheusExporter = $prometheusExporter;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    
    /**
     * Handle an incoming request.
     *
     * @param  Request $request

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param  \Closure $next

Missing parameter comment

     * @return mixed

Tag cannot be grouped with parameter tags in a doc comment

     *
     * @throws MetricsRegistrationException
     */
    public function handle(Request $request, Closure $next)
    {

Opening brace should be on the same line as the declaration

        $start = microtime(true);
    
        /** @var Response $response */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $response = $next($request);
    
        $durationMilliseconds = (microtime(true) - $start) * 1000.0;

Arithmetic operation must be bracketed

        
        $path = $request->path();

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $method = $request->getMethod();
        $status = $response->getStatusCode();
        
        $this->requestCountMetric($path, $method, $status);
        $this->requestLatencyMetric($path, $method, $status, $durationMilliseconds);
    
        return $response;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end handle()

    
    /**

Missing short description in doc comment

     * @param string $routeName

Missing parameter comment

     * @param string $method

Missing parameter comment

     * @param int $status

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @throws MetricsRegistrationException
     */

Missing @return tag in function comment

    private function requestCountMetric(string $routeName, string $method, int $status)

Private method name "RequestPerRoute::requestCountMetric" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        $this->prometheusExporter->incCounter(
            'requests_total',
            'the number of http requests',
            config('prometheus_exporter.namespace_http'),
            [

Short array syntax is not allowed

                'route',

This array value does not seem to be aligned correcty; expected 13 spaces, but found 16.

                'method',

This array value does not seem to be aligned correcty; expected 13 spaces, but found 16.

                'status_code'

There should be a trailing comma after the last value of an array declaration.

            ],
            [

Short array syntax is not allowed

                $routeName,

This array value does not seem to be aligned correcty; expected 13 spaces, but found 16.

                $method,

This array value does not seem to be aligned correcty; expected 13 spaces, but found 16.

                $status

There should be a trailing comma after the last value of an array declaration.

            ]
        );
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end requestCountMetric()

    
    /**

Missing short description in doc comment

     * @param string $routeName

Missing parameter comment

     * @param string $method

Missing parameter comment

     * @param int $status

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     * @param int $duration

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @throws MetricsRegistrationException
     */

Missing @return tag in function comment

    private function requestLatencyMetric(string $routeName, string $method, int $status, int $duration)

Private method name "RequestPerRoute::requestLatencyMetric" must be prefixed with an underscore

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

    {

Opening brace should be on the same line as the declaration

        $bucketsPerRoute = null;
        
        if ($bucketsPerRouteConfig = config('prometheus-exporter.buckets_per_route')) {

Assignments must be the first block of code on a line

            $bucketsPerRoute = array_get($bucketsPerRouteConfig, $routeName);

The function array_get() has been deprecated: Arr::get() should be used directly instead. Will be removed in Laravel 6.0.

        }
        
        $this->prometheusExporter->setHistogram(
            'requests_latency_milliseconds',
            'duration of requests',
            $duration,
            config('prometheus_exporter.namespace_http'),
            [

Short array syntax is not allowed

                'route',

This array value does not seem to be aligned correcty; expected 13 spaces, but found 16.

                'method',

This array value does not seem to be aligned correcty; expected 13 spaces, but found 16.

                'status_code'

There should be a trailing comma after the last value of an array declaration.

            ],
            [

Short array syntax is not allowed

                $routeName,

This array value does not seem to be aligned correcty; expected 13 spaces, but found 16.

                $method,

This array value does not seem to be aligned correcty; expected 13 spaces, but found 16.

                $status

There should be a trailing comma after the last value of an array declaration.

            ],
            $bucketsPerRoute
        );
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end requestLatencyMetric()

}

Expected //end class

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