Workflow error reporting and observability
Monitor Retool Workflows by connecting with Datadog or Sentry.
Retool supports out-of-the-box error monitoring and reporting on workflows and apps with Datadog or Sentry. Once configured, Retool reports any production errors—including a callstack and descriptive tags—to either provider. For custom app error reporting and integrations with other observability providers, you can create a workflow using Retool Events
Retool does not currently support sending workflow errors to other observability providers with Retool Events.
Errors encountered while editing an app or workflow are not reported.
1. Configure observability provider
- Datadog
- Sentry
To configure Datadog:
- Create a Datadog pipeline to consume logs. Retool streams error logs from service:retool-workflow-observability.
- Create a Datadog API key to use in the next step. Note your organization's Datadog Site.
To configure Sentry:
- Create a Sentry project for Retool errors.
- Navigate to the Client Keys (DSN) section of your Sentry project's settings. Copy the DSN key to use in the next step.
2. Connect providers to Retool
Next, configure your Retool organization to connect to your observability provider. You can configure the connection by either:
- Navigating to Settings > Observability.
- Using the Retool API to programmatically configure observability provider connections.
- Datadog
- Sentry
Configure the API key setting with the Datadog API key you created in the previous step. Make sure you specify the correct Datadog Site.
Configure the DSN key setting with the Sentry DSN key you created in the previous step.
Error types
Datadog categorizes errors into info, warn, or error logs. Sentry reports only error logs.
Error tags
Tags can be used to filter, categorize, or route errors to different owners using the following format: tag:value.
- Datadog tags
- Sentry tags
| Datadog Tag | Details | Example |
|---|---|---|
blockName | The name of block run. | errorCodeBlock |
blockType | The type of block run. | code |
duration | The duration of the run in seconds. | 6.821332 |
endTimestamp | The end timestamp in UTC milliseconds. | 1746058640525 |
environmentId | The environment ID. | production |
error | The error or event. | Error: Example error (line1) |
eventType | The workflow action taken (WORKFLOW_RUN_START, BLOCK_RUN_END, etc). | BLOCK_RUN_END |
multiStepFunctionId | The ID of a multi-step function used in a block or workflow. | 35bf8cf3-5000-4f93-81d1-af23po5k24d3 |
multiStepFunctionName | The name of a multi-step function used in a block or workflow. | function2 |
multiStepFunctionRunId | The ID of multi-step function run of a block or workflow. | 30117fb3-9720-4c0a-927c-a54994c72cd0 |
organizationId | The organization ID. | 1 |
release | The Retool version. | 3.198.0 |
runStatus | The status for block and workflow runs (SUCCESS, FAILURE, NOT_ENOUGH_TIME, etc). | FAILURE |
startTimestamp | The start timestamp in UTC milliseconds. | 1746058958620 |
status | The status for the run (info, error, or warn). | error |
triggerType | The method in which the workflow was triggered (manual, scheduled, webhook, etc). | manual |
workflowId | The workflow ID. | 4634f898-97b1-4be5-bc73-c417d90b00be |
workflowName | The worflow name. | Workflow Name |
workflowRunId | The workflow run ID. | 6ccaaa77-ca91-8fd9-5ca38-ec41d524m32 |
| Sentry Tag | Details | Example |
|---|---|---|
blockName | The name of the block. | errorCodeBlock |
blockType | The type of block. | code |
environment | The environment ID. | production |
eventType | The workflow action taken (WORKFLOW_RUN_START, BLOCK_RUN_END, etc). | BLOCK_RUN_END |
level | The type of log. | error |
multiStepFunctionId | The ID of a multi-step function used in a block or workflow. | 35bf8cf3-5000-4f93-81d1-af23po5k24d3 |
release | The Retool version. | 3.198.0 |
runtime | The runtime version. | node v20.18.1 |
runtime.name | The runtime name. | node |
server_name | The server name. | MacBook-H1TTF4FRWR |
triggerType | The method in which the workflow was triggered (manual, scheduled, webhook, etc). | manual |
workflowId | The workflow ID. | 4634f898-97b1-4be5-bc73-c417d90b00be |
workflowName | The worflow name. | Workflow Name |
workflowRunId | The workflow run ID. | 6ccaaa77-ca91-8fd9-5ca38-ec41d524m32 |
Filtering and routing
You can configure observability providers to filter and route errors reported for Retool apps.
- Datadog
- Sentry
Datadog errors are sent as logs. You can filter for all Retool app errors by setting service:retool-workflow-observability or any additional tags. Refer to Datadog's error tracking documentation to create rules for Retool app errors using service:retool-error-monitor.
Sentry can route errors to designated app owners. Refer to Sentry's ownership rules documentation for instructions.