For the complete documentation index, see llms.txt. This page is also available as Markdown.

Display Error/Audit logs

Xibo Displays can collect logs during routine operations so Display alerts can be monitored, error conditions can be identified and troubleshooting can occur

An administrator can enable additional Audit logging as necessary, usually this is during a troubleshooting session.

The default configuration for a Display is to keep logging to a minimum as this prevents unnecessary processor and memory usage. When running with the default Error logging status an administrator can expect to see Display Alerts and Error logs only.

How to collect Display logs

There are to logging channels available:

  • XMDS Logging happens in the CMS and logs messages from XMDS each time a Display connects which gives information about what the Display is sending and receiving from the CMS (to determine why a file has not been downloading or the Display is not updating properly for example)

  • Display Logging happens locally on the Display and is recorded in a local database for sending to the CMS at the next regular interval gives information as to what a Display is doing internally (not playing content at a scheduled time or a specific video not playing for example)

Both types of logging have either Error or Audit log levels; Error being the default and Audit being an elevated log level which collects more information, especially helpful when opening a support ticket.

XMDS Logging

Configure in the CMS:

  1. Click on Displays from the main CMS menu

  2. Use the row menu for the Display you wish to collect logs for and click Edit

  3. From the Advanced tab, enter a date/time in the Auditing until field

Display Logging

Configure from the Display Settings Profile (logging will be recorded for all Displays which share the same profile) or from the Override in Display Settings (for a singular Display)

Display Settings Profile:

  1. Click on Display Settings from the main CMS menu

  2. Use the row menu for the Display profile type and click Edit

  3. From the Troubleshooting tab, set a date/time in the Elevate Logging until

  4. Click to Save

Override Display Settings:

  1. Click on Displays from the main CMS menu

  2. Use the row menu for the Display and click Edit

  3. From the Settings tab, scroll to find Elevate Logging until

  4. Click Override and provide date/time

  5. Click Apply

  6. Click Save

Export Display log file

  1. Click the Advanced section of the main CMS menu

  2. Click Log and use the Filters button to set a from date and time

  3. Set filters to capture the required information

  4. Click Apply Filter

  5. Click the CSV button to export the log file

Last updated

Was this helpful?