Crate relay

source ·
Expand description


Relay is a standalone service for scrubbing personal information and improving event submission response time. It acts as a middle layer between your application and For information on setting up Relay in front of Sentry, see:

Relay documentation

§Event Ingestion

Relay is also the primary event ingestion system at Sentry. When compiled with the processing feature and configured for ingestion, Relay ships functionality for:

  • Acknowledging and handling web requests on store endpoints
  • Applying rate limits and inbound data filters
  • Data scrubbing of event payloads and attachments
  • Validation and normalization of malformed or outdated data
  • Forwarding of all information into the event processing pipeline

§Feature Flags

  • processing: Includes event ingestion and processing functionality. This should only be specified when compiling Relay as Sentry service. Standalone Relays do not need this feature.
  • crash-handler: Allows native crash reporting for segfaults and out-of-memory situations when internal error reporting to Sentry is enabled.

§Workspace Crates

Relay is split into the following workspace crates:


Complementary to the Relay binary, the workspace contains a set of tools to interface with some of Relay’s functionality or to export information:


  • cli 🔒
  • cliapp 🔒
    This module implements the definition of the command line app.
  • setup 🔒
  • utils 🔒