Skip to content

docs: document LOG_LEVEL as a backend env variable (#258) #438

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
olaayoade27-coder wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document LOG_LEVEL as a backend env variable (#258) #438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ JWT_PREVIOUS_KEYS=
# TCP port for the Express backend (default: 4000)
PORT=4000

# Winston log level for the backend (default: info)
# Allowed values: error | warn | info | http | debug
LOG_LEVEL=info

# Maximum JSON request body size accepted by the API (default: 10kb)
BODY_LIMIT=10kb

Expand Down Expand Up @@ -107,7 +111,7 @@ BACKEND_URL=http://backend:4000
ANALYTICS_API_KEY=

# Python log level: DEBUG | INFO | WARNING | ERROR | CRITICAL (default: INFO)
LOG_LEVEL=INFO
# Reuses LOG_LEVEL defined in the backend section above; set to INFO for Python stdlib levels.

# ── Anomaly detection ─────────────────────────────────────────────────────────
# Mint count above which an issuer is flagged as anomalous (default: 50)
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@ Copy `.env.example` to `.env` and fill in the required values. The backend valid
| `ISSUER_SECRET_KEY` | yes | — | Signs mint/revoke transactions (starts with `S`) |
| `JWT_SECRET` | yes | — | Signs JWTs; rotate to invalidate all sessions |
| `PORT` | no | `4000` | Backend listen port |
| `LOG_LEVEL` | no | `info` | Winston log level: `error`, `warn`, `info`, `http`, `debug` |
| `RATE_LIMIT_SEP10` | no | `10` | Max SEP-10 requests per IP per minute |
| `RATE_LIMIT_VERIFY` | no | `60` | Max verify requests per IP per minute |
| `AUDIT_LOG_PATH` | no | `./audit.log` | Path to append-only NDJSON audit log |
Expand Down
3 changes: 2 additions & 1 deletion docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ When an anomaly is detected the service POSTs a JSON payload to `ALERT_WEBHOOK_U
| `ISSUER_SECRET_KEY` | yes | runtime | valid Stellar secret key format |
| `JWT_SECRET` | yes | Zod (backend) | non-empty string |
| `PORT` | no | Zod (backend) | positive integer, default 4000 |
| `LOG_LEVEL` | no | runtime | Winston log level for the backend: `error` \| `warn` \| `info` \| `http` \| `debug`, default `info` |
| `ALLOWED_ORIGINS` | no | Zod (backend) | comma-separated URLs, default `http://localhost:3000` |
| `SOROBAN_FEE` | no | Zod (backend) | positive integer (stroops), default 100 |
| `SOROBAN_TIP` | no | Zod (backend) | non-negative integer (stroops), default 0 |
Expand All @@ -287,7 +288,7 @@ When an anomaly is detected the service POSTs a JSON payload to `ALERT_WEBHOOK_U
| `AUDIT_LOG_PATH` | no | runtime | writable path, default `./audit.log` |
| `ANALYTICS_PORT` | no | runtime | positive integer, default 8001 |
| `BACKEND_URL` | no | runtime | valid URL, default set by Compose |
| `LOG_LEVEL` | no | runtime | Python logging level, default `INFO` |
| `LOG_LEVEL` | no | runtime | Python logging level, default `INFO` (reuses the same variable; Python uses `DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL`) |
| `ANOMALY_THRESHOLD` | no | runtime | positive integer, default 50 |
| `ANOMALY_SCHEDULE_MINUTES` | no | runtime | positive integer, default 15 |
| `ALERT_WEBHOOK_URL` | no | runtime | valid HTTPS URL; alerts disabled if unset |
Expand Down