NetLock RMMNetLock RMM Docs
IV — Administration

Logging & protocols

The Logging page: runtime logging switches for the Web Console and the NetLock RMM server, log packages to download, the list of Console log files and the diagnostics view — plus a note on the settings_protocols_enabled permission flag.

Logging & protocols

Self-hosted only: On cloud deployments the Logging page shows a standard "cloud team manages these" notice instead of the logging switches, the downloads and the file list, and the page is not listed in the navigation. Your hosted operations team owns log retention, rotation and review. The rest of this chapter describes the self-hosted experience.

The Logging page gives a self-hosted operator three things: a runtime switch to turn logging on or off for the Web Console and for the NetLock RMM server without a restart, a download of the log files of both as a ZIP package, and a diagnostics view of the Console process. Use it to find out why something went wrong a few minutes ago, and to hand log files to support without opening a shell on the host.

Where to find the page and who can open it:

  • The page is at /logging, not under /settings. You open it from Navigation → Logging in the main navigation, not from inside Settings.
  • The page needs the permission settings_protocols_enabled. In the role editor the switch is labelled System logs. See the Permission reference (X.2).

Logging page with the Web Console Logging and Server Logging cards, the log file list below

A.9.1 The toolbar

Above the cards sit two buttons.

  • Download logs: packs the log files of the Web Console into a ZIP archive and downloads it (see A.9.4).
  • Refresh: reads the list of Console log files again and asks the servers for their current logging state.

A.9.2 Web Console logging

The Web Console Logging card carries an Enabled / Disabled switch and a status chip that reads Active or Inactive. The switch takes effect immediately for the Console process, without a restart. The value is also written to Logging:Custom:Enabled in the Console's appsettings.json, so it survives a restart. If the file cannot be written (for example a read-only mount), the switch still applies until the next restart and the page shows a warning that the setting could not be saved.

Turning logging off stops all Console logging from that moment on, including warnings and errors; files written so far stay as they are.

A.9.3 Server logging

The Server Logging card switches the logging of the NetLock RMM server the same way. It lists every server the Console connects to: the address configured as remote server and the address configured as file server. When both addresses lead to the same server, which is the case for a standard installation and for the Docker setup, the card shows a single row labelled Remote and file server; when they lead to two separate server instances, each gets its own row.

Each row shows:

  • the label (Remote server, File server or Remote and file server) and the address;
  • the roles the server runs with (for example comm, update, trust, remote, notification, file, llm, relay);
  • an Enabled / Disabled switch with the Active / Inactive chip, showing the state the server itself reports;
  • a Download server logs button (see A.9.4).

The switch takes effect on the server immediately and is stored as Logging:Custom:Enabled in the server's own appsettings.json, so it is kept across a server restart. If the server cannot write its configuration file, the switch applies until the server restarts and the page shows a warning. Every switch is recorded in the audit log with the server address.

When a server cannot be asked, the row shows the reason instead of the switch:

  • could not be reached: the server is down, the address is wrong, or a firewall blocks the connection. The card waits at most a few seconds per server, the rest of the page stays usable.
  • rejected the request: the server did not accept the Console's credentials.
  • does not offer this function yet: the server runs an older version than the Console. Update the server to the version of the Console.
  • answered with an error: the server was reached but could not answer the request (the HTTP status is shown). Check the server's console output (docker logs on Docker) and try again with Refresh.

Split installations. If you run the server roles on several separate instances, the card only reaches the instances behind the remote server and the file server address. Switch any further instance (for example a dedicated communication instance) with Logging:Custom:Enabled in that instance's appsettings.json and restart it, as described in Changing a value in appsettings.json.

Changing a value in appsettings.json

The appsettings.json files of the server and of the Web Console are stored encrypted. To change a value by hand, stop the service, replace the entire content of the file with your plain JSON configuration including the changed value, and start the service again; the file is encrypted again on start. On Docker, stop and start with sudo docker compose down and sudo docker compose up -d in /home/netlock.

Turning server logging off stops logging at all levels, including warnings and errors. The server still prints one line about the switch to its console output, so docker logs shows when logging was turned off and on.

