feat: install script to migrate sentry.conf.py config to use pgbouncer by aldy505 · Pull Request #3898 · getsentry/self-hosted

aldy505 · 2025-08-23T12:14:40Z

This PR may only be merged after #3884 has been merged

aldy505 · 2025-08-23T12:18:33Z

install/migrate-pgbouncer.sh

+# Guard this file behind SETUP_PGBOUNCER_MIGRATION
+if [ "$SETUP_PGBOUNCER_MIGRATION" == "1" ]; then


I will need to remove this flag after #3884 is merged.

_unit-test/migrate-pgbouncer-test.sh

aldy505 · 2025-08-23T12:25:51Z

Test results are ok:

Test 1 (pre 25.9.0 release)
Migrating Postgres config to PGBouncer...
  Migrating sentry/sentry.conf.py to use PGBouncer
  Migrated sentry/sentry.conf.py to use PGBouncer
DATABASES section is correct
Test 2 (post 25.9.0 release)
Migrating Postgres config to PGBouncer...
  Found pgbouncer in sentry/sentry.conf.py, I'm assuming you're good! :)
DATABASES section is correct
Test 3 (custom postgres config)
Migrating Postgres config to PGBouncer...
  ⚠️ You don't have standard configuration for Postgres in sentry/sentry.conf.py, skipping pgbouncer migration. I'm assuming you know what you're doing.
DATABASES section is correct
migrate-pgbouncer-test.sh - Success 👍

codecov · 2025-08-23T12:31:58Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.49%. Comparing base (ce45294) to head (cc7defb).
⚠️ Report is 1 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3898   +/-   ##
=======================================
  Coverage   99.49%   99.49%           
=======================================
  Files           3        3           
  Lines         197      197           
=======================================
  Hits          196      196           
  Misses          1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

frederikspang · 2025-08-23T19:55:21Z

@aldy505 LGTM

install/migrate-pgbouncer.sh

aldy505 · 2025-09-05T23:22:07Z

ping @BYK

BYK

Looks good, just rejecting for my concerns around unattended install as it looks like this may not work with non-interactive TTYs. Not sure how CI passed (or what I missed)

install/migrate-pgbouncer.sh

BYK · 2025-09-09T13:16:09Z

install/migrate-pgbouncer.sh

+# }
+# ```
+
+if sed -n '/^DATABASES = {$/,/^}$/p' "$SENTRY_CONFIG_PY" | grep -q '"HOST": "postgres"'; then


I think we should either check SKIP_USER_CREATION, SKIP_USER_PROMPT env vars, check for an interactive TTY and/or add a SENTRY_NON_INTERACTIVE_INSTALL option to skip all prompts in a sane way.

I've re-read the codebase, practically the existing SKIP_USER_PROMPT is SENTRY_NON_INTERACTIVE_INSTALL. I'll just add that.

install/migrate-pgbouncer.sh

Co-authored-by: Burak Yigit Kaya <byk@sentry.io>

BYK · 2025-09-10T12:13:21Z

install/parse-cli.sh

 if [ ! -z "${SKIP_USER_PROMPT:-}" ]; then
  depwarn "SKIP_USER_PROMPT variable" "SKIP_USER_CREATION"
  SKIP_USER_CREATION="${SKIP_USER_PROMPT}"
+  APPLY_AUTOMATIC_CONFIG_UPDATES="${SKIP_USER_PROMPT}"


Slightly nervous about this.

Because we will be trying the auto migration/config update without asking about it. Ideally this would be no action on non-interactive installs that said since you try to ensure it is unchanged, I'm fine. Just a little bit nervous in case we missed something.

I hope this change won't be troublesome for the S3 Seaweed PR

aldy505 · 2025-09-12T00:24:25Z

install/migrate-pgbouncer.sh

+      read -p "y or n? " yn
+      case $yn in
+      y | yes | 1)
+        export apply_config_changes_pgbouncer=1


FYI @BYK I made a change for this one, to not let it populate the global APPLY_AUTOMATIC_CONFIG_UPDATES. Hopefully this is the right approach.

Looks good to me. Not sure if you should be exporting it tho.

I'm not sure about it either. Took the safest way about it.

