Skip to content

Conversation

@Dav1dde
Copy link
Member

@Dav1dde Dav1dde commented Nov 22, 2024

Closes: https://github.com/getsentry/team-ingest/issues/90

Some best practices for development on Relay.

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

@Dav1dde Dav1dde requested a review from a team November 22, 2024 11:44
@Dav1dde Dav1dde self-assigned this Nov 22, 2024
@vercel
Copy link

vercel bot commented Nov 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 26, 2024 11:04am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 26, 2024 11:04am
sentry-docs ⬜️ Ignored (Inspect) Visit Preview Nov 26, 2024 11:04am

Copy link
Member

@jjbayer jjbayer left a comment

Choose a reason for hiding this comment

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

Thanks!

Make sure changes to the event protocol and APIs are forward-compatible. Relay should not drop
or truncate data it does not understand. It is a supported use-case to have customers running
outdated Relays but up-to-date SDKs.

Copy link
Member

Choose a reason for hiding this comment

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

We could mention retain=true here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure how to phrase this and if we start naming things we probably want to name all the tools available (e.g. additional_properties). Gonna leave this for a follow-up or maybe even an extra page.

@Dav1dde Dav1dde merged commit 1353b8a into master Nov 26, 2024
10 checks passed
@Dav1dde Dav1dde deleted the dav1d/relay-best-practices branch November 26, 2024 11:06
martinhaintz pushed a commit that referenced this pull request Nov 27, 2024
…ierarchy

* master: (28 commits)
  feat(angular): Update SDK provider setup for Angular 19 (#11921)
  feat(dynamic-sampling): adapt docs to new dynamic sampling logic (#11886)
  update banner for post-launch week promotion (#11964)
  chore(android): Add masking options to AndroidManifest (#11863)
  Bump API schema to 2126f7dd (#11965)
  chore(Profiling): Add callouts and links to Android Profiling troubleshooting info (#11905)
  docs(flutter): Use sentry flutter init in samples (#11858)
  use native crypto to generate uuid (#11959)
  fix vercel integration 404 (#11958)
  Add RN Replay Privacy page (#11798)
  feat(dashboards): Add docs for Dashboard Edit Access Selector (#11822)
  feat(app-starts): Add RN SDK min version (#11650)
  feat(realy): Add Relay best practices guide (#11914)
  docs(sdks): New Scope APIs (#11943)
  docs(sdks): Span Sampling (#11940)
  Add include explaining sample code options (#11866)
  devenv: internal troubleshooting (#11947)
  Bump API schema to 0b18bfae (#11946)
  Bump API schema to 2bee5317 (#11945)
  feat: Link to Replay Issues when we mention Perf Issues as well (#11933)
  ...
@github-actions github-actions bot locked and limited conversation to collaborators Dec 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants