Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 9 additions & 2 deletions .env
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,23 @@ HEALTHCHECK_FILE_RETRIES=3
HEALTHCHECK_FILE_START_PERIOD=600s
# Set SETUP_JS_SDK_ASSETS to 1 to enable the setup of JS SDK assets
# SETUP_JS_SDK_ASSETS=1
#

# Set SETUP_CUSTOM_CA_CERTIFICATE to 1 to generate trust stores that inject
# your custom CA certificates (from ./certificates/*.crt) into non-Sentry
# services (relay, symbolicator, vroom, snuba, taskbroker, uptime-checker).
# Re-run ./install.sh after adding or changing certificates — no Docker image
# rebuilds are required. Follow the printed instructions to update your
# docker-compose.override.yml on the first run.
# SETUP_CUSTOM_CA_CERTIFICATE=1
#

# Sentry (and its' surrounding services) uses Statsd for metrics collection.
# It's also the proper way to monitor self-hosted Sentry systems.
# Set STATSD_ADDR to a valid IP:PORT combination to enable Statsd metrics collection.
# STATSD_ADDR=127.0.0.1:8125

# Set SENTRY_KAFKA_MAX_POLL_INTERVAL_MS to a value (in milliseconds) that is
# higher than the expected maximum processing time of a batch of messages for
# the Kafka consumers. This will prevent Kafka from considering the consumer
# as failed and triggering a rebalance while it is still processing messages.
# The default value is 30000 ms (30 seconds).
# SENTRY_KAFKA_MAX_POLL_INTERVAL_MS=30000
Comment on lines +51 to +52

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bug: The documented default for SENTRY_KAFKA_MAX_POLL_INTERVAL_MS in .env is 30000, but the docker-compose.yml default is 300000.
Severity: LOW

Suggested Fix

Align the documented default value in the .env file with the actual default value used in docker-compose.yml. Change the comment in .env to reflect the 300000 ms default.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: .env#L51-L52

Potential issue: There is a mismatch between the documented default value for
`SENTRY_KAFKA_MAX_POLL_INTERVAL_MS` and its implementation. The comment in the `.env`
file states the default is `30000` ms, but the `docker-compose.yml` services use a
default of `300000` ms. This 10x difference could mislead users who rely on the
documentation, potentially causing them to set a much shorter interval than intended,
which could lead to the Kafka rebalancing issues this setting is designed to mitigate.

Did we get this right? 👍 / 👎 to inform future reviews.

Loading
Loading