…pgbouncer (getsentry#3898)" This reverts commit 2e7a3ff.

feat: install script to migrate sentry.conf.py config to use pgbouncer

f187055

This PR may only be merged after #3884 has been merged

github-project-automation bot added this to Self-hosted Sentry Aug 23, 2025

feat: try to use standard grep and sed

b2cb6f4

aldy505 mentioned this pull request Aug 23, 2025

Add pgbouncer #3884

Merged

aldy505 commented Aug 23, 2025

View reviewed changes

seer-by-sentry bot reviewed Aug 23, 2025

View reviewed changes

_unit-test/migrate-pgbouncer-test.sh Outdated Show resolved Hide resolved

fix: wrong file name to assert

9d34a36

aldy505 requested review from BYK and aminvakil August 23, 2025 12:23

aminvakil approved these changes Aug 23, 2025

View reviewed changes

aldy505 added 2 commits August 23, 2025 20:19

Merge branch 'master' into aldy505/feat/sentry-config-pgbouncer

7c99e6e

feat: remove flag guard

9f59366

aldy505 enabled auto-merge (squash) August 23, 2025 13:23

Merge branch 'master' into aldy505/feat/sentry-config-pgbouncer

fc8a61a

hubertdeng123 reviewed Aug 24, 2025

View reviewed changes

install/migrate-pgbouncer.sh Show resolved Hide resolved

aldy505 disabled auto-merge September 2, 2025 12:18

aldy505 added 4 commits September 3, 2025 07:22

Merge branch 'master' into aldy505/feat/sentry-config-pgbouncer

82ecd9b

feat: apply config file modification behind a consent flag

6f7a217

Merge branch 'master' into aldy505/feat/sentry-config-pgbouncer

2c7738f

fix(test): set flag to apply automatic upgrade

70b6acc

aminvakil approved these changes Sep 6, 2025

View reviewed changes

BYK requested changes Sep 9, 2025

View reviewed changes

aldy505 and others added 3 commits September 9, 2025 20:24

chore: apply grammatical fixes

43d4fe3

Co-authored-by: Burak Yigit Kaya <byk@sentry.io>

feat: provide link to pgbouncer PR and respect SKIP_USER_PROMPT

4142881

Merge branch 'master' into aldy505/feat/sentry-config-pgbouncer

0db2eae

aldy505 requested a review from BYK September 9, 2025 13:57

BYK reviewed Sep 10, 2025

View reviewed changes

BYK approved these changes Sep 10, 2025

View reviewed changes

aldy505 added 2 commits September 12, 2025 07:19

Merge branch 'master' into aldy505/feat/sentry-config-pgbouncer

0f68694

feat: don't pollute APPLY_AUTOMATIC_CONFIG_UPDATES flag

7ffe582

I hope this change won't be troublesome for the S3 Seaweed PR

aldy505 commented Sep 12, 2025

View reviewed changes

Merge branch 'master' into aldy505/feat/sentry-config-pgbouncer

cc7defb

aldy505 merged commit 2e7a3ff into master Sep 12, 2025
16 checks passed

aldy505 deleted the aldy505/feat/sentry-config-pgbouncer branch September 12, 2025 14:03

xprotocol-bot added a commit to xprotocol-org/self-hosted that referenced this pull request Sep 18, 2025

Revert "feat: install script to migrate sentry.conf.py config to use …

37b77df

…pgbouncer (getsentry#3898)" This reverts commit 2e7a3ff.

xprotocol-bot added a commit to xprotocol-org/self-hosted that referenced this pull request Sep 24, 2025

Revert "feat: install script to migrate sentry.conf.py config to use …

5dbc4d0

…pgbouncer (getsentry#3898)" This reverts commit 2e7a3ff.

github-actions bot locked and limited conversation to collaborators Sep 28, 2025

		# Guard this file behind SETUP_PGBOUNCER_MIGRATION
		if [ "$SETUP_PGBOUNCER_MIGRATION" == "1" ]; then

Uh oh!

Conversation

aldy505 commented Aug 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

aldy505 commented Aug 23, 2025

Uh oh!

codecov bot commented Aug 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

frederikspang commented Aug 23, 2025

Uh oh!

Uh oh!

aldy505 commented Sep 5, 2025

Uh oh!

BYK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Aug 23, 2025 •

edited

Loading