SilexSetup::setupMiddleware() - Code Metrics - Inspection of "moved the path and methods extraction from a route..." - philiplb/PHPProm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d56974...1ffe96 )

by Philip

created 2016-11-29 22:31 UTC

SilexSetup::setupMiddleware() A

↳ Parent: SilexSetup

Complexity

Conditions	1
Paths	1

Size

Total Lines	20
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	20
rs	9.4285
cc	1
eloc	13
nc	1
nop	2

<?php

/*
 * This file is part of the PHPProm package.
 *
 * (c) Philip Lehmann-Böhm <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace PHPProm\Integration;

use PHPProm\PrometheusExport;
use PHPProm\StopWatch;
use PHPProm\Storage\AbstractStorage;
use Silex\Route;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Silex\Application;

/**
 * Class SilexSetup
 * Setups Silex applications to measure:
 * - the time of each route
 * - the used memory of each route
 * - the amount of requests of each route
 * It also offers an function to be used for a Prometheus scrapable endpoint.
 * @package PHPProm\Integration
 */
class SilexSetup {

    /**
     * Sets up the Silex middlewares where the actual measurements happen.
     *
     * @param Application $app
     * the Silex application
     * @param AbstractStorage $storage
     * the storage for the measurements
     */
    protected function setupMiddleware(Application $app, AbstractStorage $storage) {

        $storage->addAvailableMetric('route_time', 'name', 'request times per route in seconds', 'gauge', 'Nan');
        $storage->addAvailableMetric('route_memory', 'name', 'request memory per route in bytes', 'gauge', 'Nan');
        $storage->addAvailableMetric('route_requests_total', 'name', 'total requests per route', 'counter', 0);

        $routeTime = new StopWatch($storage);

        $app->before(function() use ($routeTime) {
            $routeTime->start();
        }, Application::EARLY_EVENT);

        $app->finish(function(Request $request) use ($routeTime, $storage) {
            $route = $request->get('_route');
            $routeTime->stop('route_time', $route);
            $storage->storeMeasurement('route_memory', $route, memory_get_peak_usage(true));
            $storage->incrementMeasurement('route_requests_total', $route);
        });

    }

    /**
     * Gets the path with all methods from a route.
     *
     * @param Route $route
     * the route to get the path and methods from
     * @return array
     * the pathes with methods
     */
    protected function getPathWithMethods(Route $route) {
        $supportedMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'];
        $path             = str_replace('/', '_', $route->getPath());
        $foundMethod      = false;
        $routes           = [];
        foreach ($route->getMethods() as $method) {
            $routes[]    = $method.$path;
            $foundMethod = true;
        }
        if (!$foundMethod) {
            foreach ($supportedMethods as $supportedMethod) {
                $routes[] = $supportedMethod.$path;
            }
        }
        return $routes;
    }

    /**
     * Sets up the Silex middlewares where the actual measurements happen
     * and returns a function to be used for a Prometheus scrapable endpoint.
     *
     * @param Application $app
     * the Silex application
     * @param AbstractStorage $storage
     * the storage for the measurements
     *
     * @return \Closure
     * the function to be used for a Prometheus scrapable endpoint
     */
    public function setupAndGetMetricsRoute(Application $app, AbstractStorage $storage) {

        $this->setupMiddleware($app, $storage);

        return function() use ($app, $storage) {
            $routes = [];
$a = "a";
$ab = "ab";
$abc = "abc";
            $supportedMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            foreach ($app['routes']->all() as $route) {
                $routes = array_merge($routes, $this->getPathWithMethods($route));
            }
            $export   = new PrometheusExport();
            $response = $export->getExport($storage, $routes);
            return new Response($response, 200, ['Content-Type' => 'text/plain; version=0.0.4']);
        };
    }

}


