Fixed temp logic in system status endpoint, updated JSON structure in system status endpoint, updated docs

Author: Jared Hendrickson

README.md

@@ -3594,7 +3594,7 @@ URL: https://{{$hostname}}/api/v1/status/log/system
 ### 1. Read System Status
 
 
-Read system status and metrics.<br><br>
+Read system status and metrics. All usage values are represented as a decimal percentage. Temperature readings require thermal sensor and/or driver configuration.<br><br>
 
 _Requires at least one of the following privileges:_ [`page-all`, `page-dashboard-widgets`, `page-dashboard-all`]
 

docs/documentation.json

@@ -4705,7 +4705,7 @@
 										"system"
 									]
 								},
-								"description": "Read system status and metrics.<br><br>\n\n_Requires at least one of the following privileges:_ [`page-all`, `page-dashboard-widgets`, `page-dashboard-all`]"
+								"description": "Read system status and metrics. All usage values are represented as a decimal percentage. Temperature readings require thermal sensor and/or driver configuration.<br><br>\n\n_Requires at least one of the following privileges:_ [`page-all`, `page-dashboard-widgets`, `page-dashboard-all`]"
 							},
 							"response": []
 						}

pfSense-pkg-API/files/etc/inc/api/models/APIStatusSystemRead.inc

@@ -15,6 +15,7 @@
 
 require_once("api/framework/APIModel.inc");
 require_once("api/framework/APIResponse.inc");
