Create function, endpoint, frontend implementation for log persistence

Update CHANGELOG.md

Lint ctrl.py

Add persist_logs bool and integrate throughout the config flow
Add many logger.info chunks for testing

Add more logic to persist_logs toggle endpoint

Change how default value is handled

Change default permissions of journald.conf

Fix spelling errors, add logger on frontend

Move toggle_log_persistance away from FastAPI and towards the Api object

Linting

Call reinit at end of log toggle, reword models.py description of persist_logs

Remove all uses of persist_logs from amplipi core, move to updater side

Remove lingering changes from app.py, ctrl.py

pylint

pylint (2)

Finish porting new admin settings tab to updater

Change name of Updates tab on settings page

Fix spelling in comment in app.py

Author: SteveMicroNova

CHANGELOG.md

@@ -37,6 +37,7 @@
   * Move system state out of running software directory
   * Fix updates on systems with an API password set
   * Fix the display service on systems with an API password set
+  * Add toggleable option to persist logs
 * Streams
   * File Players can be temporary. A temporary File Player will remove itself from the list of available streams once disconnected from all sources.
   * File Players run their own Python container process similar to Internet Radio Stations, rather than running a cvlc command.

amplipi/app.py

@@ -225,7 +225,7 @@ def shutdown():
   """
   # preemptively save the state (just in case the shutdown procedure doesn't invoke a save)
   get_ctrl().save()
-  # start the shutdown process and returning immediately (hopeully before the shutdown process begins)
+  # start the shutdown process and returning immediately (hopefully before the shutdown process begins)
   Popen('sleep 1 && sudo systemctl poweroff', shell=True)
 
 

amplipi/ctrl.py

@@ -222,7 +222,7 @@ def reinit(self, settings: models.AppSettings = models.AppSettings(), change_not
     except Exception as exc:
       logger.exception("Error setting is_streamer flag: {exc}")
 
-    # determine if we're in LMS mode, based on a file
+    # determine if we're in LMS mode, based on a file existing
     lms_mode_path = Path(defaults.USER_CONFIG_DIR, 'lms_mode')
     if lms_mode_path.exists():
       logger.info("lms mode")

amplipi/updater/asgi.py

@@ -36,6 +36,9 @@
 import shutil
 import asyncio
 
+import configparser
+from typing import Optional
+
 # web framework
 import requests
 from fastapi import FastAPI, Request, File, UploadFile, Depends, APIRouter, Response
@@ -95,6 +98,69 @@ class ReleaseInfo(BaseModel):
   logger.exception(f'Error loading identity file: {e}')
 
 
+@router.get("/settings/persist_logs")
+def get_log_persist_state():
+  conf_path = '/etc/systemd'
+  config = configparser.ConfigParser(strict=False, allow_no_value=True)
+  config.read(f'{conf_path}/journald.conf')
+  return config.get("Journal", "Storage", fallback="") == "persistent"
+
+
+@router.post("/settings/persist_logs")
+def toggle_persist_logs(value: Optional[bool] = None):
+  """
+  Toggles the option within journald to save logs to memory or storage.
+  Accepts an option bool called "value" for if you wish to change the value to a specific option rather than simply flip the state of the config file
+  """
+  try:
+    conf_path = '/etc/systemd'
+    config = configparser.ConfigParser(strict=False, allow_no_value=True)
+    config.read(f'{conf_path}/journald.conf')
+
+    if 'Journal' not in config:
+      config.add_section('Journal')
+
+    # goal_value is a holdover from when this setting was in app.py and toggled via the config settings page
+    # the bool is true if you wish to turn persistent logging on and false if you wish to turn it off
+    # It can be set either with the optional arg of the function or it attempts to find the current value from the config file and set the opposite of that
+    goal_value: bool
+    if value is not None:
+      goal_value = value
+    else:
+      goal_value = not get_log_persist_state()
+
+    if goal_value:  # Set persist
+      config.set('Journal', 'Storage', 'persistent')
+      config.set('Journal', 'SyncIntervalSec', '30s')
+      config.set('Journal', 'SystemMaxUse', '64M')
+
+      config.remove_option('Journal', 'RuntimeMaxUse')
+      config.remove_option('Journal', 'ForwardToConsole')
+      config.remove_option('Journal', 'ForwardToWall')
+
+      logger.info("persist_logs activated!")
+
+    else:  # Reset config to default as seen in configure.py
+      config.set('Journal', 'Storage', 'volatile')
+      config.set('Journal', 'RuntimeMaxUse', '64M')
+      config.set('Journal', 'ForwardToConsole', 'no')
+      config.set('Journal', 'ForwardToWall', 'no')
+
+      config.remove_option('Journal', 'SyncIntervalSec')
+      config.remove_option('Journal', 'SystemMaxUse')
+
+      logger.info("persist_logs deactivated!")
+
+    with open('/tmp/journald.conf.tmp', 'w', encoding="utf-8") as conf_file:
+      config.write(conf_file)
+
+    subprocess.run(['sudo', 'mv', '/tmp/journald.conf.tmp', f'{conf_path}/journald.conf'], check=True)
+    subprocess.run(['sudo', 'systemctl', 'restart', 'systemd-journald'], check=True)
+  except Exception as exc:
+    logger.error("persist_logs toggle failed!")
+    raise exc
+
+
 @router.get('/update')
 def get_index():
   """ Get the update website """

amplipi/updater/static/index.html

@@ -28,7 +28,7 @@
       </p>
       <h1><span class="text-white">Ampli</span><span class="text-danger">Pi</span></h1>
       <p class="lead mb-4">
-        Update your AmpliPi device
+        Update & configure your AmpliPi device
       </p>
       <div class="card">
         <div class="card-header">
@@ -43,7 +43,7 @@ <h1><span class="text-white">Ampli</span><span class="text-danger">Pi</span></h1
               <a class="nav-link" id="manual-update-tab" data-toggle="tab" href="#manual-update" role="tab" aria-controls="manual-update" aria-selected="false">Custom</a>
             </li>
             <li class="nav-item">
-              <a class="nav-link" id="set-password-tab" data-toggle="tab" href="#set-password" role="tab" aria-controls="set-password" aria-selected="false">Set Password</a>
+              <a class="nav-link" id="admin-settings-tab" data-toggle="tab" href="#admin-settings" role="tab" aria-controls="admin-settings" aria-selected="false">Admin Settings</a>
             </li>
             <li class="nav-item">
               <a class="nav-link" id="support-tunnel-tab" data-toggle="tab" href="#support-tunnel" role="tab" aria-controls="support-tunnel" aria-selected="false">Support Tunnel</a>
@@ -52,13 +52,15 @@ <h1><span class="text-white">Ampli</span><span class="text-danger">Pi</span></h1
         </div>
         <div class="card-body text-center">
           <div class="tab-content" id="myTabContent">
+
             <div class="tab-pane fade show active" id="latest-update" role="tabpanel" aria-labelledby="latest-update-tab">
               <div id='latest-update-name'>...</div>
               <div id='latest-update-desc' class="text-left"></div>
               <a id="submit-latest-update" role="button" class="btn btn-lg btn-primary text-center mt-3 d-none"
                 onclick="ui_start_software_update($('#latest-update').attr('data-url'), $('#latest-update').attr('data-version'));">
                 Start Update</a>
             </div>
+
             <div class="tab-pane fade" id="older-update" role="tabpanel" aria-labelledby="older-update-tab">
               <select class="custom-select" id="older-update-sel" onchange="ui_select_release(this);">
                 <!-- Releases populated from GH -->
@@ -69,12 +71,14 @@ <h1><span class="text-white">Ampli</span><span class="text-danger">Pi</span></h1
                  onclick="ui_start_software_update($('#older-update-sel').val(), $('#older-update-sel').find(':selected').data('version'));">
                 Start Update</a>
             </div>
+
             <div class="tab-pane fade" id="manual-update" role="tabpanel" aria-labelledby="manual-update-tab">
               <div class="custom-file">
                 <input id="update-file-selector" type="file" accept=".gz" onchange="$('#submit-custom-update').removeClass('disabled');">
               </div>
               <a id="submit-custom-update" role="button" class="btn btn-lg btn-primary text-center mt-3 disabled" onclick="ui_upload_software_update();">Start Update</a>
             </div>
+
             <div class="tab-pane fade text-left" id="set-password" role="tabpanel" aria-labelledby="set-password-tab">
               <div class="set-password-dialog">
                 This form allows you to set a password for the web interface. If the password fields are empty, it will unset the password protection. This will only set a password for the web interface, not the system password. This action will also log out any existing sessions.
@@ -87,6 +91,7 @@ <h1><span class="text-white">Ampli</span><span class="text-danger">Pi</span></h1
               </div>
               <a id="password" role="button" class="btn btn-lg btn-primary text-center mt-3" onClick="set_password();">Update Password</a>
             </div>
+
             <div class="tab-pane fade text-left" id="support-tunnel" role="tabpanel" aria-labelledby="support-tunnel-tab">
               <div id="support-tunnel-dialog">
                 This dialog allows you to request a support tunnel. Once requested, you must give the tunnel ID and preshared key to support, who can be reached via <a href="mailto:support@micro-nova.com">support@micro-nova.com</a>.
@@ -105,6 +110,36 @@ <h1><span class="text-white">Ampli</span><span class="text-danger">Pi</span></h1
                 </div>
               </div>
             </div>
+
+            <div class="tab-pane fade text-left" id="admin-settings" role="tabpanel" aria-labelledby="admin-settings-tab">
+              <script>
+                async function getPersist() {
+                  const response = await fetch("/settings/persist_logs", { method: "GET" });
+                  const data = await response.json();
+                  let checkbox = document.getElementById("persist_logs_checkbox");
+                  checkbox.checked = data;
+                }
+
+                async function setPersist() {
+                  const checkbox = document.getElementById("persist_logs_checkbox");
+                  const response = await fetch("/settings/persist_logs", {method: "POST"});
+                }
+
+                window.onload = getPersist;
+              </script>
+
+              <div id="admin-settings-dialog">
+                This tab allows you to change settings relating to the core of AmpliPi, things that do not belong on the standard config page
+              </div>
+              <p class="">
+                <a class="btn btn-primary btn-sm text-center" id="set-password-button" data-toggle="tab" href="#set-password" role="tab" aria-controls="set-password" aria-selected="false">Set Password</a>
+              </p>
+              <h6>WARNING: leaving log persistence on for extended periods can damage your system and void your warranty</h6>
+              <input id="persist_logs_checkbox" type="checkbox" onclick="setPersist()" />
+              <label for="persist_logs_checkbox">Log Persistence</label>
+            </div>
+
+
           </div>
         </div>
       </div>

web/src/pages/Settings/Settings.jsx

@@ -155,7 +155,7 @@ const Settings = ({ openPage }) => {
                     </ListItem>
 
                     <ListItem
-                        name="Updates"
+                        name="Admin"
                         onClick={() => {
                             window.location.href =
                                 "http://" + window.location.hostname + ":5001/update";