1			<?php
2
3			/*
4			* This file is part of the PHPProm package.
5			*
6			* (c) Philip Lehmann-Böhm <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace PHPProm\Integration;
13
14			use PHPProm\PrometheusExport;
15			use PHPProm\StopWatch;
16			use PHPProm\Storage\AbstractStorage;
17			use Silex\Route;
18			use Symfony\Component\HttpFoundation\Request;
19			use Symfony\Component\HttpFoundation\Response;
20			use Silex\Application;
21
22			/**
23			* Class SilexSetup
24			* Setups Silex applications to measure:
25			* - the time of each route
26			* - the used memory of each route
27			* - the amount of requests of each route
28			* It also offers an function to be used for a Prometheus scrapable endpoint.
29			* @package PHPProm\Integration
30			*/
31			class SilexSetup {
32
33			/**
34			* Sets up the Silex middlewares where the actual measurements happen.
35			*
36			* @param Application $app
37			* the Silex application
38			* @param AbstractStorage $storage
39			* the storage for the measurements
40			*/
41			protected function setupMiddleware(Application $app, AbstractStorage $storage) {
42
43			$storage->addAvailableMetric('route_time', 'name', 'request times per route in seconds', 'gauge', 'Nan');
44			$storage->addAvailableMetric('route_memory', 'name', 'request memory per route in bytes', 'gauge', 'Nan');
45			$storage->addAvailableMetric('route_requests_total', 'name', 'total requests per route', 'counter', 0);
46
47			$routeTime = new StopWatch($storage);
48
49			$app->before(function() use ($routeTime) {
50			$routeTime->start();
51			}, Application::EARLY_EVENT);
52
53			$app->finish(function(Request $request) use ($routeTime, $storage) {
54			$route = $request->get('_route');
55			$routeTime->stop('route_time', $route);
56			$storage->storeMeasurement('route_memory', $route, memory_get_peak_usage(true));
57			$storage->incrementMeasurement('route_requests_total', $route);
58			});
59
60			}
61
62			/**
63			* Gets the path with all methods from a route.
64			*
65			* @param Route $route
66			* the route to get the path and methods from
67			* @return array
68			* the pathes with methods
69			*/
70			protected function getPathWithMethods(Route $route) {
71			$supportedMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'];
72			$path = str_replace('/', '_', $route->getPath());
73			$foundMethod = false;
74			$routes = [];
75			foreach ($route->getMethods() as $method) {
76			$routes[] = $method.$path;
77			$foundMethod = true;
78			}
79			if (!$foundMethod) {
80			foreach ($supportedMethods as $supportedMethod) {
81			$routes[] = $supportedMethod.$path;
82			}
83			}
84			return $routes;
85			}
86
87			/**
88			* Sets up the Silex middlewares where the actual measurements happen
89			* and returns a function to be used for a Prometheus scrapable endpoint.
90			*
91			* @param Application $app
92			* the Silex application
93			* @param AbstractStorage $storage
94			* the storage for the measurements
95			*
96			* @return \Closure
97			* the function to be used for a Prometheus scrapable endpoint
98			*/
99			public function setupAndGetMetricsRoute(Application $app, AbstractStorage $storage) {
100
101			$this->setupMiddleware($app, $storage);
102
103			return function() use ($app, $storage) {
104			$routes = [];
			0 ignored issues – show Coding Style introduced 2016-11-29 21:53 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 11 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
105			$supportedMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'];
			0 ignored issues – show Unused Code introduced 2016-11-29 22:33 UTC by Report Bug Copy Issue Report `$supportedMethods` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
106			foreach ($app['routes']->all() as $route) {
107			$routes = array_merge($routes, $this->getPathWithMethods($route));
108			}
109			$export = new PrometheusExport();
110			$response = $export->getExport($storage, $routes);
111			return new Response($response, 200, ['Content-Type' => 'text/plain; version=0.0.4']);
112			};
113			}
114
115			}
116

philiplb / PHPProm

Push — master ( d56974...1ffe96 )

SilexSetup::setupMiddleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like