Skip to content

Diagnostics

Andrea Del Signore edited this page Nov 13, 2026 · 3 revisions

Diagnostics report

MOD Duo: not available MOD Duo X: not available MOD Dwarf: available

When something doesn't work and you ask for help in a forum post or in an issue, the first questions are always the same: which image are you running, which services are active, which USB devices are connected...

The Diagnostics page of the settings collects all this information in a single text report, ready to be pasted in your post. The report is anonymized by default, so you can share it publicly.

Generate a report

Open the web interface, click the settings icon in the bottom bar (Go to settings screen), or open http://<dwarf address>/settings, then select the Diagnostics tab. The tab is shown only on images that include the diagnostics tool.

Web interface: diagnostics

  1. choose the sections to include: all of them are selected by default. Move the mouse over a section to see what it contains
  2. leave Anonymize checked, unless you send the report privately to someone who needs the real values
  3. click Generate. It takes a few seconds: the report is shown in the box below when it is ready
  4. click the copy icon to copy the report to the clipboard, or the download icon to save it as dwarf-diagnostics.txt
  5. paste the report in your post

If the browser doesn't allow copying, the report text is selected: press Ctrl+C (Cmd+C on a Mac) to copy it.

The report is already formatted in Markdown (a title for each section, followed by a code block), so it is easy to read when you paste it on GitHub or in a forum.

The report is generated on the Dwarf and shown in your browser only: nothing is sent anywhere until you paste it.

Sections

Section Content
System device and hardware model (platform, architecture, bin-compat, model type), image version and build date, component versions, HMI firmware, kernel, uptime, CPU temperature and frequency, memory and storage
Services state of the MOD services (jack2, mod-ui, mod-system-control, controlchaind, dnsmasq, avahi-daemon), failed units and pending jobs
Audio JACK buffer size and sample rate (configured and running), sync mode, DSP load, the jackd command line and its internal clients, what the sound card really opened, the realtime threads, xruns logged, the kernel audio messages and the last lines of the jack2 (with mod-host) and mod-ui logs
USB connected USB devices, with the driver used by each interface
WiFi Wi-Fi adapter, driver, access point state, kernel and service logs (see Wi-Fi)

Other components of the image can add their own sections: they show up in the list automatically.

Every report starts with a header with the image version, the system and controller revisions, the date and the uptime of the device:

# MOD Dwarf diagnostics

image:            v1.13.5.3315-stls17
system:           4dae598cd22da7ef9e49169837a4dada7d954b45
controller:       e99ddadb5b85e44bd3837b22b0b5df4eb93d71c1
diagnostics-logs: 0.1.0
date:             1970-01-01 00:39:55 (device clock)
uptime:           0d 00:39
anonymized:       yes

The date comes from the device clock: when the Dwarf has no internet access it is not correct, use the uptime instead.

What anonymization changes

Passwords and configuration files are never included in the report, even without anonymization.

When Anonymize is checked, the report also hides the information that can identify you or your device:

Information In the report
network names (Wi-Fi networks and access point) <ssid-1>, <ssid-2>, ...
MAC addresses only the manufacturer part is kept, for example d4:d6:df:xx:xx:xx
serial number of the device <serial>

The same value always gets the same placeholder, so the report is still easy to follow: for example, you can still see that the network in the logs is the one in the list of configured networks.

From the command line

The same report can be generated from a shell on the Dwarf (see Developer mode):

diagnostics-logs
diagnostics-logs --sections system,usb

--list lists the available sections, --raw disables the anonymization.

For developers

The diagnostics tool, the format of the sections and how to write a new one (a provider) are documented in the alabs-mod-diagnostics-logs repository. A provider is just an executable script installed in a directory: any component of the image can add its own section without changing the tool or the web interface.

Clone this wiki locally