Skip to main content

Exception Reporting

Configure exception reporting to gain visibility into errors from your Convex function executions. Convex supports integration with Sentry.

Currently, exception reporting is only available to Pro users.

Configuring Sentry​

To configure sentry, navigate to the Deployment Settings in the Dashboard, and the "Integrations" tab in the sidebar.

Integrations Page

Click on the Sentry card and follow the setup directions. You will need your Sentry DSN.

Configure sentry

Supported Tags​

Convex automatically tags exception events on their way to sentry with the following tags

  • func: The name of the running function in string format
  • func_type: One of ["query", "mutation", "action", "http_action"]
  • func_runtime: One of the function runtimes - ["default", "node"]
  • request_id: The request id of the function that errored.
  • server_name: The name of the deployment. e.g. happy-animal-123
  • environment: One of ["prod", "dev", "preview"]
  • user: If the function is authenticated, then the tokenIdentifier is used as the user id on Sentry. The tokenIdentifier is a stable and globally unique string representing the authenticated user.

Sentry Notes​

  • Sentry Exceptions may take a minute or two to propagate to Sentry.
  • Convex's built-in sentry support does not yet support the advanced customization provided by the sentry SDK.
  • Please reach out with any questions, comments, or suggestions on Discord.