Improve breadcrumbs

- Capture illuminate query events
- Swap out Monolog handler for illuminate.log

Author: dcramer

README.md

@@ -116,6 +116,9 @@ return array(
 
     // capture release as git sha
     // 'release' => trim(exec('git log --pretty="%h" -n1 HEAD')),
+
+    // Capture bindings on SQL queries
+    'breadcrumbs.sql_bindings' => true,
 );
 ```
 

examples/laravel-4.2/app/config/packages/sentry/sentry-laravel/config.php

@@ -5,4 +5,7 @@
 
     // capture release as git sha
     // 'release' => trim(exec('git log --pretty="%h" -n1 HEAD')),
+
+    // Capture bindings on SQL queries
+    'breadcrumbs.sql_bindings' => false,
 );

examples/laravel-4.2/app/routes.php

@@ -7,13 +7,14 @@
 |
 | Here is where you can register all of the routes for an application.
 | It's a breeze. Simply tell Laravel the URIs it should respond to
-| and give it the Closure to execute when that URI is requested.
+| and give it the controller to call when that URI is requested.
 |
 */
 
 function verifyCredentials()
 {
     Log::info('Verifying credentials');
+    $user = DB::table('migrations')->where('migration', 'a migration')->first();
     throw new Exception('No credentials passed!');
 }
 

examples/laravel-5.1/config/sentry.php

@@ -5,4 +5,7 @@
 
     // capture release as git sha
     // 'release' => trim(exec('git log --pretty="%h" -n1 HEAD')),
+
+    // Capture bindings on SQL queries
+    'breadcrumbs.sql_bindings' => true,
 );

examples/laravel-5.2/app/Http/routes.php

@@ -14,6 +14,7 @@
 function verifyCredentials()
 {
     Log::info('Verifying credentials');
+    $user = DB::table('users')->where('name', 'John')->first();
     throw new Exception('No credentials passed!');
 }
 

examples/laravel-5.2/config/sentry.php

@@ -5,4 +5,7 @@
 
     // capture release as git sha
     // 'release' => trim(exec('git log --pretty="%h" -n1 HEAD')),
+
+    // Capture bindings on SQL queries
+    'breadcrumbs.sql_bindings' => false,
 );

examples/lumen-5.2/app/Http/routes.php

@@ -11,7 +11,22 @@
 |
 */
 
+function verifyCredentials()
+{
+    Log::info('Verifying credentials');
+    $user = DB::table('migrations')->where('migration', 'a migration')->first();
+    throw new Exception('No credentials passed!');
+}
+
+
+function authenticateUser()
+{
+    Log::info('Authenticating the current user');
+    verifyCredentials();
+}
+
+
 $app->get('/', function () use ($app) {
     Log::info('Rendering a page thats about to error');
-    throw new Exception('An unhandled exception');
+    authenticateUser();
 });

examples/lumen-5.2/bootstrap/app.php

@@ -23,7 +23,7 @@
     realpath(__DIR__.'/../')
 );
 
-// $app->withFacades();
+$app->withFacades();
 
 // $app->withEloquent();
 

examples/lumen-5.2/config/sentry.php

@@ -2,4 +2,7 @@
 
 return array(
     'dsn' => 'https://e9ebbd88548a441288393c457ec90441:[email protected]/3235',
+
+    // Capture bindings on SQL queries
+    'breadcrumbs.sql_bindings' => false,
 );

src/Sentry/SentryLaravel/SentryLaravelEventHandler.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Sentry\SentryLaravel;
+
+use Illuminate\Events\Dispatcher;
+
+// Event handling inspired by the ``laravel-debugbar`` project:
+//   https://github.com/barryvdh/laravel-debugbar
+class SentryLaravelEventHandler
+{
+    public function __construct(\Raven_Client $client, array $config)
+    {
+        $this->client = $client;
+        $this->sqlBindings = (
+            isset($config['breadcrumbs.sql_bindings'])
+            ? $config['breadcrumbs.sql_bindings']
+            : true
+        );
+    }
+
+    public function subscribe(Dispatcher $events)
+    {
+        $this->events = $events;
+        $events->listen('*', [$this, 'onWildcardEvent']);
+    }
+
+    public function onWildcardEvent()
+    {
+        $name = $this->events->firing();
+        $args = func_get_args();
+        $data = null;
+        $level = 'info';
+        if ($name === 'Illuminate\Database\Events\QueryExecuted') {
+            $name = 'sql.query';
+            $message = $args[0]->sql;
+            $data = array(
+                'connectionName' => $args[0]->connectionName,
+            );
+            if ($this->sqlBindings) {
+                $bindings = $args[0]->bindings;
+                if (!empty($bindings)) {
+                    $data['bindings'] = $bindings;
+                }
+            }
+        } elseif ($name === 'illuminate.query') {
+            // $args = array(sql, bindings, ...)
+            $name = 'sql.query';
+            $message = $args[0];
+            $data = array(
+                'connectionName' => $args[3],
+            );
+            if ($this->sqlBindings) {
+                $bindings = $args[1];
+                if (!empty($bindings)) {
+                    $data['bindings'] = $bindings;
+                }
+            }
+        } elseif ($name === 'illuminate.log') {
+            $name = 'log.' . $args[0];
+            $level = $args[0];
+            $message = $args[1];
+            if (!empty($args[2])) {
+                $data = array('params' => $args[2]);
+            }
+        } else {
+            return;
+        }
+        $this->client->breadcrumbs->record(array(
+            'message' => $message,
+            'category' => $name,
+            'data' => $data,
+            'level' => $level,
+        ));
+    }
+}