Error reporting (librenms#14190)

* Error reporting * Move code to ErrorReportingProvider Enable reporting of error (and warning) messages. report module exceptions * Restore flare key Not needed to set late anymore. We set up filtering before it is initialized. * Remove unnecessary and maybe double Flare report * lint * Cannot use typed properties yet, use phpdoc * fix handleError return type * Filter both exceptions and reports (so we don't miss any) Consolidate the check if reporting should be enabled * Cache reportingEnabled check for the runtime * Split out middleware to improve readability Logging of why reporting is disabled Fix reportingEnabled cache * Style * Return some user data * Change to class based middleware, it looks nicer * Fix error page error id report, add url. * also rewrite intended url * remove link * Move ignition to production and update flare-client Co-authored-by: Tony Murray <[email protected]>
otkd · Aug 23, 2022 · 1dbab5a · 1dbab5a
1 parent 9ce05d7
commit 1dbab5a
Show file tree

Hide file tree

Showing 19 changed files with 760 additions and 205 deletions.
diff --git a/LibreNMS/Config.php b/LibreNMS/Config.php
@@ -47,7 +47,7 @@ class Config
     public static function load()
     {
         // don't reload the config if it is already loaded, reload() should be used for that
-        if (! is_null(self::$config)) {
+        if (self::isLoaded()) {
             return self::$config;
         }
 
@@ -566,4 +566,14 @@ public static function populateLegacyDbCredentials()
         self::set('db_port', config("database.connections.$db.port", 3306));
         self::set('db_socket', config("database.connections.$db.unix_socket"));
     }
+
+    /**
+     * Check if the config has been loaded yet
+     *
+     * @return bool
+     */
+    public static function isLoaded(): bool
+    {
+        return ! is_null(self::$config);
+    }
 }
diff --git a/LibreNMS/Poller.php b/LibreNMS/Poller.php
@@ -190,6 +190,7 @@ private function pollModules(): void
                     // isolate module exceptions so they don't disrupt the polling process
                     $this->logger->error("%rError polling $module module for {$this->device->hostname}.%n $e", ['color' => true]);
                     \Log::event("Error polling $module module. Check log file for more details.", $this->device, 'poller', Alert::ERROR);
+                    report($e);
                 }
 
                 app(MeasurementManager::class)->printChangedStats();

diff --git a/LibreNMS/Util/Git.php b/LibreNMS/Util/Git.php
@@ -27,6 +27,7 @@
 
 use Carbon\Carbon;
 use LibreNMS\Config;
+use Symfony\Component\Process\Process;
 
 class Git
 {
@@ -53,4 +54,45 @@ public static function localDate(): Carbon
     {
         return \Date::createFromTimestamp(exec("git show --pretty='%ct' -s HEAD"));
     }
+
+    public static function unchanged(): bool
+    {
+        $process = new Process(['git', 'diff-index', '--quiet', 'HEAD']);
+        $process->disableOutput();
+        $process->run();
+
+        return $process->getExitCode() === 0;
+    }
+
+    /**
+     * Note: It assumes origin/master points to github.com/librenms/librenms for this to work.
+     */
+    public static function officalCommit(?string $hash = null, string $remote = 'origin/master'): bool
+    {
+        if ($hash === null) {
+            $process = new Process(['git', 'rev-parse', 'HEAD']);
+            $process->run();
+
+            $hash = trim($process->getOutput());
+        }
+
+        $process = new Process(['git', 'branch', '--remotes', '--contains', $hash, $remote]);
+        $process->run();
+
+        if ($process->isSuccessful()) {
+            if (trim($process->getOutput()) == $remote) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public static function remoteUrl(string $remote = 'origin'): string
+    {
+        $process = new Process(['git', 'ls-remote', '--get-url', $remote]);
+        $process->run();
+
+        return trim($process->getOutput());
+    }
 }
diff --git a/app/Logging/Reporting/Middleware/CleanContext.php b/app/Logging/Reporting/Middleware/CleanContext.php
@@ -0,0 +1,66 @@
+<?php
+/**
+ * CleanContext.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * @link       https://www.librenms.org
+ *
+ * @copyright  2022 Tony Murray
+ * @author     Tony Murray <[email protected]>
+ */
+
+namespace App\Logging\Reporting\Middleware;
+
+use Facade\FlareClient\Report;
+
+class CleanContext
+{
+    /**
+     * Middleware to remove sensitive data from the context.
+     *
+     * @param  \Facade\FlareClient\Report  $report
+     * @param  callable  $next
+     * @return mixed
+     */
+    public function handle(Report $report, $next)
+    {
+        try {
+            $report->setApplicationPath('');
+            $context = $report->allContext();
+
+            if (isset($context['request']['url'])) {
+                $context['request']['url'] = str_replace($context['headers']['host'] ?? '', 'librenms', $context['request']['url']);
+            }
+
+            if (isset($context['session']['url']['intended'])) {
+                $context['session']['url']['intended'] = str_replace($context['headers']['host'] ?? '', 'librenms', $context['session']['url']['intended']);
+            }
+
+            if (isset($context['session']['_previous']['url'])) {
+                $context['session']['_previous']['url'] = str_replace($context['headers']['host'] ?? '', 'librenms', $context['session']['_previous']['url']);
+            }
+
+            $context['headers']['host'] = null;
+            $context['headers']['referer'] = null;
+
+            $report->userProvidedContext($context);
+        } catch (\Exception $e) {
+        }
+
+        return $next($report);
+    }
+}
diff --git a/app/Logging/Reporting/Middleware/SetGroups.php b/app/Logging/Reporting/Middleware/SetGroups.php
@@ -0,0 +1,62 @@
+<?php
+/**
+ * SetGroups.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * @link       https://www.librenms.org
+ *
+ * @copyright  2022 Tony Murray
+ * @author     Tony Murray <[email protected]>
+ */
+
+namespace App\Logging\Reporting\Middleware;
+
+use Facade\FlareClient\Report;
+use LibreNMS\Util\Version;
+
+class SetGroups
+{
+    /**
+     * Middleware to set LibreNMS and Tools grouping data
+     *
+     * @param  \Facade\FlareClient\Report  $report
+     * @param  callable  $next
+     * @return mixed
+     */
+    public function handle(Report $report, $next)
+    {
+        try {
+            $version = Version::get();
+
+            $report->group('LibreNMS', [
+                'Git version' => $version->local(),
+                'App version' => Version::VERSION,
+            ]);
+
+            $report->group('Tools', [
+                'Database' => $version->databaseServer(),
+                'Net-SNMP' => $version->netSnmp(),
+                'Python' => $version->python(),
+                'RRDtool' => $version->rrdtool(),
+
+            ]);
+        } catch (\Exception $e) {
+        }
+
+        return $next($report);
+    }
+}
diff --git a/app/Models/User.php b/app/Models/User.php
@@ -40,6 +40,11 @@ class User extends Authenticatable
         'can_modify_passwd' => 'integer',
     ];
 
+    public function toFlare(): array
+    {
+        return $this->only(['level', 'auth_type', 'enabled']);
+    }
+
     // ---- Helper Functions ----
 
     /**

diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php
@@ -90,7 +90,7 @@ private function configureMorphAliases()
     private function registerFacades()
     {
         // replace log manager so we can add the event function
-        $this->app->bind('log', function ($app) {
+        $this->app->singleton('log', function ($app) {
             return new \App\Facades\LogManager($app);
         });
     }

diff --git a/app/Providers/ErrorReportingProvider.php b/app/Providers/ErrorReportingProvider.php
@@ -0,0 +1,156 @@
+<?php
+/**
+ * ErrorReportingProvider.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * @link       https://www.librenms.org
+ *
+ * @copyright  2022 Tony Murray
+ * @author     Tony Murray <[email protected]>
+ */
+
+namespace App\Providers;
+
+use App\Logging\Reporting\Middleware\CleanContext;
+use App\Logging\Reporting\Middleware\SetGroups;
+use ErrorException;
+use Facade\FlareClient\Report;
+use Facade\Ignition\Facades\Flare;
+use Illuminate\Support\Str;
+use LibreNMS\Config;
+use LibreNMS\Util\Git;
+
+class ErrorReportingProvider extends \Facade\Ignition\IgnitionServiceProvider
+{
+    /** @var int */
+    protected $errorReportingLevel = E_ALL & ~E_NOTICE;
+    /** @var callable */
+    private $laravelErrorHandler;
+    /** @var bool */
+    private $reportingEnabled;
+
+    public function boot(): void
+    {
+        Flare::filterExceptionsUsing(function (\Exception $e) {
+            return $this->isReportingEnabled();
+        });
+
+        Flare::filterReportsUsing(function (Report $report) {
+            return $this->isReportingEnabled();
+        });
+
+        Flare::determineVersionUsing(function () {
+            return \LibreNMS\Util\Version::VERSION;
+        });
+
+        // Filter some extra fields for privacy
+        // Move to header middleware when switching to spatie/laravel-ignition
+        Flare::registerMiddleware(CleanContext::class);
+
+        // Add more LibreNMS related info
+        Flare::registerMiddleware(SetGroups::class);
+
+        // Override the Laravel error handler but save it to call when in modern code
+        $this->laravelErrorHandler = set_error_handler([$this, 'handleError']);
+
+        parent::boot();
+    }
+
+    /**
+     * Checks the state of the config and current install to determine if reporting should be enabled
+     * The primary factor is the setting reporting.error
+     */
+    public function isReportingEnabled(): bool
+    {
+        if ($this->reportingEnabled !== null) {
+            return $this->reportingEnabled;
+        }
+
+        // safety check so we don't leak early reports (but reporting should not be loaded before the config is)
+        if (! Config::isLoaded()) {
+            return false;
+        }
+
+        $this->reportingEnabled = false; // don't cache before config is loaded
+
+        // check the user setting
+        if (! Config::get('reporting.error')) {
+            \Log::debug('Reporting disabled by user setting');
+
+            return false;
+        }
+
+        // Only run in production
+        if (! $this->app->isProduction()) {
+            \Log::debug('Reporting disabled because app is not in production');
+
+            return false;
+        }
+
+        // Check git
+        if (Git::repoPresent()) {
+            if (! Str::contains(Git::remoteUrl(), ['[email protected]:librenms/librenms.git', 'https://github.com/librenms/librenms.git'])) {
+                \Log::debug('Reporting disabled because LibreNMS is not from the official repository');
+
+                return false;
+            }
+
+            if (! Git::unchanged()) {
+                \Log::debug('Reporting disabled because LibreNMS is not from the official repository');
+
+                return false;
+            }
+
+            if (! Git::officalCommit()) {
+                \Log::debug('Reporting disabled due to local modifications');
+
+                return false;
+            }
+        }
+
+        $this->reportingEnabled = true;
+
+        return true;
+    }
+
+    /**
+     * Report PHP deprecations, or convert PHP errors to ErrorException instances.
+     *
+     * @param  int  $level
+     * @param  string  $message
+     * @param  string  $file
+     * @param  int  $line
+     * @param  array  $context
+     * @return bool
+     *
+     * @throws \ErrorException
+     */
+    public function handleError($level, $message, $file = '', $line = 0, $context = []): bool
+    {
+        // report errors if they are allowed
+        if ($this->errorReportingLevel & $level) {
+            Flare::report(new ErrorException($message, 0, $level, $file, $line));
+        }
+
+        // call the laravel error handler, unless using a legacy entry point (init.php)
+        if (! defined('IGNORE_ERRORS')) {
+            call_user_func($this->laravelErrorHandler, $level, $message, $file, $line);
+        }
+
+        return true;
+    }
+}