> For the complete documentation index, see [llms.txt](https://docs.docbits.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.docbits.com/end-user-and-partner-section/end-user-section/system-logs.md).

# System Logs

System Logs is an administrator-only page that shows what DocBits did recently, service by service: imports, OCR and extraction runs, workflow steps, exports, and background jobs each write short log entries here. When a document did not arrive, a workflow step failed, or an export returned an error, this page shows what the system actually did and when — the raw material for deciding whether it was a one-off or a recurring problem.

It is a technical tool for administrators. Non-admin users do not see it; [create a support ticket](https://docs.docbits.com/end-user-and-partner-section/end-user-section/technical-support-in-docbits/create-a-ticket.md) instead and let support read the logs.

## How to access

Open DocBits as an administrator and go to `/system-logs` — for example `https://sandbox.docbits.com/system-logs`. You can also find it by searching for **System Logs** in the [Global Quick Search](https://docs.docbits.com/end-user-and-partner-section/end-user-section/global-quick-search.md).

For a one-click snapshot of your own browser session instead of the system's history, use the [Debug Collector](https://docs.docbits.com/end-user-and-partner-section/end-user-section/technical-support-in-docbits/debug-collector.md).

## The six tabs

The page opens on **Log Entries**, with six tabs across the top. Use Log Entries to inspect the available log data.

| Tab                      | What it is for                                                                                                   |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------- |
| **System Overview**      | An overview of system health and processing metrics, plus a list of the interfaces the dashboards will build on. |
| **Performance Metrics**  | Planned charts for organization and supplier performance and processing bottlenecks.                             |
| **Error Analysis**       | Planned summaries that group recurring errors and show how often each pattern occurs.                            |
| **Real-time Monitoring** | Planned live views that follow log entries as they are written.                                                  |
| **Service Health**       | Planned status cards for the individual DocBits services.                                                        |
| **Log Entries**          | The searchable log table — the part you will actually use to investigate an issue.                               |

<figure><img src="https://578966019-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT2n2w4uDCJvv7CJ5zrdk%2Fuploads%2Fgit-blob-44213d11ec220df568cd75a25f26f14ae54c9518%2Fsystem-logs-system-overview-en-20261011.png?alt=media" alt="System Overview tab with a System Health Status gauge showing HEALTHY and Document Processing Metrics cards marked Coming Soon"><figcaption><p>System Overview contains a demonstration health gauge and processing-metrics placeholders. The HEALTHY label is not a live availability check.</p></figcaption></figure>

Many cards on the first five tabs are marked **Coming Soon**. These tabs contain planned dashboards and demonstration values. In particular, the System Overview health gauge displays a fixed value; do not use its HEALTHY label to decide whether a service is available. Use **Log Entries** for the actual log list.

## Investigating with Log Entries

The Log Entries tab initially requests the last seven days of logs for **doc2-api**. Select a **Service** to inspect another component. Each row shows the timestamp, the severity badge, the service that wrote the entry, and the message.

<figure><img src="https://578966019-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT2n2w4uDCJvv7CJ5zrdk%2Fuploads%2Fgit-blob-c16279590f8b49fdfbdbcc55bb6ea07010b940de%2Fsystem-logs-log-entries-en-20261011.png?alt=media" alt="Log Entries tab with filter fields for start and end date, log level, service and search text, five summary cards, and the log table"><figcaption><p>Historical synthetic illustration: filters on top, summary cards in the middle, the log table below.</p></figcaption></figure>

### Narrow the list with filters

1. Set the **Start date** and **End date**. Both fields open a calendar when you click the calendar icon; the list defaults to the last seven days.
2. Pick a **Log Level** if you only want one severity (for example ERROR).
3. Pick a **Service** to follow one component — for example, only the OCR service if page recognition seems slow.
4. Type a **Search text** to keep only entries containing that phrase, such as a document number or batch ID.
5. Click **Apply Filters** to reload the list. **Clear** resets everything back to the last seven days without a level, service, or search text.

### Read the summary cards

Between the filters and the table, five cards count the entries of the last seven days: **Total Logs**, **Errors**, **Warnings**, **Info**, and **Debug**. The counts use the selected service and search text; changing the Start date and End date changes the log list, while these cards retain their seven-day window.

Clicking a card is a shortcut for the matching filter: **Errors** keeps only the error entries, **Warnings** only the warnings, and so on. Clicking **Total Logs** removes the level filter again.

### Open a single entry

Click a row to expand it. The detail panel shows the full timestamp, the level, the service, and the complete message — useful when the table truncates a long message. Use the arrow buttons to step through the neighbouring entries without closing the panel, and the ✕ to close it again.

### Table View and Raw View

* **Table View** is the default: one row per log entry with columns for timestamp, log level, service, and message.
* **Raw View** shows the same entries as plain text lines, in the order the services wrote them:

<figure><img src="https://578966019-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT2n2w4uDCJvv7CJ5zrdk%2Fuploads%2Fgit-blob-e80e6cbf3abbba6f6cf77c9c2f335d4084df4862%2Fsystem-logs-raw-view-en-20261011.png?alt=media" alt="Raw View showing the log lines as plain text with an Export Logs button"><figcaption><p>Historical synthetic illustration of the Raw View layout and Export Logs control.</p></figcaption></figure>

Raw View adds an **Export Logs** button for requesting a text-file download with the selected filters and date range. Check the downloaded contents before attaching them when you [create a ticket](https://docs.docbits.com/end-user-and-partner-section/end-user-section/technical-support-in-docbits/create-a-ticket.md). The table view itself has no export; switch to Raw View first.

Below the table, **Logs Per Page** sets how many entries are shown at once, and the page numbers move through longer result lists.

## Typical checks before contacting support

1. Open the Log Entries tab and look at the summary cards: are there errors at all?
2. Click the **Errors** card to see only errors, then narrow further with a service or search text.
3. Open a matching entry and read the full message — it usually names the document, batch, or step that failed.
4. Switch to **Raw View** and click **Export Logs** to attach the log data when you [create a support ticket](https://docs.docbits.com/end-user-and-partner-section/end-user-section/technical-support-in-docbits/create-a-ticket.md).

## Related pages

* [Debug Collector](https://docs.docbits.com/end-user-and-partner-section/end-user-section/technical-support-in-docbits/debug-collector.md) — capture your browser session (network calls, console errors) in one step, while System Logs shows the system's own history.
* [Admin privileges](https://docs.docbits.com/administration-and-setup/settings/global-settings/groups-users-and-permissions/users/admin-privileges.md) — which users can open this page.
* [Create a ticket](https://docs.docbits.com/end-user-and-partner-section/end-user-section/technical-support-in-docbits/create-a-ticket.md) — where to send the exported logs.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.docbits.com/end-user-and-partner-section/end-user-section/system-logs.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 `automate deployments from our CI pipeline` 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.
