How to set up Sentry Relay for processing mode?

Enable the processing feature in config.yml with Kafka and Redis settings, then run Relay using cargo with --features=processing. Ensure services are running, as detailed in the development documentation.

What's the difference between Relay proxy and processing mode?

Proxy mode forwards events directly to Sentry, while processing mode normalizes, filters, and pushes events to Kafka for async ingestion, offering more control but requiring additional infrastructure like Kafka topics.

Sentry Relay vs direct SDK connection: which is better?

Relay is better for scaling and data control, adding a layer for PII scrubbing and load reduction, but introduces latency and complexity. Direct connection is simpler for low-volume setups without advanced needs.

Can I use Relay without Kafka?

Yes, in proxy mode, Relay forwards events without Kafka, acting as a simple intermediary. Processing mode requires Kafka for event queueing and ingestion, as stated in the features section.

How to monitor Relay performance and errors?

Enable detailed logging with level trace and backtraces in config.yml, and use internal error reporting to Sentry. The README mentions logging configuration for debugging and development.

Is Relay compatible with all Sentry SDKs?

Yes, Relay is designed to work with all Sentry SDKs, acting as a drop-in replacement for the Sentry server endpoint, handling event forwarding and processing transparently.

Open-Awesome

Sentry Relay

NOASSERTIONRust26.7.1

A proxy service that offloads event processing, normalization, and ingestion from Sentry SDKs and server.

Visit Website GitHub

392 stars120 forks0 contributors

What is Sentry Relay?

Sentry Relay is a proxy service for the Sentry error monitoring platform. It sits between your application's Sentry SDKs and the Sentry server, handling event forwarding, normalization, filtering, and ingestion. It solves scalability and data control challenges by offloading processing from the central server and SDKs.

Target Audience

Developers and DevOps engineers who deploy and manage Sentry, especially those needing to scale error ingestion, implement data processing policies, or self-host Sentry infrastructure.

Value Proposition

Developers choose Relay to improve the performance and reliability of their Sentry deployment by reducing server load, enabling advanced event processing (like PII scrubbing) at the edge, and providing flexible deployment options as a proxy or processing node.

Overview

Sentry event forwarding and ingestion service.

Use Cases

Best For

Scaling Sentry event ingestion for high-volume applications
Self-hosting Sentry with controlled data processing pipelines
Implementing custom event filtering and rate limiting before data reaches Sentry
Adding an additional security layer for PII scrubbing and data normalization
Reducing direct load on the main Sentry server from distributed SDKs
Building resilient error reporting architectures with Kafka-backed processing

Not Ideal For

Projects not using Sentry for error monitoring
Small-scale deployments where Sentry's direct ingestion is sufficient
Teams lacking infrastructure for Kafka or Redis, required for processing mode
Organizations preferring permissive open-source licenses over the FSL

Pros & Cons

Pros

Scalable Event Handling

By proxying events and enabling processing mode, Relay reduces direct load on the Sentry server, handling normalization, filtering, and rate limiting at the edge as described in the README.

Flexible Deployment Modes

Can run as a simple proxy or full processing node with Kafka integration, allowing customization based on needs, such as asynchronous ingestion for high-volume scenarios.

Enhanced Data Security

Supports PII scrubbing and data normalization before events reach Sentry, improving compliance and control over sensitive information in error reports.

Native Crash Reporting

Optional crash handler for segfaults and out-of-memory errors, extending error coverage to system-level issues when internal reporting is enabled.

Cons

Complex Infrastructure Requirements

Processing mode requires Kafka and Redis, adding operational overhead and complexity, as noted in the setup for integration tests and development.

Sentry Ecosystem Lock-in

Only useful with Sentry, limiting flexibility if migrating to other error monitoring tools, since it's designed specifically as a proxy for Sentry data.

Development and Setup Complexity

Requires the latest stable Rust, specific build tools like CMake for features, and configuration, making initial setup and contributions challenging for newcomers.

Frequently Asked Questions

Related Projects

candle-wasm-examples

Minimalist ML framework for Rust

Stars20,711

Forks1,664

Last commit21 hours ago

Apache Iggy

Apache Iggy: Hyper-Efficient Message Streaming at Laser Speed

Stars4,449

Forks361

Last commit14 hours ago

webapp.rs

A web application completely written in Rust. 🌍

media streaming framework and teleconferencing system written in rust

Stars1,772

Forks170