Add configurable CCDB connection parameters#5260
Open
WeiQuan0605 wants to merge 1 commit into
Open
Conversation
3 tasks
Allow operators to pass a connection_parameters hash in the BOSH manifest to configure PostgreSQL connection settings per-connection. SQL session params (statement_timeout, idle_in_transaction_session_timeout) are applied via Sequel's connect_sqls on every new DB connection. libpq TCP keepalive params (keepalives, keepalives_idle, keepalives_interval, keepalives_count) are merged directly into the Sequel connection options. Added optional(:connection_parameters) => Hash to both api_schema.rb and worker_schema.rb.
51d1b5b to
d0b32b5
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A short explanation of the proposed change:
Adds support for a
connection_parametershash in the CC config that allows operators to configure PostgreSQL connection settings per-connectionSQL session parameters (
statement_timeout,idle_in_transaction_session_timeout) are applied via Sequel'sconnect_sqlson every new DB connectionlibpq TCP keepalive parameters (
keepalives,keepalives_idle,keepalives_interval,keepalives_count) are merged directly into the Sequel connection optionsAn explanation of the use cases your change solves
Currently CC relies on connection timeouts configured globally at the CCDB level (e.g.
statement_timeout = 1h,idle_in_transaction_session_timeout = 10min). This works but requires DB-level access to change. This feature allows these same settings to be configured from the BOSH manifest, so they can be managed alongside other CC configuration without requiring direct DB access.Typical use case: set
statement_timeoutandidle_in_transaction_session_timeoutto match or reinforce the DB-level defaults, and configure TCP keepalives (keepalives,keepalives_idle,keepalives_interval,keepalives_count) to detect dead connections.Links to any other associated PRs
I have reviewed the contributing guide
I have viewed, signed, and submitted the Contributor License Agreement
I have made this pull request to the
mainbranchI have run all the unit tests using
bundle exec rakeI have run CF Acceptance Tests