-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add migration to set the pgAudit config (#2172)
Add migration to disable pgAudit on the app_db_user and rdsproxyadmin user. This is being done to save costs and reduce the logging pressure on the database instances.
- Loading branch information
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
""" | ||
Revision ID: 0452_set_pgaudit_config | ||
Revises: 0451_create_db_users | ||
Create Date: 2024-05-27 12:00:00 | ||
""" | ||
from alembic import op | ||
|
||
revision = "0452_set_pgaudit_config" | ||
down_revision = "0451_create_db_users" | ||
|
||
users = ["app_db_user", "rdsproxyadmin"] | ||
database_name = op.get_bind().engine.url.database # database name that the migration is being run on | ||
|
||
|
||
def upgrade(): | ||
# Skip this migration in the test database as there are multiple test databases that are created. | ||
# This leads to a race condition attempting to alter the same users multiple times and causes | ||
# sporadic unit test failures. | ||
if "test_notification_api" in database_name: | ||
return | ||
|
||
for user in users: | ||
create_user_if_not_exists(user) | ||
op.execute(f"ALTER USER {user} SET pgaudit.log TO 'NONE'") | ||
|
||
|
||
def downgrade(): | ||
if "test_notification_api" in database_name: | ||
return | ||
|
||
# Reset the pgaudit.log setting | ||
for user in users: | ||
op.execute(f"ALTER USER {user} RESET pgaudit.log") | ||
|
||
|
||
def create_user_if_not_exists(user): | ||
""" | ||
Makes sure the expected user exists in the database before performing the ALTER USER operation. | ||
If the user already exists, nothing happens. This is needed so that the migrations can be | ||
run on localhost where the users do not exist. | ||
""" | ||
op.execute( | ||
f""" | ||
DO $$ | ||
BEGIN | ||
CREATE USER {user}; | ||
EXCEPTION WHEN duplicate_object THEN RAISE NOTICE '%, skipping', SQLERRM USING ERRCODE = SQLSTATE; | ||
END | ||
$$; | ||
""" | ||
) |