Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Sentry attempts to scrub high-cardinality identifiers from URL transactions
to aggregate performance data and provide more valuable insights.

In terms of user experience, this feature plays a similar role as [Issue Grouping](/backend/grouping/).
In terms of technical implementation, it is similar to [Data Scrubbing](/backend/pii/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we leave this item in place now that not all pii docs are gone from dev docs?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that is a fair point.


## The Problem

Expand Down
10 changes: 2 additions & 8 deletions docs/product/relay/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,6 @@ _"create custom config"_ and customizing these parameters:

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

<Alert level="warning">

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/).

</Alert>

- The `upstream` setting configures the server to which Relay will forward the
events (by default the main `sentry.io` URL).

Expand Down Expand Up @@ -96,7 +90,7 @@ Configurations are fully documented in [Configuration Options](../options/).

<Alert>

Not applicable in `proxy` or `static` mode.
Not applicable in `proxy` mode.

</Alert>

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

<Alert>

Not applicable in `proxy` or `static` mode.
Not applicable in `proxy` mode.

</Alert>

Expand Down
6 changes: 0 additions & 6 deletions docs/product/relay/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@ Relay is specifically designed to:
- Improve event response time in regions with low bandwidth or limited connectivity
- Act as an opaque proxy for organizations that restrict all HTTP communication to a custom domain name

<Alert>

Relay in `managed` mode is available only on the [Business and Enterprise plans](https://sentry.io/pricing/).

</Alert>

## Use Cases for Relay

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.
Expand Down
46 changes: 7 additions & 39 deletions docs/product/relay/modes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,7 @@ sidebar_order: 2

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.

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.

<Alert>

Relay in `managed` mode is available only on the [Business and Enterprise plans](https://sentry.io/pricing/).

</Alert>
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.

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.

Expand All @@ -34,43 +28,13 @@ relay:
mode: managed
```

## Static Mode

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.

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.

<Alert title="Note">

In `static` mode, Relay does not register with upstream since it does not query
information from it. After processing events for configured projects, it
forwards them upstream with the authentication information (DSN) set by
the client that sent the original request.

</Alert>

To activate static mode, set this configuration:

```yaml
relay:
mode: static
```

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,
refer to [Project Configuration](/product/relay/projects/).

## Proxy Mode

Proxy mode is similar to `static` mode, but it forwards events from unknown
projects. In this mode, events for statically configured projects are handled
identically to `static` mode. Events for unknown projects -- projects for which
there are no statically configured settings -- are forwarded (proxied) with
minimal processing.
Proxy mode forwards all events with minimal processing and does not receive any project settings from Sentry.

<Alert title="Rate Limiting">

Rate limiting is still applied in `proxy` mode for all projects,
regardless of whether they are statically configured or proxied.
Rate limiting is still applied in `proxy` mode for all projects.

</Alert>

Expand All @@ -80,3 +44,7 @@ To activate proxy mode, set this configuration:
relay:
mode: proxy
```

## Static Mode

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 local scrubbing rules by configuring them in the Sentry UI.
97 changes: 0 additions & 97 deletions docs/product/relay/modes/pii-and-data-scrubbing.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/product/relay/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Credentials can be initiated as described in the [getting started page](/product

| key | type | value | description |
| -------------------------- | ------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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."` |
| 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."` |
| 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> |
| 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".` |
| 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".` |
Expand Down
106 changes: 0 additions & 106 deletions docs/product/relay/projects.mdx

This file was deleted.

8 changes: 0 additions & 8 deletions src/middleware.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2437,18 +2437,10 @@ const USER_DOCS_REDIRECTS: Redirect[] = [
from: '/product/security/relay/',
to: '/product/relay/',
},
{
from: '/meta/relay/projects/',
to: '/product/relay/projects/',
},
{
from: '/meta/relay/getting-started/',
to: '/product/relay/getting-started/',
},
{
from: '/meta/relay/pii-and-data-scrubbing/',
to: '/product/relay/pii-and-data-scrubbing/',
},
{
from: '/meta/relay/options/',
to: '/product/relay/options/',
Expand Down
Loading