Skip to content

docs(env): add DEEP_HEALTH_CHECK_ENABLED to .env.example #14685

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

Closed
gonisulaimann wants to merge 1 commit into from
Closed

docs(env): add DEEP_HEALTH_CHECK_ENABLED to .env.example #14685

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
5 changes: 5 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,11 @@ PORT=20128
# Used by: scripts/dev/healthcheck.mjs
# OMNIROUTE_HEALTHCHECK_PATH=/api/monitoring/health

# Opt-in deep health check (issue #14236): an authenticated caller may
# append ?deep=1 to /api/monitoring/health to sample the completions surface once per TTL.
# Off by default; anonymous callers never trigger a probe.
# DEEP_HEALTH_CHECK_ENABLED=1

# Opt-in iframe embedding of the OmniRoute HTML pages (issue #10273). Off by default:
# every route ships `frame-ancestors 'none'` + `X-Frame-Options: DENY`, which is why the
# VS Code Simple Browser (used by the OmniCopilot extension's "Open Dashboard → editor"
Expand Down
1 change: 1 addition & 0 deletions docs/reference/ENVIRONMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ OmniRoute uses **SQLite** (via `better-sqlite3`) for all persistence. These vari
| `PROXY_LOG_INCLUDE_IPS` | `false` | `src/lib/proxyLogger.ts` | Set to `"true"` or `"1"` to include client/egress IPs and the account prefix in the verbose `[ProxyEgress]` process-log line. Kept OFF by default so the process log does not leak IPs or the account prefix. |
| `OMNIROUTE_DEBUG` | _(unset)_ | `bin/cli/commands/quota.mjs` | Set to `1` to print per-request timing diagnostics (`[omniroute] GET <path> completed in Nms`) from the CLI quota commands to stderr. |
| `OMNIROUTE_HEALTHCHECK_PATH` | _(auto)_ | `scripts/dev/healthcheck.mjs` | Explicit path probed by the container health check. Unset, the probe derives it from `OMNIROUTE_BASE_PATH`; setting it opts back into the deep monitoring endpoint. |
| `DEEP_HEALTH_CHECK_ENABLED` | _(unset)_ | `src/app/api/monitoring/health/route.ts` | Set to `1` to allow an authenticated caller to append `?deep=1` to `/api/monitoring/health`, sampling the completions surface once per TTL (#14236). Off by default; anonymous callers never trigger a probe. |
| `OMNIROUTE_DEBUG_COMPLETION` | _(unset)_ | `bin/cli/commands/completion.mjs` | Set to any non-empty value to emit `[omniroute completion]` diagnostics from the CLI shell-completion cache paths (read/refresh/write). Off by default — those caches fail silently so a missing/corrupt cache never breaks tab-completion. |
| `BATCH_RETRY_DURATION_MS` | `86400000` (24h) | `open-sse/services/batchProcessor.ts` | Maximum retry window for individual batch items (ms). Items exceeding this duration are marked failed. |
| `BATCH_BACKOFF_BASE_MS` | `5000` | `open-sse/services/batchProcessor.ts` | Base delay (ms) for exponential backoff on batch item retries. |
Expand Down
Loading