> 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/setup-docs/troubleshooting/log.md).

# Log

The CMS has a central repository for all log information, including the Players which send back information with each collection from the CMS.

Click on the **Advanced** section of the main CMS menu and select **Log.**

The Log is split into **Channels**, **Functions** and **Pages** for easy searching. Each unique request has a *`runNo`* to group messages together.

## Fields

| Field        | Description                                                                                |
| ------------ | ------------------------------------------------------------------------------------------ |
| **ID**       | A sequential ID of log messages                                                            |
| **Run**      | The *run* identifier used to group messages generated by a single request                  |
| **Date**     | The CMS date of the message                                                                |
| **Channel**  | The Channel that the message relates to                                                    |
| **Function** | The HTTP verb used in the request the generated the message, GET, POST, PUT, DELETE, HEAD. |
| **Level**    | The severity of log message                                                                |
| **Display**  | The display name, if the log message came from a Player                                    |
| **Page**     | The page requested - usually the route                                                     |
| **Message**  | The log message                                                                            |

## Channels

| Channel     | Description                                |
| ----------- | ------------------------------------------ |
| **WEB**     | The CMS Web Portal                         |
| **API**     | The CMS API                                |
| **XMDS**    | The CMS/Player API (Media Distribution)    |
| **AUTH**    | The oauth authorization server for the API |
| **CONSOLE** | XTR task running                           |

## Finding your message

Understanding the log can be complicated in a busy system and it can often be hard to find messages related to your interest. The log can be filtered for this purpose, it is usually best to start with the **Channel**, then the **Function** and finally (if necessary) the **Page**.

{% hint style="info" %}
&#x20;For example, if an API call to the statistics search function is not working as expected the log can be searched for API, GET and `/stats`.
{% endhint %}


---

# 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 following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xibosignage.com/setup-docs/troubleshooting/log.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

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.
