Skip to content
This page was translated from the Traditional Chinese original and has not yet been reviewed by a person. If anything is unclear, the Chinese version is authoritative.

Viewing: HTML | Download the full feature guide as PDF

System logs ​

Navigation: Settings → System → System Logs

The system log records events from the management app: image refreshes, schedules, sleep, errors and so on. When something goes wrong, the log is the most important clue for finding the cause, and technical support often asks you for it.

The page ​

The title shows "Total N entries, approx. X MB" (the size is an estimate). Below the title, one line gives a summary of the last 24 hours: "Last 24 hours: Errors N · Warnings N". The numbers are links: clicking one filters the list to the errors (or warnings) of the last 24 hours.

Buttons at the top right:

ButtonDescription
Download full logsPacks the complete logs and the device status into one file, see Downloading the full logs
▼ next to Download full logs"Black box incidents" in this menu opens the incident window, see Black box incident packages
Refresh (↻)Reloads the list and the summary and shows a "reloaded" message

Log list ​

  • The newest entry is at the top, grouped by date: each day has a header (date, weekday and the number of entries that day). The header stays pinned at the top while you scroll, so you always know which day you are looking at.
  • A batch is loaded at a time, and scrolling to the bottom loads the earlier entries automatically; there is no button to press.
  • Each row: time (hour:minute:second), message and actions. Messages are not shortened; entries from the CMS component start with "CMS ·".
  • Identical messages in a row are merged into one row marked "×N". Click "×N" to see the time of each occurrence.
  • The row colour shows the level:
LevelColourMeaning
DEBUGBlueDebugging detail (usually absent on production devices)
INFOGreenOrdinary events, such as why the device did not sleep
WARNINGYellowSomething went wrong but was retried, recovered or worked around automatically
ERRORRedCannot recover by itself and needs attention, for example an image refresh failed
CRITICALPurpleA serious error, for example the white refresh before shutdown failed
  • Actions:
    • Eye icon View full message: shows the level, the full time and the complete text, which you can copy.
    • Copy icon Copy: copies in the format [time] [level] [Thread] message (merged rows include "×N") and shows a "copied to clipboard" message.

Filtering logs ​

The filters sit in one row and apply as soon as you change them:

FilterDescription
Level"All (incl. INFO)", "Warnings and above" or "Errors and above". The default is "Warnings and above". To see ordinary events (for example why the device did not sleep), choose "All (incl. INFO)"
Time range"1 hour", "Today", "24 hours", "7 days", "All" or "Custom"; the default is "All". "Custom" shows a date-time range picker. Times are the device's time
Source"App" or "CMS"; leave it empty for both
Keyword searchMatches the message text, case-insensitive. Press Enter or the magnifier to apply

Handy queries

  • Click "Errors N" in the summary line: see the errors of the last 24 hours
  • Level "All (incl. INFO)" with the keyword 取消休眠: see why the device did not go to sleep
  • Level "Warnings and above" with the time range of the problem: quickly spot what went wrong

Downloading the full logs ​

When you report a problem to technical support, press Download full logs at the top right of the page and send the downloaded file to support. You do not need to filter or tidy the logs yourself.

  1. Press Download full logs to open the dialog.
  2. Press Pack and download and wait about 30 seconds (the screen shows "Packing the full logs, this takes about 30 seconds…").
  3. When the browser has downloaded the file, send it to technical support.

The file holds the complete logs on the device (system records, App logs, incident packs) and the current device status, and contains no passwords. It is not affected by the filters on screen, so it is always complete. If packing fails, wait a moment and try again.

Clearing the logs ​

Navigation: Settings → System → Clear logs

"Clear logs" has moved from the System Logs page to the System Settings page, so it is not pressed by accident before you report a problem.

  1. In System Settings, press Clear logs.
  2. In the confirmation dialog, confirm the clean-up message (this cannot be undone) and press Confirm.
  3. The number of entries cleaned up is shown.

Clean-up rules:

  1. Entries older than 180 days are deleted.
  2. If the logs are still over about 500 MB, the oldest entries are deleted until they are under the limit.

Logs are not cleaned up automatically

These rules are applied only when you press "Clear logs"; nothing is deleted automatically. On a device in long-term use, clear the logs once in a while. When you are reporting a problem, download the full logs first, then clear.

Black box incident packages ​

The device always keeps the last 10 minutes of system records and status (this is the "black box"). When something goes wrong, it automatically saves an "incident package" with the 10 minutes before, the moment itself, and up to 10 minutes after. This happens when:

  • A program crashes or keeps restarting
  • The network adapter disappears
  • The system kernel reports an error
  • Temperature, memory or storage goes over a threshold
  • CMS images fail to refresh 3 times in a row
  • The CMS component disappears
  • A software update fails and is rolled back to the old version
  • A factory reset happens

To view and download:

  1. On the System Logs page, press ▼ next to "Download full logs" at the top right and choose Black box incidents to open the window.
  2. The list shows each package's "Time", "Triggers", "Size" and "Status". "Collecting" means the 10 minutes after the event are not over yet; it becomes "Done" afterwards.
  3. Press Download on a row and give the file to technical support. When there are no packages, the window shows "No incidents".

"Refresh" in the window reloads the list. A package over the size limit is marked "* The package exceeded its size limit; less important messages were dropped first." If the black box cannot be read, the window shows "Cannot reach the black box (the service is not running)."

ItemDescription
Software update, factory resetIncident packages are kept (the factory reset itself also leaves a package)
Count and size limitAt most 20 packages, 50 MiB in total. When over the limit, the oldest are deleted automatically

Log upload ​

Navigation: Settings → System → Log upload

When on, this device sends its system logs to the company log server so technical support can find problems quickly. Passwords and similar values are masked before sending. It is off by default, and while off nothing is sent.

Open the dialog from the "Log upload" row, turn on the "Log upload" switch, fill in the fields below and press "Save" (it shows "Saved"):

FieldDescription
Upload URLThe address of the log server
Environment nameA name that tells which environment this device belongs to

Press "Test connection" to check that the server can receive. Success shows "Test succeeded; the server accepted the line"; failure shows "Test failed: {reason}".

The dialog and the row show the current status:

ItemDescription
Status"Healthy": sending works. "Connecting": trying to connect. "Cannot connect": the server cannot be reached, with the reason ("Last error")
Last successWhen the last successful send happened, for example "just now" or "5 min ago"; "never" if it has not succeeded yet
Lines sent, Lines omitted, Lines droppedSent: lines the server received. Omitted: when one service writes too many lines in a short time, the extra lines are not sent, to avoid flooding. Dropped: the server was unreachable for too long and the buffer on the device filled up, so the oldest lines were discarded

When the server cannot be reached

When the server is temporarily unreachable, the device keeps retrying slowly and nothing else is affected. Turning "Log upload" off stops all sending.

Notes ​

  • Log times are recorded with the device's time. If the device's time is wrong, the log times are wrong too, so check Time Settings first.
  • Detailed records of software updates and factory resets are not here (the management app itself is stopped at that point); technical support looks at them separately.
  • Factory reset deletes all system logs.

Sending logs to technical support ​

  1. Note roughly when the problem happened.
  2. Press Download full logs and send the downloaded file to technical support.
  3. Include a description of the problem and a screenshot of Device info.

Related chapters: Device info and monitoring, Troubleshooting

Green Ideas Technology