Logging environment variables

Reference documentation for logging-related environment variables.

Retool 4.0.15 Stable

Enterprise

Logging-related environment variables available for use with self-hosted Retool deployments.

Only configure environment variables when needed. You can configure many environment variables from your organization's Settings rather than directly editing your deployment's configuration file.

Environment variables take effect only once the change is applied to your deployment, and where you set them depends on how Retool was deployed.

• Terraform blueprints. Set the variable in retool_helm_extra_values in main.tf, then run terraform apply. Editing Helm values directly on a blueprint-managed instance is overwritten by the next apply.
• Helm. Set the variable in your values.yaml, then run helm upgrade. That command restarts the affected pods as part of applying the new values, so restarting pods without re-running it doesn't pick up the change.
• Docker Compose. Set the variable in docker.env, then run sudo docker compose up -d.

DISABLE_AUDIT_TRAILS_LOGGING

Whether to disable logging of audit trails.

Type	boolean
Configurability	Update the deployment's configuration file.
Required	Optional
Default	false

Examples

DISABLE_AUDIT_TRAILS_LOGGING=true

---

HIDE_ALL_HEADERS_IN_AUDIT_LOG_EVENTS

Whether to prevent all query headers and cookies from being added to audit log entries.

Type	boolean
Configurability	Update the deployment's configuration file.
Required	Optional
Default	false

Examples

HIDE_ALL_HEADERS_IN_AUDIT_LOG_EVENTS=true

---

LOG_AUDIT_EVENTS

Audit events are always written to the Retool platform database. This environment variable determines if they should also be written to stdout where Retool container logs are sent so that they can be forwarded to a custom observability provider using a log collector (e.g. the telemetry collector Retool provides as an option in the Helm chart).

Type	boolean
Configurability	Update the deployment's configuration file.
Required	Optional
Default	false

Examples

LOG_AUDIT_EVENTS=true

---

LOG_LEVEL

The log level for Retool logs.

Type	string
Configurability	Update the deployment's configuration file.
Required	Optional
Allowed Values	Value Description error Error level logging. (least verbose) warn Warning level logging. info Info level logging. debug Debug level logging. (most verbose)
Default	info

---

RTEL_SEND_TO_RETOOL_INPUT_ALLOWLIST

A comma-separated list of telemetry data types sent to Retool.

Type	string
Configurability	Update the deployment's configuration file.
Required	Optional
Allowed Values	Value Description container_logs Container logs. metrics Metrics. otlp_traces OpenTelemetry traces.
Default	container_logs,metrics,otlp_traces

Examples

RTEL_SEND_TO_RETOOL_INPUT_ALLOWLIST=container_logs,metrics,otlp_traces

---

SCIM_LOG_FULL_REQUESTS

Whether to log SCIM requests to the Retool API container logs.

Type	boolean
Configurability	Update the deployment's configuration file.
Required	Optional
Default	null

Examples

SCIM_LOG_FULL_REQUESTS=true

---