# Logbook

The Logbook is a feature within CIPP that records and displays all actions performed by the system on a given day. This page is essential for monitoring and troubleshooting as it helps users track the execution of various tasks, identify issues, and confirm successful operations.

## **Using the Logbook for troubleshooting** 

Users can verify if specific actions have occurred by checking the log entries. For example, if a user wants to verify if a specific scheduled task, such as the "Hudu Extension Sync," was executed successfully. They select the appropriate date, use the filter to search for "Hudu Extension Sync," and review the log entries to confirm successful execution.

{% hint style="warning" %}
If an expected action is not logged, it might indicate a failure that occurred before the data was collected. If an alert is expected but not present in the logbook, it could indicate a failure in the data collection process. Such issues typically require developer intervention for identification and resolution. If you are a sponsor, please reach out to the helpdesk in these cases.
{% endhint %}

## Logbook Filters

Expanding the Logbook Filters section at the top of the page will present you with the following options for how you would like to retrieve data from the logbook:

* Start Date
* End Date
* Filter by Username
* Filter by Severity

## **Logbook Results Table**

| Column    | Description                                                                                                      |
| --------- | ---------------------------------------------------------------------------------------------------------------- |
| Date Time | The exact time the action was logged                                                                             |
| Tenant    | The primary domain of the tenant                                                                                 |
| Tenant ID | The tenant ID associated with the log entry                                                                      |
| User      | Indicates the user associated with the action                                                                    |
| Message   | Provides a brief description of the action performed                                                             |
| API       | Identifies the API endpoint involved in the action                                                               |
| Severity  | Indicates the severity level of the log entry. Options include: `debug`, `info`, `warn`, `error`, and `critical` |
| App Id    |                                                                                                                  |
| Log Data  | Opens a second table to display information relevant to the logbook entry                                        |

## Table Actions

<table><thead><tr><th>Action</th><th>Details</th><th data-type="checkbox">Bulk Action Available</th></tr></thead><tbody><tr><td>View Log Entry</td><td>Opens the selected log entry to <a data-mention href="logs/logentry">logentry</a></td><td>false</td></tr></tbody></table>

## Logbook Severity

| Severity | Description                                                                                                                                                                                                                                      |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Alert    | A notable event that warrants proactive notification. Entries with this severity come from any alerts setup via [alert-configuration](https://docs.cipp.app/user-documentation/tenant/administration/alert-configuration "mention").             |
| Error    | The operation failed. The requested action could not be completed, typically due to an API failure, missing permissions, or an invalid request.                                                                                                  |
| Info     | The operation completed successfully. Informational messages confirming an action was performed as expected.                                                                                                                                     |
| Warning  | The operation completed, but with a caveat. Something may need attention even though the action wasn't blocked. Example: resetting a password on a directory-synced user warns that password writeback must be enabled.                          |
| Critical | A platform-level failure occurred. Reserved for situations where CIPP's own infrastructure is impacted, such as failures retrieving tenant lists or GDAP relationships. These indicate a problem with CIPP itself, not a specific tenant action. |
| Debug    | Diagnostic information for troubleshooting. Only recorded when Debug Mode is enabled. Not included in notifications by default.                                                                                                                  |

***

## Feature Requests / Ideas

We value your feedback and ideas. Please raise any [feature requests](https://github.com/KelvinTegelaar/CIPP/issues/new?assignees=\&labels=enhancement%2Cno-priority\&projects=\&template=feature.yml\&title=%5BFeature+Request%5D%3A+) on GitHub.