self-hosted/relay/config.example.yml
Reinaldy Rafli 054b9155f0
chore(relay): specify spool.enveloppe.max_backpressure_memory_percent configuration for handling relay's failing healthcheck (#3635)
* chore(relay): specify spool.enveloppe.max_backpressure_memory_percent configuration for handling relay's failing healthcheck

Although a fix is being rolled out, that does not mean every relay instance would suddenly be fixed. We would need to still provide a workaround for people to try out. Refer to this specific issue comment: https://github.com/getsentry/self-hosted/issues/3330#issuecomment-2751092219

* Update config.example.yml

Co-authored-by: Riccardo Busetti <riccardob36@gmail.com>

* chore: default path for relay spool envelopes

---------

Co-authored-by: Riccardo Busetti <riccardob36@gmail.com>
2025-04-12 18:42:08 +03:00

37 lines
1.3 KiB
YAML

relay:
upstream: "http://web:9000/"
host: 0.0.0.0
port: 3000
logging:
level: WARN
processing:
enabled: true
kafka_config:
- {name: "bootstrap.servers", value: "kafka:9092"}
- {name: "message.max.bytes", value: 50000000} # 50MB
redis: redis://redis:6379
geoip_path: "/geoip/GeoLite2-City.mmdb"
# 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 for more details.
# As a workaround, uncomment the following `health` and `spool` sections:
#
# health:
# max_memory_percent: 1.0
# spool:
# envelopes:
# path: "/tmp/relay-spool-envelopes"
# 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 `metrics` section and adjust the options as needed.
#
# metrics:
# statsd: "100.100.123.123:8125" # It is recommended to use IP address instead of domain name
# prefix: "sentry.relay" # Adjust this to your needs, default is "sentry.relay"
# sample_rate: 1.0 # Adjust this to your needs, default is 1.0
# # `periodic_secs` is the interval for periodic metrics emitted from Relay.
# # Setting it to `0` seconds disables the periodic metrics.
# periodic_secs: 5