Skip to content

Commit 174a49e

Browse files
committed
docs(self-hosted): use managed relay instead of proxy mode
1 parent 2b37d74 commit 174a49e

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

develop-docs/self-hosted/reference-architecture/separate-ingest-box.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ sidebar_title: Separate Ingest Box
44
sidebar_order: 2
55
---
66

7-
Other than having a [separate domain](/self-hosted/experimental/reverse-proxy/#expose-only-ingest-endpoint-publicly) to view the web UI and ingest data, you can also put a separate box (or server) for ingesting data, and have it relay data to the main box. This setup is recommended for high-traffic installations, and environment where you have multiple data centers.
7+
In addition to having a [separate domain](/self-hosted/experimental/reverse-proxy/#expose-only-ingest-endpoint-publicly) for viewing the web UI and ingesting data, you can deploy a dedicated server for data ingestion that relays information to your main server. This setup is recommended for high-traffic installations and environments with multiple data centers.
88

9-
Using this setup also prevents DDOS attacks against your Sentry installation, since we assume your main box can only be accessed using some kind of VPN. If there are any invalid payload being sent to your Relay instance, it will be dropped immediately. If your main box is not reachable, your Relay will keep retrying to send the data.
9+
This architecture helps mitigate DDoS attacks by distributing ingestion across multiple endpoints, while your main Sentry instance with the web UI should be protected on a private network (accessible via VPN). Invalid payloads sent to your Relay instances will be dropped immediately. If your main server becomes unreachable, your Relay will continue attempting to send the data.
1010

11-
Please note that you don't need to have multiple data centers in different countries/regions. The region naming on the diagram is to make it easier to understand.
11+
Note that the region names in the diagram below are used for illustration purposes.
1212

1313
```mermaid
1414
graph TB
@@ -33,27 +33,27 @@ graph TB
3333
relay2[Sentry Relay]
3434
end
3535
36-
subgraph "Europe Ingest Server"
36+
subgraph "Europe Ingest Server"
3737
direction TB
3838
internet3[Public Internet]
3939
relay3[Sentry Relay]
4040
end
4141
42-
internet1 --> relay1 -- Through VPN tunnel --> main
43-
internet2 --> relay2 -- Through VPN tunnel --> main
44-
internet3 --> relay3 -- Through VPN tunnel --> main
42+
internet1 --> relay1 -- Through VPN or tunnel --> main
43+
internet2 --> relay2 -- Through VPN or tunnel --> main
44+
internet3 --> relay3 -- Through VPN or tunnel --> main
4545
```
4646

47-
To configure the relay, you can install Sentry Relay on your machine through the [Relay Getting Started Guide](https://docs.sentry.io/product/relay/getting-started/). You should configure the Relay to run on `proxy` mode, and point it to the main Sentry server. You can also configure it to use a different port, or a different protocol (HTTP or HTTPS). Make sure you are using the same version of your self-hosted Sentry version.
47+
To set up the relay, install Sentry Relay on your machine by following the [Relay Getting Started Guide](https://docs.sentry.io/product/relay/getting-started/). Configure the Relay to run in `managed` mode and point it to your main Sentry server. You can customize the port and protocol (HTTP or HTTPS) as needed.
4848

49-
A simple configuration for the relay would be:
49+
After installing Relay (via Docker or executable) and running the `configure init` command, you can configure it with the following settings:
5050

5151
```yaml
5252
# Please see the relevant documentation.
5353
# Performance tuning: https://docs.sentry.io/product/relay/operating-guidelines/
5454
# All config options: https://docs.sentry.io/product/relay/options/
5555
relay:
56-
mode: proxy
56+
mode: managed
5757
instance: default
5858
upstream: https://sentry.yourcompany.com/
5959
host: 0.0.0.0
@@ -78,8 +78,8 @@ sentry:
7878
dsn: "https://[email protected]/1"
7979
```
8080
81-
Always remember to upgrade the Relay whenever you upgrade your self-hosted Sentry instance.
81+
While it's possible to run Relay on a different version than your self-hosted instance, we recommend keeping both Relay and Sentry on the same version. Remember to upgrade Relay whenever you upgrade your self-hosted Sentry installation.
8282
8383
<Alert level="info" title="Fun Fact">
84-
Sentry SaaS use this similar setup for their ingestion servers, behind Google Anycast IP address.
84+
Sentry SaaS uses a similar setup for their ingestion servers, behind Google Anycast IP address.
8585
</Alert>

0 commit comments

Comments
 (0)