Slim3Setup::setupMiddleware() - Code Metrics - Inspection of "added a first implementation of a slim3 integratio..." - philiplb/PHPProm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 182cf9...dcef90 )

by Philip

created 2016-11-30 23:12 UTC

Slim3Setup::setupMiddleware() A

↳ Parent: Slim3Setup

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	21
rs	9.3142
cc	1
eloc	15
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 \Psr\Http\Message\ServerRequestInterface as Request;
use \Psr\Http\Message\ResponseInterface as Response;
use \Slim\App;
use PHPProm\PrometheusExport;
use PHPProm\Storage\AbstractStorage;
use PHPProm\StopWatch;
use Slim\Route;

/**
 * Class Slim3Setup
 * Setups Slim 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 Slim3Setup {


    /**
     * Sets up the Slim middleware where the actual measurements happen.
     *
     * @param App $app
     * the Silex application
     * @param AbstractStorage $storage
     * the storage for the measurements
     */
    protected function setupMiddleware(App $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);

        $app->add(function(Request $request, Response $response, App $next) use ($storage) {

            $method = $request->getMethod();
$a = "a";
$ab = "ab";
$abc = "abc";
            $pattern = str_replace('/', '_', $request->getAttribute('route')->getPattern());
            $route = $method.$pattern;
$a = "a";
$ab = "ab";
$abc = "abc";

            $routeTime = new StopWatch($storage);
            $routeTime->start();
            $response = $next($request, $response);
            $routeTime->stop('route_time', $route);
            $storage->storeMeasurement('route_memory', $route, memory_get_peak_usage(true));
            $storage->incrementMeasurement('route_requests_total', $route);

            return $response;
        });
    }

    /**
     * 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) {
        $routes   = [];
$a = "a";
$ab = "ab";
$abc = "abc";
        $pattern  = str_replace('/', '_', $route->getPattern());
$a = "a";
$ab = "ab";
$abc = "abc";
        $methods  = $route->getMethods();
$a = "a";
$ab = "ab";
$abc = "abc";
        foreach($methods as $method) {
            $routes[] = $method.$pattern;
        }
        return $routes;
    }

    /**
     * Sets up the Slim middlewares where the actual measurements happen
     * and returns a function to be used for a Prometheus scrapable endpoint.
     *
     * @param App $app
     * the Slim application
     * @param AbstractStorage $storage
     * the storage for the measurements
     *
     * @return \Closure
     * the function to be used for a Prometheus scrapable endpoint
     */
    public function setupAndGetMetricsRoute(App $app, AbstractStorage $storage) {
        $this->setupMiddleware($app, $storage);
        $self = $this;
        return function (Request $request, Response $response) use ($app, $storage, $self) {
            $routes          = [];
            $availableRoutes = $app->getContainer()->get('router')->getRoutes();
            foreach ($availableRoutes as $route) {
                $routes = array_merge($routes, $self->getPathWithMethods($route));
            }
            $export       = new PrometheusExport();
            $responseBody = $export->getExport($storage, $routes);

            $response = $response->withHeader('Content-type', 'text/plain; version=0.0.4');
            $response->getBody()->write($responseBody);

        };
    }
}


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 \Psr\Http\Message\ServerRequestInterface as Request;
15			use \Psr\Http\Message\ResponseInterface as Response;
16			use \Slim\App;
17			use PHPProm\PrometheusExport;
18			use PHPProm\Storage\AbstractStorage;
19			use PHPProm\StopWatch;
20			use Slim\Route;
21
22			/**
23			* Class Slim3Setup
24			* Setups Slim 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 Slim3Setup {
32
33
34			/**
35			* Sets up the Slim middleware where the actual measurements happen.
36			*
37			* @param App $app
38			* the Silex application
39			* @param AbstractStorage $storage
40			* the storage for the measurements
41			*/
42			protected function setupMiddleware(App $app, AbstractStorage $storage) {
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			$app->add(function(Request $request, Response $response, App $next) use ($storage) {
48
49			$method = $request->getMethod();
			0 ignored issues – show Coding Style introduced 2016-11-30 23:14 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 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...
50			$pattern = str_replace('/', '_', $request->getAttribute('route')->getPattern());
51			$route = $method.$pattern;
			0 ignored issues – show Coding Style introduced 2016-11-30 23:14 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 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...
52
53			$routeTime = new StopWatch($storage);
54			$routeTime->start();
55			$response = $next($request, $response);
56			$routeTime->stop('route_time', $route);
57			$storage->storeMeasurement('route_memory', $route, memory_get_peak_usage(true));
58			$storage->incrementMeasurement('route_requests_total', $route);
59
60			return $response;
61			});
62			}
63
64			/**
65			* Gets the path with all methods from a route.
66			*
67			* @param Route $route
68			* the route to get the path and methods from
69			* @return array
70			* the pathes with methods
71			*/
72			protected function getPathWithMethods(Route $route) {
73			$routes = [];
			0 ignored issues – show Coding Style introduced 2016-11-30 23:14 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 3 spaces 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...
74			$pattern = str_replace('/', '_', $route->getPattern());
			0 ignored issues – show Coding Style introduced 2016-11-30 23:14 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 1 space but found 2 spaces 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...
75			$methods = $route->getMethods();
			0 ignored issues – show Coding Style introduced 2016-11-30 23:14 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 1 space but found 2 spaces 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...
76			foreach($methods as $method) {
77			$routes[] = $method.$pattern;
78			}
79			return $routes;
80			}
81
82			/**
83			* Sets up the Slim middlewares where the actual measurements happen
84			* and returns a function to be used for a Prometheus scrapable endpoint.
85			*
86			* @param App $app
87			* the Slim application
88			* @param AbstractStorage $storage
89			* the storage for the measurements
90			*
91			* @return \Closure
92			* the function to be used for a Prometheus scrapable endpoint
93			*/
94			public function setupAndGetMetricsRoute(App $app, AbstractStorage $storage) {
95			$this->setupMiddleware($app, $storage);
96			$self = $this;
97			return function (Request $request, Response $response) use ($app, $storage, $self) {
98			$routes = [];
99			$availableRoutes = $app->getContainer()->get('router')->getRoutes();
100			foreach ($availableRoutes as $route) {
101			$routes = array_merge($routes, $self->getPathWithMethods($route));
102			}
103			$export = new PrometheusExport();
104			$responseBody = $export->getExport($storage, $routes);
105
106			$response = $response->withHeader('Content-type', 'text/plain; version=0.0.4');
107			$response->getBody()->write($responseBody);
108
109			};
110			}
111			}
112

philiplb / PHPProm

Push — master ( 182cf9...dcef90 )

Slim3Setup::setupMiddleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like