Deployment logs

Learn about capturing logs for your Retool deployment.

You can use Retool's backend container logs to monitor your deployment's errors and performance. To access logs for Retool product events, such as user creation, use the audit logs instead.

Access container logs

Retool sends container logs to standard output by default. The method to view deployment logs depends on your deployment provider. Refer to your provider's documentation to learn more about available logging options.

For deployments using Docker Compose, use docker-compose logs.

sudo docker-compose logs <container_name>

See the Docker logs documentation for a complete list of options you can pass to docker-compose logs or docker logs.

For deployments using Kubernetes, use kubectl logs:

kubectl logs -p <pod_name> -n <namespace>

Use logs to debug

The api and db-connector containers or pods log events related to queries and requests. For events related to Source Control, see the jobs-runner container or pod logs.

To follow the lifecycle of a request in Retool, look for the requestId field. You can then query using the request ID and any associated QUERY_REQUEST, QUERY_COMPLETE, RESPONSE_SEND, and QUERY_RESULT events, which contain the query's environment, source, and more details.

Set the DEBUG and LOG_LEVEL environment variables to enable more verbose logging.

Send logs to log aggregators

Because logs are piped to standard output by default, you can connect them to log aggregators. For example, send logs to Datadog by registering an agent. See the documentation for your log aggregator for more details.

On Docker-based deployments, you configure logging drivers by creating and configuring a daemon.json file, then restarting Docker. See Docker's documentation for more details.