You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/product/relay/modes/index.mdx
+7-33Lines changed: 7 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ sidebar_order: 2
6
6
7
7
Relay can operate in one of several major modes, and it is critical to understand the modes prior if you are configuring the Relay server rather than using the default settings.
8
8
9
-
The mode is stored in the configuration file, which contains the `relay.mode` field. This field specifies the mode in which Relay will run: `managed`, `static`, or `proxy`. The Relay mode controls the way Relay obtains project settings for events.
9
+
The mode is stored in the configuration file, which contains the `relay.mode` field. This field specifies the mode in which Relay will run: `managed` or `proxy`. The Relay mode controls the way Relay obtains project settings for events.
10
10
11
11
In Sentry, event processing is configured according to both project and organization settings. Some settings, such as privacy controls, are set at the organization level, then inherited by all projects in that organization; other settings are specified per project. For Relay, events are processed according to the inherited project settings to which the event is sent.
12
12
@@ -28,43 +28,13 @@ relay:
28
28
mode: managed
29
29
```
30
30
31
-
## Static Mode
32
-
33
-
In static mode, projects must be configured manually. In this mode, Relay will process events for only statically configured projects, and reject events for all other projects.
34
-
35
-
This mode is useful when you know the projects sending events and you need to explicitly control the projects allowed to send events through this Relay.
36
-
37
-
<Alert title="Note">
38
-
39
-
In `static` mode, Relay does not register with upstream since it does not query
40
-
information from it. After processing events for configured projects, it
41
-
forwards them upstream with the authentication information (DSN) set by
42
-
the client that sent the original request.
43
-
44
-
</Alert>
45
-
46
-
To activate static mode, set this configuration:
47
-
48
-
```yaml
49
-
relay:
50
-
mode: static
51
-
```
52
-
53
-
To configure projects, add files using the format `projects/<PROJECT_ID>.json` to your Relay configuration folder. For a description of the contents of this file,
54
-
refer to.
55
-
56
31
## Proxy Mode
57
32
58
-
Proxy mode is similar to `static` mode, but it forwards events from unknown
59
-
projects. In this mode, events for statically configured projects are handled
60
-
identically to `static` mode. Events for unknown projects -- projects for which
61
-
there are no statically configured settings -- are forwarded (proxied) with
62
-
minimal processing.
33
+
Proxy mode forwards the all events with minimal processing.
63
34
64
35
<Alert title="Rate Limiting">
65
36
66
-
Rate limiting is still applied in `proxy` mode for all projects,
67
-
regardless of whether they are statically configured or proxied.
37
+
Rate limiting is still applied in `proxy` mode for all projects.
68
38
69
39
</Alert>
70
40
@@ -74,3 +44,7 @@ To activate proxy mode, set this configuration:
74
44
relay:
75
45
mode: proxy
76
46
```
47
+
48
+
## Static Mode
49
+
50
+
Static mode has been deprecated as of Relay version 25.9.0. Pleas use `managed` or `proxy` mode instead. When switching to `managed` mode don't forget to migrate any local scrubbing rules by configuring them in the Sentry UI.
| relay.mode | String | default value: `managed` possible values: `managed, static, proxy, capture` optional: `false`| Controls how Relay obtains the project configuration for events. For detailed explanation of these modes, see [Relay Modes](/product/relay/modes/). `Environment variable: "RELAY_MODE."`|
27
+
| relay.mode | String | default value: `managed` possible values: `managed, proxy` optional: `false`| Controls how Relay obtains the project configuration for events. For detailed explanation of these modes, see [Relay Modes](/product/relay/modes/). `Environment variable: "RELAY_MODE."`|
28
28
| relay.upstream | String | default value: `https://sentry.io` optional: `false`| Fully qualified URL of the upstream Relay or Sentry instance. `Environment variable: "RELAY_UPSTREAM_URL".` <Alertlevel="warning"title="Important"> Relay doesn't check for cycles. Don't set this option to an endpoint that will cause events to be cycled back here. </Alert> |
29
29
| relay.host | String | default value: `0.0.0.0 in Docker, otherwise 127.0.0.1` optional: `false`| The host to which Relay should bind (network interface). `Environment variable: "RELAY_HOST".`|
30
30
| relay.port | Integer | default value: `3000` optional: `false`| The port to which Relay should bind for the unencrypted Relay HTTP server. `Environment variable: "RELAY_PORT".`|
0 commit comments