A.9.4 Log files and log packages

The Console log file list

The Log files table lists the log files of the Web Console with File, Size and Last modified, plus the total size. The Console writes five files:

  • combined.log: every severity mixed together.
  • debug.log: debug entries.
  • info.log: informational entries.
  • warning.log: warnings.
  • error.log: errors.

If the list is empty while logging is switched off, the page says so: nothing new is written until logging is switched on again.

Downloading log packages

Download logs in the toolbar downloads the Console's log files; Download server logs on a server row downloads the log files of that server. Both produce a ZIP archive with the same layout:

  • one entry per log file that exists (combined.log, debug.log, info.log, warning.log, error.log);
  • a manifest.txt with the creation time, the version, the machine name, whether logging is enabled, the log directory and the size of each file. The server package also names the server's roles.

The log files are never rotated by NetLock RMM, so combined.log in particular can grow large. A file above 25 MB is cut to its newest 25 MB, starting at a full line, and begins with a line that says so; the manifest marks it as truncated. A server prepares one package at a time. If a second request arrives while one is being built, the page asks you to try again in a moment.

Both downloads are recorded in the audit log.

A log package contains diagnostic data of the server or the Console, such as device identifiers and connection details. Treat it as confidential and share it only with a support contact you trust; the manifest.txt in the package says the same.

Where the files are on disk

If you prefer to read the files on the host:

ComponentWindowsLinuxDocker (host directory)
Web Console%ProgramData%\0x101 Cyber Security\NetLock RMM\Web Console\Logs/var/0x101 Cyber Security/NetLock RMM/Web Console/Logs/home/netlock/web_console/logs/Logs
Server%ProgramData%\0x101 Cyber Security\NetLock RMM\Server\Logs/var/0x101 Cyber Security/NetLock RMM/Server/Logs/home/netlock/server/logs/Logs

The Docker paths follow the volume mounts of the Docker installation guide; adjust them if you mounted other host directories.

A.9.5 Diagnostics

The Diagnostics section shows memory and runtime figures of the Web Console process: process memory, garbage collector, thread pool, timers, Blazor circuits by page and by account, active sign-in sessions and the heavy pages and dialogs that are still held in memory. The values are read when the page opens and when you press its Refresh; there is no automatic update. Full GC runs a full garbage collection after a confirmation and shows the heap before and after. All sessions of the Console pause for a few seconds while it runs, and the run is recorded in the audit log.

The diagnostics section is shown on cloud deployments as well.

A.9.6 Routine operations

  • Trace a failing agent operation. Switch server logging on in the Server Logging card, reproduce the failure, then use Download server logs and search combined.log (or error.log) for the device name or hostname. Switch logging back off when done to keep disk use down.
  • Triage a user-reported Console error. Use Download logs, open error.log and search for whatever identifier the user gave you (username, page, time). If nothing matches, search combined.log, because some errors appear as a warning first.
  • Collect logs for a support ticket. Download both packages, the Console's and the server's, and attach them. The manifests carry the versions and the time the packages were made; add the time window of the problem to the ticket.

A.9.7 What this page does not do

  • No live viewer. The page lists and downloads log files; it does not display their content. Open the files from the downloaded package in a text editor.
  • No log rotation or retention. NetLock RMM does not rotate or delete its log files. Switch logging off when you do not need it, and remove or archive old log files on the host if disk space matters.
  • No log export to external SIEM. For SIEM forwarding, wire a collector to the log directories directly on each host.
  • No verbosity setting. The level of detail of the server log is set with Logging:Custom:VerbosityLevel in the server's appsettings.json (see Changing a value in appsettings.json) and takes effect after a restart of the server.
  • No remote-device logs. This page covers the Web Console and the NetLock RMM server only. Agent-side logs are collected on the device (see Debug an agent).

Permissions

  • settings_enabled: access to the Settings permission group (the page is under Settings in the permission tree even though its URL is /logging).
  • settings_protocols_enabled: access to the Logging page itself: both logging switches, both downloads and the diagnostics. In the role editor the switch is labelled System logs.