mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 08:50:15 +01:00
51050cc4d3
* 📑 update mkdocs * rename docker override file and add to gitignore * update .env.example - GOOGLE_MODELS * update index.md * doc refactor: split installation and configuration in two sub-folders * doc update: installation guides * doc update: configuration guides * doc: new docker override guide * doc: new beginner's guide for contributions - Thanks @Berry-13 * doc: update documentation_guidelines.md * doc: update testing.md * doc: update deployment guides * doc: update /dev readme * doc: update general_info * doc: add 0 value to doc weight * doc: add index.md to every doc folders * doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md * doc: update toc so they display properly on the right had side in mkdocs * doc: update pandoranext.md * doc: index logging_system.md * doc: update readme.md * doc: update litellm.md * doc: update ./dev/readme.md * doc:🔖 new presets.md * doc: minor corrections * doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs * doc update: add screenshots to presets.md * doc update: add screenshots to - OpenID with AWS Cognito * doc update: BingAI cookie instruction * doc update: discord auth * doc update: facebook auth * doc: corrections to user_auth_system.md * doc update: github auth * doc update: google auth * doc update: auth clean up * doc organization: installation * doc organization: configuration * doc organization: features+plugins & update:plugins screenshots * doc organization: deploymend + general_info & update: tech_stack.md * doc organization: contributions * doc: minor fixes * doc: minor fixes
42 lines
No EOL
1.7 KiB
Markdown
42 lines
No EOL
1.7 KiB
Markdown
---
|
|
title: 🪵 Logging System
|
|
weight: -5
|
|
---
|
|
|
|
### General
|
|
|
|
LibreChat has central logging built into its backend (api).
|
|
|
|
Log files are saved in `/api/logs`. Error logs are saved by default. Debug logs are enabled by default but can be turned off if not desired.
|
|
|
|
This allows you to monitor your server through external tools that inspect log files, such as [the ELK stack](https://aws.amazon.com/what-is/elk-stack/).
|
|
|
|
Debug logs are essential for developer work and fixing issues. If you encounter any problems running LibreChat, reproduce as close as possible, and [report the issue](https://github.com/danny-avila/LibreChat/issues) with your logs found in `./api/logs/debug-%DATE%.log`.
|
|
|
|
Errors logs are also saved in the same location: `./api/logs/error-%DATE%.log`. If you have meilisearch configured, there is a separate log file for this as well.
|
|
|
|
> Note: Logs are rotated on a 14-day basis, so you will generate 1 error log file, 1 debug log file, and 1 meiliSync log file per 14 days.
|
|
> Errors will also be present in debug log files as well, but provide stack traces and more detail in the error log files.
|
|
|
|
### Setup
|
|
|
|
Toggle debug logs with the following environment variable. By default, even if you never set this variable, debug logs will be generated, but you have the option to disable them by setting it to `FALSE`.
|
|
|
|
Note: it's recommended to disable debug logs in a production environment.
|
|
|
|
```bash
|
|
DEBUG_LOGGING=TRUE
|
|
```
|
|
|
|
```bash
|
|
# in a production environment
|
|
DEBUG_LOGGING=FALSE
|
|
```
|
|
|
|
For verbose server output in the console/terminal, you can also set the following:
|
|
|
|
```bash
|
|
DEBUG_CONSOLE=TRUE
|
|
```
|
|
|
|
This is not recommend, however, as the outputs can be quite verbose. It's disabled by default and should be enabled sparingly. |