Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 789e4c1

Browse files
tobias-wilfertCopilotjjbayer
authored
feat(relay): Update docs to clarify that managed mode is available for all and static mode is gone (#14787)
The `static` relay mode will be discontinued and in its place every customer will gain access to the `managed` mode. This PR updates the documentation to reflect this new reality. Ref: https://linear.app/getsentry/issue/INGEST-543/update-the-docs --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Joris Bayer <joris.bayer@sentry.io>
1 parent 991d274 commit 789e4c1

File tree

8 files changed

+11
-298
lines changed

8 files changed

+11
-298
lines changed

‎develop-docs/backend/application-domains/pii/index.mdx

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -68,39 +68,6 @@ some SDK. Go to our PII config editor [Piinguin], and:
6868
3. Paste in other payloads and see if they look fine, go to step **2** if
6969
necessary.
7070

71-
After iterating on the config, paste it back into the project config located at
72-
`.relay/projects/<PROJECT_ID>.json`
73-
74-
For example:
75-
76-
```json
77-
{
78-
"publicKeys": [
79-
{
80-
"publicKey": "___PUBLIC_KEY___",
81-
"isEnabled": true
82-
}
83-
],
84-
"config": {
85-
"allowedDomains": ["*"],
86-
"piiConfig": {
87-
"rules": {
88-
"device_id": {
89-
"type": "pattern",
90-
"pattern": "d/[a-f0-9]{12}",
91-
"redaction": {
92-
"method": "hash"
93-
}
94-
}
95-
},
96-
"applications": {
97-
"freeform": ["device_id"]
98-
}
99-
}
100-
}
101-
}
102-
```
103-
10471
[advanced data scrubbing]: https://docs.sentry.io/product/data-management-settings/scrubbing/advanced-datascrubbing/
10572
[relay]: https://github.com/getsentry/relay
10673
[piinguin]: https://getsentry.github.io/piinguin

‎docs/product/relay/getting-started.mdx

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,6 @@ _"create custom config"_ and customizing these parameters:
5555

5656
- The `mode` setting, which configures the major mode in which Relay operates. For more information on available Relay modes, refer to [Relay Modes](../modes/).
5757

58-
<Alert level="warning">
59-
60-
Currently, only `proxy` and `static` mode are available to all organizations. Relay in `managed` mode is available only on the [Business and Enterprise plans](https://sentry.io/pricing/).
61-
62-
</Alert>
63-
6458
- The `upstream` setting configures the server to which Relay will forward the
6559
events (by default the main `sentry.io` URL).
6660

@@ -96,7 +90,7 @@ Configurations are fully documented in [Configuration Options](../options/).
9690
9791
<Alert>
9892
99-
Not applicable in `proxy` or `static` mode.
93+
Not applicable in `proxy` mode.
10094

10195
</Alert>
10296

@@ -120,7 +114,7 @@ Use the `public_key` to register your Relay with the upstream server when runnin
120114

121115
<Alert>
122116

123-
Not applicable in `proxy` or `static` mode.
117+
Not applicable in `proxy` mode.
124118

125119
</Alert>
126120

‎docs/product/relay/index.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@ Relay is specifically designed to:
1212
- Improve event response time in regions with low bandwidth or limited connectivity
1313
- Act as an opaque proxy for organizations that restrict all HTTP communication to a custom domain name
1414

15-
<Alert>
16-
17-
Relay in `managed` mode is available only on the [Business and Enterprise plans](https://sentry.io/pricing/).
18-
19-
</Alert>
20-
2115
## Use Cases for Relay
2216

2317
Relay is designed to support organizations that have specific enterprise security requirements for data scrubbing of personally identifiable information (PII), response time, and enterprise domain management.

‎docs/product/relay/modes/index.mdx

Lines changed: 8 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,7 @@ sidebar_order: 2
66

77
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.
88

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.
10-
11-
<Alert>
12-
13-
Relay in `managed` mode is available only on the [Business and Enterprise plans](https://sentry.io/pricing/).
14-
15-
</Alert>
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 whether or not Relay obtains project settings for events.
1610

1711
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.
1812

@@ -34,43 +28,13 @@ relay:
3428
mode: managed
3529
```
3630
37-
## Static Mode
38-
39-
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.
40-
41-
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.
42-
43-
<Alert title="Note">
44-
45-
In `static` mode, Relay does not register with upstream since it does not query
46-
information from it. After processing events for configured projects, it
47-
forwards them upstream with the authentication information (DSN) set by
48-
the client that sent the original request.
49-
50-
</Alert>
51-
52-
To activate static mode, set this configuration:
53-
54-
```yaml
55-
relay:
56-
mode: static
57-
```
58-
59-
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,
60-
refer to [Project Configuration](/product/relay/projects/).
61-
6231
## Proxy Mode
6332
64-
Proxy mode is similar to `static` mode, but it forwards events from unknown
65-
projects. In this mode, events for statically configured projects are handled
66-
identically to `static` mode. Events for unknown projects -- projects for which
67-
there are no statically configured settings -- are forwarded (proxied) with
68-
minimal processing.
33+
Proxy mode forwards all events with minimal processing and does not receive any project settings from Sentry.
6934
7035
<Alert title="Rate Limiting">
7136
72-
Rate limiting is still applied in `proxy` mode for all projects,
73-
regardless of whether they are statically configured or proxied.
37+
Rate limiting is still applied in `proxy` mode for all projects.
7438

7539
</Alert>
7640

@@ -80,3 +44,8 @@ To activate proxy mode, set this configuration:
8044
relay:
8145
mode: proxy
8246
```
47+
48+
## Static Mode
49+
50+
Static mode has been deprecated as of Relay version 25.9.0. Please use `managed` or `proxy` mode instead. When switching to `managed` mode don't forget to migrate any data scrubbing rules in your config directory by [configuring them in the Sentry UI](/security-legal-pii
51+
/scrubbing/).

‎docs/product/relay/modes/pii-and-data-scrubbing.mdx

Lines changed: 0 additions & 97 deletions
This file was deleted.

‎docs/product/relay/options.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Credentials can be initiated as described in the [getting started page](/product
2424

2525
| key | type | value | description |
2626
| -------------------------- | ------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27-
| 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."` |
2828
| 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".` <Alert level="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> |
2929
| 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".` |
3030
| 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".` |

‎docs/product/relay/projects.mdx

Lines changed: 0 additions & 106 deletions
This file was deleted.

‎src/middleware.ts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2437,18 +2437,10 @@ const USER_DOCS_REDIRECTS: Redirect[] = [
24372437
from: '/product/security/relay/',
24382438
to: '/product/relay/',
24392439
},
2440-
{
2441-
from: '/meta/relay/projects/',
2442-
to: '/product/relay/projects/',
2443-
},
24442440
{
24452441
from: '/meta/relay/getting-started/',
24462442
to: '/product/relay/getting-started/',
24472443
},
2448-
{
2449-
from: '/meta/relay/pii-and-data-scrubbing/',
2450-
to: '/product/relay/pii-and-data-scrubbing/',
2451-
},
24522444
{
24532445
from: '/meta/relay/options/',
24542446
to: '/product/relay/options/',

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /