feat: allow configurable log levels

Author: jaredhendrickson13

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/BaseTraits.inc

@@ -3,6 +3,7 @@
 namespace RESTAPI\Core;
 
 use ReflectionClass;
+use RESTAPI\Models\RESTAPISettings;
 use function RESTAPI\Core\Tools\get_classes_from_namespace;
 
 /**
@@ -42,8 +43,11 @@ trait BaseTraits {
      * info.xml file.
      */
     public function log(int $level, string $message, string $logfile = 'restapi'): void {
-        # Only log debug messages when verbose logging is enabled
-        if ($level === LOG_DEBUG and !$this->config->debug_mode) {
+        # Get the log level limit from the RESTAPI settings
+        $log_limit = (int) RESTAPISettings::get_pkg_config()['log_level'] ?? 3;
+
+        # Do not log if the incoming level is higher than the configured log level
+        if ($level >= $log_limit) {
             return;
         }
 

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/RESTAPISettings.inc

@@ -31,6 +31,7 @@ class RESTAPISettings extends Model {
     public BooleanField $keep_backup;
     public BooleanField $login_protection;
     public BooleanField $log_successful_auth;
+    public IntegerField $log_level;
     public BooleanField $allow_pre_releases;
     public BooleanField $hateoas;
     public BooleanField $expose_sensitive_fields;
@@ -93,6 +94,22 @@ class RESTAPISettings extends Model {
             failed API authentication attempts are logged to prevent flooding the authentication logs. This field is
             only applicable when the API `login_protection` setting is enabled.",
         );
+        $this->log_level = new IntegerField(
+            default: 3,
+            choices: [
+                0 => '0 - Emergency',
+                1 => '1 - Alert',
+                2 => '2 - Critical',
+                3 => '3 - Error',
+                4 => '4 - Warning',
+                5 => '5 - Notice',
+                6 => '6 - Info',
+                7 => '7 - Debug',
+            ],
+            verbose_name: 'log level',
+            help_text: 'Sets the log level for API logging. The log level determines the severity of messages that are
+            logged. Setting a higher log level will include all messages of that level and lower severity.',
+        );
         $this->allow_pre_releases = new BooleanField(
             default: false,
             indicates_true: 'enabled',

pfSense-pkg-RESTAPI/files/usr/local/share/pfSense-pkg-RESTAPI/info.xml

@@ -20,6 +20,7 @@
             <keep_backup>enabled</keep_backup>
             <login_protection>enabled</login_protection>
             <log_successful_auth>disabled</log_successful_auth>
+            <log_level>3</log_level>
             <hateoas>disabled</hateoas>
             <expose_sensitive_fields>disabled</expose_sensitive_fields>
             <override_sensitive_fields></override_sensitive_fields>