[YSQL][docs] YSQL connection manager gflags docs #25647
Open
Conversation
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
✅ Deploy Preview for infallible-bardeen-164bc9 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
ddhodge
reviewed
Jan 16, 2025
| @@ -97,6 +97,14 @@ The following table describes YB-TServer flags related to YSQL Connection Manage | |||
| | ysql_conn_mgr_server_lifetime | The maximum duration (in seconds) that a backend PostgreSQL connection managed by YSQL Connection Manager can remain open after creation. | 3600 | | |||
| | ysql_conn_mgr_log_settings | Comma-separated list of log settings for YSQL Connection Manger. Can include 'log_debug', 'log_config', 'log_session', 'log_query', and 'log_stats'. | "" | | |||
| | ysql_conn_mgr_use_auth_backend | Enable the use of the auth-backend for authentication of logical connections. When false, the older auth-passthrough implementation is used. | true | | |||
| | ysql_conn_mgr_readahead_buffer_size | Size of the per-connection buffer(in bytes) used for IO read-ahead operations in YSQL Connection Manager | 8192 | | |||
There was a problem hiding this comment.
Suggested change
| | ysql_conn_mgr_readahead_buffer_size | Size of the per-connection buffer(in bytes) used for IO read-ahead operations in YSQL Connection Manager | 8192 | | |
| | ysql_conn_mgr_readahead_buffer_size | Size of the per-connection buffer (in bytes) used for IO read-ahead operations in YSQL Connection Manager. | 8192 | |
| @@ -97,6 +97,14 @@ The following table describes YB-TServer flags related to YSQL Connection Manage | |||
| | ysql_conn_mgr_server_lifetime | The maximum duration (in seconds) that a backend PostgreSQL connection managed by YSQL Connection Manager can remain open after creation. | 3600 | | |||
| | ysql_conn_mgr_log_settings | Comma-separated list of log settings for YSQL Connection Manger. Can include 'log_debug', 'log_config', 'log_session', 'log_query', and 'log_stats'. | "" | | |||
| | ysql_conn_mgr_use_auth_backend | Enable the use of the auth-backend for authentication of logical connections. When false, the older auth-passthrough implementation is used. | true | | |||
| | ysql_conn_mgr_readahead_buffer_size | Size of the per-connection buffer(in bytes) used for IO read-ahead operations in YSQL Connection Manager | 8192 | | |||
| | ysql_conn_mgr_tcp_keepalive | TCP keepalive time in YSQL Connection Manager. Set to zero to disable keepalive | 15 | | |||
There was a problem hiding this comment.
Suggested change
| | ysql_conn_mgr_tcp_keepalive | TCP keepalive time in YSQL Connection Manager. Set to zero to disable keepalive | 15 | | |
| | ysql_conn_mgr_tcp_keepalive | TCP keepalive time (in seconds) in YSQL Connection Manager. Set to zero to disable keepalive. | 15 | |
| @@ -97,6 +97,14 @@ The following table describes YB-TServer flags related to YSQL Connection Manage | |||
| | ysql_conn_mgr_server_lifetime | The maximum duration (in seconds) that a backend PostgreSQL connection managed by YSQL Connection Manager can remain open after creation. | 3600 | | |||
| | ysql_conn_mgr_log_settings | Comma-separated list of log settings for YSQL Connection Manger. Can include 'log_debug', 'log_config', 'log_session', 'log_query', and 'log_stats'. | "" | | |||
| | ysql_conn_mgr_use_auth_backend | Enable the use of the auth-backend for authentication of logical connections. When false, the older auth-passthrough implementation is used. | true | | |||
| | ysql_conn_mgr_readahead_buffer_size | Size of the per-connection buffer(in bytes) used for IO read-ahead operations in YSQL Connection Manager | 8192 | | |||
| | ysql_conn_mgr_tcp_keepalive | TCP keepalive time in YSQL Connection Manager. Set to zero to disable keepalive | 15 | | |||
| | ysql_conn_mgr_tcp_keepalive_keep_interval | TCP keepalive interval(in seconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 75 | | |||
There was a problem hiding this comment.
Suggested change
| | ysql_conn_mgr_tcp_keepalive_keep_interval | TCP keepalive interval(in seconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 75 | | |
| | ysql_conn_mgr_tcp_keepalive_keep_interval | TCP keepalive interval (in seconds) in YSQL Connection Manager. Only applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 75 | |
| | ysql_conn_mgr_readahead_buffer_size | Size of the per-connection buffer(in bytes) used for IO read-ahead operations in YSQL Connection Manager | 8192 | | ||
| | ysql_conn_mgr_tcp_keepalive | TCP keepalive time in YSQL Connection Manager. Set to zero to disable keepalive | 15 | | ||
| | ysql_conn_mgr_tcp_keepalive_keep_interval | TCP keepalive interval(in seconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 75 | | ||
| | ysql_conn_mgr_tcp_keepalive_probes | TCP keepalive probes in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | |
There was a problem hiding this comment.
Suggested change
| | ysql_conn_mgr_tcp_keepalive_probes | TCP keepalive probes in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | | |
| | ysql_conn_mgr_tcp_keepalive_probes | Number of TCP keepalive probes in YSQL Connection Manager. Only applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | |
| | ysql_conn_mgr_tcp_keepalive | TCP keepalive time in YSQL Connection Manager. Set to zero to disable keepalive | 15 | | ||
| | ysql_conn_mgr_tcp_keepalive_keep_interval | TCP keepalive interval(in seconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 75 | | ||
| | ysql_conn_mgr_tcp_keepalive_probes | TCP keepalive probes in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | | ||
| | ysql_conn_mgr_tcp_keepalive_usr_timeout | TCP user timeout(in milliseconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | |
There was a problem hiding this comment.
Suggested change
| | ysql_conn_mgr_tcp_keepalive_usr_timeout | TCP user timeout(in milliseconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | | |
| | ysql_conn_mgr_tcp_keepalive_usr_timeout | TCP user timeout (in milliseconds) in YSQL Connection Manager. Only applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | |
| | ysql_conn_mgr_tcp_keepalive_keep_interval | TCP keepalive interval(in seconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 75 | | ||
| | ysql_conn_mgr_tcp_keepalive_probes | TCP keepalive probes in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | | ||
| | ysql_conn_mgr_tcp_keepalive_usr_timeout | TCP user timeout(in milliseconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | | ||
| | ysql_conn_mgr_control_connection_pool_size | Maximum number of concurrent control connections in YSQL Connection Manager. If the value is zero, the default value is 0.1 * ysql_max_connections | 0 | |
There was a problem hiding this comment.
Suggested change
| | ysql_conn_mgr_control_connection_pool_size | Maximum number of concurrent control connections in YSQL Connection Manager. If the value is zero, the default value is 0.1 * ysql_max_connections | 0 | | |
| | ysql_conn_mgr_control_connection_pool_size | Maximum number of concurrent control connections in YSQL Connection Manager. If set to zero, calculated as 0.1 * ysql_max_connections. | 0 | |
| | ysql_conn_mgr_tcp_keepalive_probes | TCP keepalive probes in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | | ||
| | ysql_conn_mgr_tcp_keepalive_usr_timeout | TCP user timeout(in milliseconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | | ||
| | ysql_conn_mgr_control_connection_pool_size | Maximum number of concurrent control connections in YSQL Connection Manager. If the value is zero, the default value is 0.1 * ysql_max_connections | 0 | | ||
| | ysql_conn_mgr_pool_timeout | Server pool wait timeout(in milliseconds) in YSQL Connection Manager. Time to wait in milliseconds for an available server. Disconnect client on timeout reach. If the value is set to zero, the client waits for the server connection indefinitely | 0 | |
There was a problem hiding this comment.
Suggested change
| | ysql_conn_mgr_pool_timeout | Server pool wait timeout(in milliseconds) in YSQL Connection Manager. Time to wait in milliseconds for an available server. Disconnect client on timeout reach. If the value is set to zero, the client waits for the server connection indefinitely | 0 | | |
| | ysql_conn_mgr_pool_timeout | Server pool wait timeout (in milliseconds) in YSQL Connection Manager. This is the time clients wait for an available server, after which they are disconnected. If set to zero, clients wait for server connections indefinitely. | 0 | |
| | ysql_conn_mgr_tcp_keepalive_usr_timeout | TCP user timeout(in milliseconds) in YSQL Connection Manager. This is applicable if 'ysql_conn_mgr_tcp_keepalive' is enabled. | 9 | | ||
| | ysql_conn_mgr_control_connection_pool_size | Maximum number of concurrent control connections in YSQL Connection Manager. If the value is zero, the default value is 0.1 * ysql_max_connections | 0 | | ||
| | ysql_conn_mgr_pool_timeout | Server pool wait timeout(in milliseconds) in YSQL Connection Manager. Time to wait in milliseconds for an available server. Disconnect client on timeout reach. If the value is set to zero, the client waits for the server connection indefinitely | 0 | | ||
| | ysql_conn_mgr_sequence_support_mode | Sequence support mode when YSQL connection manager is enabled. When set to 'pooled_without_curval_lastval', currval() and lastval() functions are not supported. "When set to 'pooled_with_curval_lastval', currval() and lastval() functions are supported. In these both settings, the monotonic order of sequence is not guaranteed if the "'ysql_sequence_cache_method' is set to 'connection'. To support monotonic order also, set this flag to 'session'. | pooled_without_curval_lastval | |
There was a problem hiding this comment.
Suggested change
| | ysql_conn_mgr_sequence_support_mode | Sequence support mode when YSQL connection manager is enabled. When set to 'pooled_without_curval_lastval', currval() and lastval() functions are not supported. "When set to 'pooled_with_curval_lastval', currval() and lastval() functions are supported. In these both settings, the monotonic order of sequence is not guaranteed if the "'ysql_sequence_cache_method' is set to 'connection'. To support monotonic order also, set this flag to 'session'. | pooled_without_curval_lastval | | |
| | ysql_conn_mgr_sequence_support_mode | Sequence support mode when YSQL connection manager is enabled. When set to 'pooled_without_curval_lastval', the currval() and lastval() functions are not supported. When set to 'pooled_with_curval_lastval', the currval() and lastval() functions are supported. For both settings, monotonic sequence order is not guaranteed if `ysql_sequence_cache_method` is set to `connection`. To also support monotonic order, set this flag to `session`. | pooled_without_curval_lastval | |
|
What versions does this apply to? |
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.
Documentation for the new gflag added for YSQL connection manager
2024.2.1 and 2.25.1