Skip to content

doc(relay): Link to relay config values#17154

Open
elramen wants to merge 1 commit intomasterfrom
elramen-relay
Open

doc(relay): Link to relay config values#17154
elramen wants to merge 1 commit intomasterfrom
elramen-relay

Conversation

@elramen
Copy link
Copy Markdown
Member

@elramen elramen commented Mar 27, 2026

DESCRIBE YOUR PR

As a follow up on #17114 (review) :

  • link directly to ConfigValues instead of the entire crate.
  • link to an example config to make it clearer how ConfigValues map to keys in the actual config.yml

Fixes https://linear.app/getsentry/issue/INGEST-687/replace-product-relay-configuration-options-with-link-to-rust-docs

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@elramen elramen requested a review from jjbayer March 27, 2026 16:23
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 27, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Mar 27, 2026 5:25pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Mar 27, 2026 5:25pm

Request Review

@linear-code
Copy link
Copy Markdown

linear-code bot commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix prepared a fix for the issue found in the latest run.

  • ✅ Fixed: Duplicated config example across two documentation files
    • I removed the duplicated YAML blocks and replaced the defaults wording with a reference to the Getting Started example config mapping.

Create PR

Or push these changes by commenting:

@cursor push d254b10ff4
Preview (d254b10ff4)
diff --git a/docs/product/relay/options.mdx b/docs/product/relay/options.mdx
--- a/docs/product/relay/options.mdx
+++ b/docs/product/relay/options.mdx
@@ -22,26 +22,6 @@
 
 ## Configuration Reference
 
-For a comprehensive and up-to-date list of all configuration options, see [ConfigValues](https://getsentry.github.io/relay/relay_config/struct.ConfigValues.html). Note that some options, such as `processing`, are only relevant when [self-hosting](https://develop.sentry.dev/self-hosted/). 
+For a comprehensive and up-to-date list of all configuration options, see [ConfigValues](https://getsentry.github.io/relay/relay_config/struct.ConfigValues.html). Note that some options, such as `processing`, are only relevant when [self-hosting](https://develop.sentry.dev/self-hosted/).
 
-All configuration values are optional and default to these settings:
-
-```yaml {tabTitle:Run in Docker}
-relay:
-  mode: managed
-  # The upstream hostname is taken from any of your DSNs.
-  # Go to your Project Settings, and then to "Client Keys (DSN)" to see them.
-  upstream: https://___ORG_INGEST_DOMAIN___
-  host: 0.0.0.0
-  port: 3000
-```
-
-```yaml {tabTitle:Run Executable}
-relay:
-  mode: managed
-  # The upstream hostname is taken from any of your DSNs.
-  # Go to your Project Settings, and then to "Client Keys (DSN)" to see them.
-  upstream: https://___ORG_INGEST_DOMAIN___
-  host: 127.0.0.1
-  port: 3000
\ No newline at end of file
-```
+For an example `config.yml` showing how `ConfigValues` map to YAML keys, see [Getting Started](../getting-started/).
\ No newline at end of file

This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant