Merge remote-tracking branch 'origin' into fix-active-config

jcalonso · jcalonso · commit 76965e19c27c · 2019-01-09T14:54:25.000Z
diff --git a/config/elastic-apm.php b/config/elastic-apm.php
@@ -3,13 +3,13 @@
 return [
     // Sets whether the apm reporting should be active or not
     'active'        => true,
-    
+
     'app' => [
         // The app name that will identify your app in Kibana / Elastic APM
-        'appName'       => 'Some App Name',
+        'appName'       => env('APM_APPNAME', 'Laravel'),
 
         // The version of your app
-        'appVersion'    => '',
+        'appVersion'    => env('APM_APPVERSION', ''),
     ],
 
     'env' => [
@@ -20,18 +20,25 @@
 
     'server' => [
         // The apm-server to connect to
-        'serverUrl'     => 'http://127.0.0.1:8200',
+        'serverUrl'     => env('APM_SERVERURL', 'http://127.0.0.1:8200'),
 
         // Token for x
-        'secretToken'   => null,
-        
+        'secretToken'   => env('APM_SECRETTOKEN', null),
+
         // API version of the apm agent you connect to
-        'apmVersion'     => 'v1',
+        'apmVersion'    => env('APM_APIVERSION', 'v1'),
 
         // Hostname of the system the agent is running on.
         'hostname'      => gethostname(),
     ],
 
+    'transactions' => [
+
+        //This option will bundle transaction on the route name without variables
+        'use_route_uri' => false,
+
+    ],
+
     'spans' => [
         // Depth of backtraces
         'backtraceDepth'=> 25,
@@ -41,10 +48,10 @@
 
         'querylog' => [
             // Set to false to completely disable query logging, or to 'auto' if you would like to use the threshold feature.
-            'enabled' => true,
+            'enabled' => env('APM_QUERYLOG', true),
 
             // If a query takes longer then 200ms, we enable the query log. Make sure you set enabled = 'auto'
-            'threshold' => 200,
+            'threshold' => env('APM_THRESHOLD', 200),
         ],
     ],
 ];
diff --git a/src/Contracts/VersionResolver.php b/src/Contracts/VersionResolver.php
@@ -0,0 +1,10 @@
+<?php
+
+
+namespace PhilKra\ElasticApmLaravel\Contracts;
+
+
+interface VersionResolver
+{
+    public function getVersion(): string;
+}
diff --git a/src/Middleware/RecordTransaction.php b/src/Middleware/RecordTransaction.php
@@ -3,8 +3,6 @@
 namespace PhilKra\ElasticApmLaravel\Middleware;
 
 use Closure;
-use Illuminate\Routing\Route;
-use Illuminate\Support\Facades\Auth;
 use PhilKra\Agent;
 
 class RecordTransaction
@@ -14,15 +12,19 @@ class RecordTransaction
      */
     protected $agent;
 
+    /**
+     * RecordTransaction constructor.
+     * @param Agent $agent
+     */
     public function __construct(Agent $agent)
     {
         $this->agent = $agent;
     }
 
     /**
      * [handle description]
-     * @param  Request  $request [description]
-     * @param  Closure $next    [description]
+     * @param  Request $request [description]
+     * @param  Closure $next [description]
      * @return [type]           [description]
      */
     public function handle($request, Closure $next)
@@ -35,24 +37,28 @@ public function handle($request, Closure $next)
         $response = $next($request);
 
         $transaction->setResponse([
-            'finished'     => true,
+            'finished' => true,
             'headers_sent' => true,
-            'status_code'  => $response->getStatusCode(),
-            'headers'      => $this->formatHeaders($response->headers->all()),
+            'status_code' => $response->getStatusCode(),
+            'headers' => $this->formatHeaders($response->headers->all()),
         ]);
 
         $transaction->setUserContext([
-            'id'    => optional($request->user())->id,
+            'id' => optional($request->user())->id,
             'email' => optional($request->user())->email,
         ]);
 
         $transaction->setMeta([
             'result' => $response->getStatusCode(),
-            'type'   => 'HTTP'
+            'type' => 'HTTP'
         ]);
 
         $transaction->setSpans(app('query-log')->toArray());
 
+        if (config('elastic-apm.transactions.use_route_uri')) {
+            $transaction->setTransactionName($this->getRouteUriTransactionName($request));
+        }
+
         $transaction->stop(
             $this->getDuration(LARAVEL_START)
         );
@@ -63,8 +69,8 @@ public function handle($request, Closure $next)
     /**
      * Perform any final actions for the request lifecycle.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Symfony\Component\HttpFoundation\Response  $response
+     * @param  \Illuminate\Http\Request $request
+     * @param  \Symfony\Component\HttpFoundation\Response $response
      *
      * @return void
      */
@@ -74,12 +80,14 @@ public function terminate($request, $response)
     }
 
     /**
-     * @param  \Illuminate\Http\Request  $request
+     * @param  \Illuminate\Http\Request $request
+     *
+     * @return string
      */
-    protected function getTransactionName(\Illuminate\Http\Request $request)
+    protected function getTransactionName(\Illuminate\Http\Request $request): string
     {
         // fix leading /
-        $path = ($request->server->get('PATH_INFO') == '') ? '/' : $request->server->get('PATH_INFO');
+        $path = ($request->server->get('REQUEST_URI') == '') ? '/' : $request->server->get('REQUEST_URI');
 
         return sprintf(
             "%s %s",
@@ -88,6 +96,27 @@ protected function getTransactionName(\Illuminate\Http\Request $request)
         );
     }
 
