> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/troubleshooting/display-error-audit-logs.md).

# 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.&#x20;

{% hint style="info" %}
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.
{% endhint %}

## 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)

{% hint style="info" %}
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.&#x20;
{% endhint %}

<details>

<summary>XMDS Logging</summary>

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

{% hint style="warning" %}
This should not be set for too long a period which goes beyond the troubleshooting window
{% endhint %}

</details>

<details>

<summary>Display Logging </summary>

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**

</details>

#### 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 &#x20;
3. Set filters to capture the required information
4. Click **Apply Filter**
5. Click the CSV button to export the log file


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xibosignage.com/troubleshooting/display-error-audit-logs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
