Skip to content

docs(medic#10357): document LOG_LEVEL environment variable for configurable logging #2030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AmirSaudagar55 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs(medic#10357): document LOG_LEVEL environment variable for configurable logging #2030

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
709c3d1
docs(medic#10357): document LOG_LEVEL environment variable for config…
AmirSaudagar55 Oct 15, 2025
61147dc
docs(medic#10357): update log level section to reflect new LOG_LEVEL …
AmirSaudagar55 Oct 29, 2025
a25111b
docs(medic#10357): update LOG_LEVEL section based on review feedback
AmirSaudagar55 Nov 9, 2025
45faafb
docs(medic#10357): apply reviewer feedback on LOG_LEVEL section
AmirSaudagar55 Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion content/en/hosting/cht/docker/logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,37 @@ CHT has the following services running via Docker and each can have its logs que

## Setting log level

By default, the CHT server logs are set to the `info` level. To change the log level to `debug`, you can set the `NODE_ENV` environment variable to `development`. A log level of `debug` can affect system performance and cause log files sizes to grow rapidly. It is recommended to temporarily set the log level to `debug` only when needed for troubleshooting.
To control log verbosity, set the `LOG_LEVEL` environment variable before starting the containers. The default value is `info`.

{{< callout type="info" >}}
From version 5.1.0 onward, use `LOG_LEVEL` to control log verbosity. The `NODE_ENV` value no longer affects logging detail.
{{< /callout >}}

### Configuration

**Example usage:**
```bash
export LOG_LEVEL=debug
docker compose up -d
```
**Supported values:**

- `error` — Only error messages (production use)
- `warn` — Warnings and errors
- `info` — General information (default, recommended for production)
- `debug` — Detailed diagnostic information (troubleshooting only)

{{< callout type="warning" >}}
Using `debug` level generates significantly more logs and may impact performance. Use it only for troubleshooting and switch back to `info` or `warn` for normal operations.
{{< /callout >}}

### Applying changes to running containers

To change the log level for already running containers, update the environment variable and restart:
```bash
export LOG_LEVEL=warn
docker compose restart
```

## Viewing logs

Expand Down