-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(relay): Update docs to clarify that managed
mode is available for all and static
mode is gone
#14787
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
feat(relay): Update docs to clarify that managed
mode is available for all and static
mode is gone
#14787
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 621 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-edge-server-array-pushAssets Changed:
|
…om else where in the code.
managed
warningmanaged
mode is available for all and static
mode is gone
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates documentation to reflect changes in Relay mode availability: managed
mode is now available to all customers while static
mode has been deprecated. The changes remove outdated billing restrictions and deprecated documentation.
- Removes warnings that
managed
mode is only available to Business/Enterprise customers - Deprecates
static
mode documentation and redirects - Cleans up PII documentation that was primarily needed for
static
mode
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
src/middleware.ts | Removes redirect mappings for deprecated PII and static mode documentation |
redirects.js | Removes application PII redirect that's no longer needed |
docs/product/relay/projects.mdx | Removes entire project configuration documentation for static mode |
docs/product/relay/options.mdx | Updates available relay modes from managed, static, proxy, capture to managed, proxy |
docs/product/relay/modes/pii-and-data-scrubbing.mdx | Removes PII scrubbing documentation specific to static mode |
docs/product/relay/modes/index.mdx | Removes managed mode billing restrictions and static mode documentation, adds deprecation notice |
docs/product/relay/index.mdx | Removes managed mode billing restriction alert |
docs/product/relay/getting-started.mdx | Removes managed mode billing warnings and static mode references |
develop-docs/backend/application-domains/transaction-clustering/index.mdx | Removes reference to deprecated PII documentation |
develop-docs/backend/application-domains/pii/types.mdx | Removes entire PII rule types documentation |
develop-docs/backend/application-domains/pii/selectors.mdx | Removes entire PII selectors documentation |
develop-docs/backend/application-domains/pii/methods.mdx | Removes entire PII redaction methods documentation |
develop-docs/backend/application-domains/pii/index.mdx | Removes entire PII and data scrubbing documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
docs/product/relay/modes/index.mdx
Outdated
|
||
## Static Mode | ||
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There might be a better way to phrase this.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good but I would keep the develop docs.
Co-authored-by: Joris Bayer <joris.bayer@sentry.io>
Co-authored-by: Joris Bayer <joris.bayer@sentry.io>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Broken Links After Redirect Removal
Removing the redirects for /meta/relay/projects/
and /meta/relay/pii-and-data-scrubbing/
will lead to 404 errors. These redirects previously pointed to pages that are also being deleted, causing users accessing the old URLs to encounter broken links.
src/middleware.ts#L2432-L2447
Lines 2432 to 2447 in 4c4ea1f
{ | |
from: '/meta/relay/', | |
to: '/product/relay/', | |
}, | |
{ | |
from: '/product/security/relay/', | |
to: '/product/relay/', | |
}, | |
{ | |
from: '/meta/relay/getting-started/', | |
to: '/product/relay/getting-started/', | |
}, | |
{ | |
from: '/meta/relay/options/', | |
to: '/product/relay/options/', | |
}, |
After iterating on the config, paste it back into the project config located at | ||
`.relay/projects/<PROJECT_ID>.json` | ||
|
||
For example: | ||
|
||
```json | ||
{ | ||
"publicKeys": [ | ||
{ | ||
"publicKey": "___PUBLIC_KEY___", | ||
"isEnabled": true | ||
} | ||
], | ||
"config": { | ||
"allowedDomains": ["*"], | ||
"piiConfig": { | ||
"rules": { | ||
"device_id": { | ||
"type": "pattern", | ||
"pattern": "d/[a-f0-9]{12}", | ||
"redaction": { | ||
"method": "hash" | ||
} | ||
} | ||
}, | ||
"applications": { | ||
"freeform": ["device_id"] | ||
} | ||
} | ||
} | ||
} | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jjbayer Is it ok if I remove this though?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes!
The
static
relay mode will be discontinued and in its place every customer will gain access to themanaged
mode. This PR updates the documentation to reflect this new reality by:managed
mode is only available to buisness or enterprise customersstatic
modestatic
mode except for in the mode docs themself where the docs now tells people to migrate to one of the other modes.Ref: https://linear.app/getsentry/issue/INGEST-543/update-the-docs