+    /**
+     * @param  \Illuminate\Http\Request $request
+     *
+     * @return string
+     */
+    protected function getRouteUriTransactionName(\Illuminate\Http\Request $request): string
+    {
+        $path = ($request->route()->uri === '/') ? '' : $request->route()->uri;
+
+        return sprintf(
+            "%s /%s",
+            $request->server->get('REQUEST_METHOD'),
+            $path
+        );
+    }
+
+    /**
+     * @param $start
+     *
+     * @return float
+     */
     protected function getDuration($start): float
     {
         $diff = microtime(true) - $start;
@@ -96,6 +125,11 @@ protected function getDuration($start): float
         return round($corrected, 3);
     }
 
+    /**
+     * @param array $headers
+     *
+     * @return array
+     */
     protected function formatHeaders(array $headers): array
     {
         return collect($headers)->map(function ($values, $header) {
diff --git a/src/Providers/ElasticApmServiceProvider.php b/src/Providers/ElasticApmServiceProvider.php
@@ -2,10 +2,11 @@
 
 namespace PhilKra\ElasticApmLaravel\Providers;
 
-use Illuminate\Support\ServiceProvider;
 use Illuminate\Database\Events\QueryExecuted;
 use Illuminate\Support\Collection;
+use Illuminate\Support\ServiceProvider;
 use PhilKra\Agent;
+use PhilKra\ElasticApmLaravel\Contracts\VersionResolver;
 
 class ElasticApmServiceProvider extends ServiceProvider
 {
@@ -17,7 +18,7 @@ class ElasticApmServiceProvider extends ServiceProvider
     public function boot()
     {
         $this->publishes([
-            __DIR__.'/../../config/elastic-apm.php' => config_path('elastic-apm.php'),
+            __DIR__ . '/../../config/elastic-apm.php' => config_path('elastic-apm.php'),
         ], 'config');
 
         if (config('elastic-apm.active') === true && config('elastic-apm.spans.querylog.enabled') !== false) {
@@ -33,7 +34,7 @@ public function boot()
     public function register()
     {
         $this->mergeConfigFrom(
-            __DIR__.'/../../config/elastic-apm.php',
+            __DIR__ . '/../../config/elastic-apm.php',
             'elastic-apm'
         );
 
@@ -45,26 +46,48 @@ public function register()
                         'frameworkVersion' => app()->version(),
                     ],
                     ['active' => config('elastic-apm.active')],
-                    config('elastic-apm.app'),
+                    $this->getAppConfig(),
                     config('elastic-apm.env'),
                     config('elastic-apm.server')
                 )
             );
         });
-        
+
         $this->app->alias(Agent::class, 'elastic-apm');
         $this->app->instance('query-log', collect([]));
     }
 
+    /**
+     * @return array
+     */
+    protected function getAppConfig(): array
+    {
+        $config = config('elastic-apm.app');
+
+        if ($this->app->bound(VersionResolver::class)) {
+            $config['appVersion'] = $this->app->make(VersionResolver::class)->getVersion();
+        }
+
+        return $config;
+    }
+
+    /**
+     * @param Collection $stackTrace
+     * @return Collection
+     */
     protected function stripVendorTraces(Collection $stackTrace): Collection
     {
         return collect($stackTrace)->filter(function ($trace) {
             return !starts_with(array_get($trace, 'file'), [
-                base_path().'/vendor',
+                base_path() . '/vendor',
             ]);
         });
     }
 
+    /**
+     * @param array $stackTrace
+     * @return Collection
+     */
     protected function getSourceCode(array $stackTrace): Collection
     {
         if (config('elastic-apm.spans.renderSource', false) === false) {
@@ -77,9 +100,12 @@ protected function getSourceCode(array $stackTrace): Collection
 
         $fileLines = file(array_get($stackTrace, 'file'));
         return collect($fileLines)->filter(function ($code, $line) use ($stackTrace) {
-            $lineStart = array_get($stackTrace, 'line') - 5;
-            $lineStop = array_get($stackTrace, 'line') + 5;
-            
+            //file starts counting from 0, debug_stacktrace from 1
+            $stackTraceLine = array_get($stackTrace, 'line') - 1;
+
+            $lineStart = $stackTraceLine - 5;
+            $lineStop = $stackTraceLine + 5;
+
             return $line >= $lineStart && $line <= $lineStop;
         })->groupBy(function ($code, $line) use ($stackTrace) {
             if ($line < array_get($stackTrace, 'line')) {
@@ -117,7 +143,8 @@ protected function listenForQueries()
                 $sourceCode = $this->getSourceCode($trace);
 
                 return [
-                    'function' => array_get($trace, 'function').array_get($trace, 'type').array_get($trace, 'function'),
+                    'function' => array_get($trace, 'function') . array_get($trace, 'type') . array_get($trace,
+                            'function'),
                     'abs_path' => array_get($trace, 'file'),
                     'filename' => basename(array_get($trace, 'file')),
                     'lineno' => array_get($trace, 'line', 0),
@@ -128,11 +155,12 @@ protected function listenForQueries()
                     'post_context' => optional($sourceCode->get('post_context'))->toArray(),
                 ];
             })->values();
-            
+
             $query = [
                 'name' => 'Eloquent Query',
                 'type' => 'db.mysql.query',
-                'start' => round((microtime(true) - $query->time/1000 - LARAVEL_START) * 1000, 3), // calculate start time from duration
+                'start' => round((microtime(true) - $query->time / 1000 - LARAVEL_START) * 1000, 3),
+                // calculate start time from duration
                 'duration' => round($query->time, 3),
                 'stacktrace' => $stackTrace,
                 'context' => [
@@ -144,7 +172,7 @@ protected function listenForQueries()
                     ],
                 ],
             ];
-        
+
             app('query-log')->push($query);
         });
     }