+require_once("includes/functions.inc.php");
 
 
 class APIStatusSystemRead extends APIModel {
@@ -29,13 +30,6 @@ class APIStatusSystemRead extends APIModel {
     }
 
     private function __get_metrics() {
-        include_once("includes/functions.inc.php");
-        # Pre-return definitions
-        foreach(get_mounted_filesystems() as $fs) {
-            if ($fs["mountpoint"] === "/") {
-                $disk_usage = APITools\float_percent($fs["percent_used"]);
-            }
-        }
 
         # Place each gathered metric into our return array
         $sys_info = [
@@ -46,14 +40,15 @@ class APIStatusSystemRead extends APIModel {
             "bios_version" => $this->__get_bios_info()["bios_version"],
             "bios_date" => $this->__get_bios_info()["bios_date"],
             "cpu_model" => get_single_sysctl("hw.model"),
+            "kernel_pti" => boolval(get_single_sysctl('vm.pmap.pti')),
             "mds_mitigation" => get_single_sysctl('hw.mds_disable_state'),
-            "mbuf_usage" => $this->__get_mbuf_usage(),
             "temp_c" => $this->__get_temp(),
             "temp_f" => $this->__get_temp(false),
             "load_avg" => $this->__get_load_avg(),
+            "mbuf_usage" => $this->__get_mbuf_usage(),
             "mem_usage" => (!is_null(mem_usage())) ? APITools\float_percent(mem_usage()) : null,
             "swap_usage" => (!is_null(swap_usage())) ? APITools\float_percent(swap_usage()) : null,
-            "disk_usage" => $disk_usage
+            "disk_usage" => $this->__get_filesystem_usage()
         ];
         return $sys_info;
     }
@@ -69,9 +64,9 @@ class APIStatusSystemRead extends APIModel {
     # Gets the current CPU temperatures in either Fº or Cº, return null if no temperature could be found
     private function __get_temp($celsius=true) {
         if ($celsius) {
-            return (!empty(get_temp())) ? get_temp() : null;
+            return (!empty(get_temp())) ? floatval(get_temp()) : null;
         } else {
-            return (!empty(get_temp())) ? get_temp() * 1.8 + 32 : null;
+            return (!empty(get_temp())) ? floatval(get_temp()) * 1.8 + 32 : null;
         }
     }
 
@@ -96,4 +91,13 @@ class APIStatusSystemRead extends APIModel {
         return $bios_info;
     }
 
+    # Gathers filesystem usage data
+    private function __get_filesystem_usage() {
+        foreach(get_mounted_filesystems() as $fs) {
+            if ($fs["mountpoint"] === "/") {
+                return APITools\float_percent($fs["percent_used"]);
+            }
+        }
+    }
+
 }

pfSense-pkg-API/files/usr/local/www/api/documentation/index.php

@@ -1236,7 +1236,7 @@
 <a class=text-info data-toggle=collapse data-parent=#accordion-STATUS_2FSYSTEM href=#collapse-STATUS_2FSYSTEM-ReadSystemStatus><h4 class=panel-title><span class="glyphicon glyphicon-plus"></span><strong>Read System Status</strong> &nbsp;|&nbsp;
 <strong class="request-method border-info">GET</strong>
 &nbsp;
-https://<?echo $_SERVER['HTTP_HOST'];?>/api/v1/status/system</h4></a></div><div id=collapse-STATUS_2FSYSTEM-ReadSystemStatus class="panel-collapse collapse"><div class=panel-body><h5 class="label label-default">Description</h5><br><small><p>Read system status and metrics.<br><br><p><em>Requires at least one of the following privileges:</em> [<code>page-all</code>, <code>page-dashboard-widgets</code>, <code>page-dashboard-all</code>]</small><br><br><h5 class="label label-primary">Body</h5><span class=resp-prettyprint>{
+https://<?echo $_SERVER['HTTP_HOST'];?>/api/v1/status/system</h4></a></div><div id=collapse-STATUS_2FSYSTEM-ReadSystemStatus class="panel-collapse collapse"><div class=panel-body><h5 class="label label-default">Description</h5><br><small><p>Read system status and metrics. All usage values are represented as a decimal percentage. Temperature readings require thermal sensor and/or driver configuration.<br><br><p><em>Requires at least one of the following privileges:</em> [<code>page-all</code>, <code>page-dashboard-widgets</code>, <code>page-dashboard-all</code>]</small><br><br><h5 class="label label-primary">Body</h5><span class=resp-prettyprint>{
 }</span><div class=clearfix></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 class=panel-title id=SYSTEM_2FAPI>SYSTEM/API
 <span class=badge>2</span></h3></div><div class=panel-body><p><div class=request-item><div class=panel-group id=accordion-SYSTEM_2FAPI><div class="panel panel-info" id=jump-SYSTEM_2FAPI-ReadSystemAPIConfiguration><div class=panel-heading><small class="pull-right text-muted">raw</small>
 <a class=text-info data-toggle=collapse data-parent=#accordion-SYSTEM_2FAPI href=#collapse-SYSTEM_2FAPI-ReadSystemAPIConfiguration><h4 class=panel-title><span class="glyphicon glyphicon-plus"></span><strong>Read System API Configuration</strong> &nbsp;|&nbsp;
@@ -1497,7 +1497,7 @@
 function IsJsonString(str){try{JSON.parse(str);}catch(e){return false;}
 return true;}
 String.prototype.replaceAll=function(replaceThis,withThis){var re=new RegExp(RegExp.quote(replaceThis),"g");return this.replace(re,withThis);};RegExp.quote=function(str){return str.replace(/([.?*+^$[\]\\(){}-])/g,"\\$1");};function syntaxHighlight(json){json=json.replace(/&/g,'&amp;').replace(/</g,'&lt;').replace(/>/g,'&gt;');return json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g,function(match){var cls='number';if(/^"/.test(match)){if(/:$/.test(match)){cls='key';}else{cls='string';}}else if(/true|false/.test(match)){cls='boolean';}else if(/null/.test(match)){cls='null';}
-return '<span class="'+cls+'">'+match+'</span>';});}</script><br><br><footer class="navbar-default navbar-fixed-bottom"><div class=container-fluid><div class="span12 text-center"><span data-toggle=tooltip title="If the application help you, please feel free to give a star to the project in github. Your star inspire me to work more on open-source projects like this!">Made with <em class=love-color>&#9829;</em> by <a href=https://github.com/thedevsaddam target=_blank class=text-muted>thedevsaddam</a> | Generated at: 2020-11-12 19:16:43 by <a href=https://github.com/thedevsaddam/docgen target=_blank class=text-muted>docgen</a></span></div></div></footer>
+return '<span class="'+cls+'">'+match+'</span>';});}</script><br><br><footer class="navbar-default navbar-fixed-bottom"><div class=container-fluid><div class="span12 text-center"><span data-toggle=tooltip title="If the application help you, please feel free to give a star to the project in github. Your star inspire me to work more on open-source projects like this!">Made with <em class=love-color>&#9829;</em> by <a href=https://github.com/thedevsaddam target=_blank class=text-muted>thedevsaddam</a> | Generated at: 2020-11-13 09:31:55 by <a href=https://github.com/thedevsaddam/docgen target=_blank class=text-muted>docgen</a></span></div></div></footer>
 <style>
     body {
         display: block;