Skip to content

chore(relay): specify spool.enveloppe.max_backpressure_memory_percent configuration for handling relay's failing healthcheck #3635

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.

Sign up for GitHub

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

Merged
BYK merged 3 commits into from
Apr 12, 2025
Merged

chore(relay): specify spool.enveloppe.max_backpressure_memory_percent configuration for handling relay's failing healthcheck #3635

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
acc2c05
chore(relay): specify spool.enveloppe.max_backpressure_memory_percent…
aldy505 Mar 26, 2025
094588c
Update config.example.yml
aldy505 Mar 26, 2025
de434dd
chore: default path for relay spool envelopes
aldy505 Mar 28, 2025
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
5 changes: 5 additions & 0 deletions relay/config.example.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,15 @@ processing:

# In some cases, relay might fail to find out the actual machine memory
# therefore it makes the healthcheck fail and events can't be submitted.
# See https://github.com/getsentry/self-hosted/issues/3330
# As a workaround, uncomment the following line:
Copy link
Member

@BYK BYK Mar 26, 2025

Choose a reason for hiding this comment

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

Following lines? We should also clearly mark where those lines start and end?

#
# health:
# max_memory_percent: 1.0
# spool:
# envelopes:
# path: "/your/path"
Copy link
Collaborator

@aminvakil aminvakil Mar 26, 2025

Choose a reason for hiding this comment

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

Can we have an example of this path?

Copy link
Collaborator Author

@aldy505 aldy505 Mar 27, 2025

Choose a reason for hiding this comment

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

It should just be a path residing on the Docker volume... or since relay doesn't have a persisted volume, probably it's best to use /tmp/foo directory?

Copy link
Collaborator

@aminvakil aminvakil Mar 27, 2025

Choose a reason for hiding this comment

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

I'm quite unfamiliar with this change, so could you please bear with me and tell me, is it going to be more than 4GB?

I've seen odd situations when using /tmp and filling it with files bigger than 4GB size.

If that's not the case, then correct, /tmp/foo seems right to me.

Copy link
Member

@BYK BYK Mar 27, 2025

Choose a reason for hiding this comment

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

Who not mount a volume to relay for this?

Copy link
Collaborator Author

@aldy505 aldy505 Mar 28, 2025

Choose a reason for hiding this comment

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

From the docs, the default size is 500MB. We should be fine, no need for another volume. https://docs.sentry.io/product/relay/options/#spooling

# max_backpressure_memory_percent: 1.0

# If you have statsd server, you can utilize that to monitor self-hosted Relay.
# To start, uncomment the following line and adjust the options as needed.
Expand Down