Skip to content

docs(self-hosted): explain self-hosted data flow #13745

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aldy505
Copy link
Contributor

@aldy505 aldy505 commented May 17, 2025

DESCRIBE YOUR PR

Closes getsentry/self-hosted#3585

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

Copy link

vercel bot commented May 17, 2025

@aldy505 is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

Comment on lines +79 to +92
### Event Ingestion Pipeline

1. Events from the SDK is sent to the `relay` service.
2. Relay parses the incoming envelope, validates whether the DSN and Project ID is valid. It reads project config data from `redis`.
3. Relay build a new payload to be consumed by Sentry ingest consumers, and send it to `kafka`.
4. Sentry `ingest-*` consumers ( with `*` [wildcard] being the event type [errors, transaction, profiles, etc]) consumes the event, cache it in `redis` and start the `preprocess_event` task.
5. The `preprocess_event` task symbolicate stack traces with `symbolicator` service, and process event according to the event type's logic.
6. The `preprocess_event` task saves the event payload to nodestore (the default is to `postgres`).
7. The `preprocess_event` task publishes the event to `kafka` to `events` topic.

### Event Processing Pipeline

1. The `snuba-consumer` service consumes events from `events` topic and process them. Some are being republished to `post-process-forwarder` topic in `kafka`. Others are being written to `clickhouse`.
2. The Sentry consumer that consumes `post-process-forwarder` topic process the events, and republish it to `kafka`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure about these. Can anyone take a look? @markstory @untitaker @hubertdeng123 @BYK

@aldy505
Copy link
Contributor Author

aldy505 commented May 17, 2025

@AbhiPrasad Hey, this PR introduce a big chunk of mermaid diagram. Mermaid does not ship with pan & zoom feature by default, can you (or someone from the frontend devs that manages the docs) help put similar thing? There is an issue on mermaid: mermaid-js/mermaid#2162

@AbhiPrasad
Copy link
Member

I'm going to ping @chargome who helps maintain the docs - I don't think we can prioritize this over the other docs tasks atm though. We can always just ship this and then create a GH issue as a feature request.

Copy link

vercel bot commented May 18, 2025

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 May 18, 2025 6:44pm

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.

Explain data flow of self-hosted Sentry's architecture
2 participants