VTTablet Connection Pools and Sizing

VTTablet uses a variety of connection pools to connect to MySQLd. Most of these can be controlled by vttablet options.
Note that almost all of these pools are not fixed size connection pools, and will grow on demand to the maximum configured sizes.
In older Vitess versions, v6.0 or before, some pools would eventually shrink again, but in recent Vitess versions a new pool connection is created when an old one reaches its idle timeout.
As a result, pools will now effectively never shrink.

One thing to note is that each of these pools do not use unique MySQL usernames, so it can be hard from a MySQL process list to distinguish between different pool connections.
Consult the _active pool metrics (e.g. vttablet_dba_conn_pool_active) as the authoritative resource on how many MySQL protocol connections are in use for each pool. In a similar fashion the _exhausted pool metrics (e.g. vttablet_dba_conn_pool_exhausted) can be used to see if a given pool has run out of connections (and how many times), since VTTablet startup.

Note that a connection pool running out of connections is not necessarily a bad thing, since it limits the concurrency in the database. As a result, connection pools should be sized mindful of the capacity of the underlying MySQL instance(s).

Pools: #

transaction_pool and found_rows_pool #

  • Max size (for each) controlled by: --queryserver-config-transaction-cap (default 20)
  • metric: vttablet_transaction_pool_capacity
  • metric: vttablet_found_rows_pool_capacity
  • Used by transaction engine to manage transactions that require a dedicated connection. The main pool for this use the transaction_pool. The found_rows_pool is dedicated for connections where the client is using the CLIENT_FOUND_ROWS option. For example, the affected_rows field return by the MySQL protocol becomes the number of rows matched by the WHERE clause instead.

conn_pool #

  • Max size controlled controlled by: --queryserver-config-pool-size (default 16)
  • metric: vttablet_conn_pool_capacity
  • Potentially uses --db_app_user, --db_dba_user and --db_appdebug_user i.e. defaults 'vt_app', 'vt_dba' and 'vt_appdebug'
  • Used as the vttablet query engine "normal" (non-streaming) connections pool.

stream_conn_pool #

  • Max size controlled by: --queryserver-config-stream-pool-size (default 200)
  • metric: vttablet_stream_conn_pool_capacity
  • Potentially uses --db_app_user, --db_dba_user and --db_appdebug_user i.e. defaults 'vt_app', 'vt_dba' and 'vt_appdebug'
  • Used as vttablet query engine streaming connections pool. All streaming queries that are not transactional should use this pool.

dba_conn_pool #

  • Max size controlled by: --dba_pool_size (default 20)
  • metric: vttablet_dba_conn_pool_capacity
  • vttablet user flag: --db_dba_user (default 'vt_dba')
  • Used by vttablet ExecuteFetchAsDba RPC. This is used when using vtctlclient ExecuteFetchAsDba Also used implicitly for various internal Vitess maintenance tasks (e.g. schema reloads, etc.)

app_conn_pool #

  • Max size controlled by: --app_pool_size (default 40)
  • metric: vttablet_app_conn_pool_capacity
  • vttablet user flag: --db_app_user default 'vt_app')
  • Used by vttablet ExecuteFetchAsApp RPC. This is used when using vtctlclient ExecuteFetchAsApp

tx_read_pool #

  • Hardcoded (size 3)
  • metric: vttablet_tx_read_pool_capacity
  • vttablet user flag: --db_dba_user (default 'vt_dba')
  • Used in the (non-default) TWOPC transaction_mode for metadata state management.
    This pool will always be empty unless TWOPC is used.

Pools associated with online DDL #

online_ddl_executor_pool #

  • Hardcoded (size 3)
  • metric: vttablet_online_ddl_executor_pool_capacity
  • Potentially uses --db_app_user, --db_dba_user and --db_appdebug_user i.e. defaults 'vt_app', 'vt_dba' and 'vt_appdebug'
  • Used in Online DDL to during the actual process of running gh-ost or pt-osc.

table_gc_pool #

  • Hardcoded (default 2)
  • metric: vttablet_table_gc_pool_capacity
  • Potentially uses --db_app_user, --db_dba_user and --db_appdebug_user i.e. defaults 'vt_app', 'vt_dba' and 'vt_appdebug'
  • Used in Online DDL to purge/evac/drop origin tables after Online DDL operations from them have been completed.

Other DB connections used without pools: #

vttablet user flag: #

--db_allprivs_user #

  • (default 'vt_allprivs')
  • Created on demand by vtctlclient ExecuteFetchAsAllPrivs

--db_erepl_user #

  • (default 'vt_erepl')
  • Used only if you setup replication explicitly from an external MySQL instance without front-ending that instance with a tablet. This user is then used to login to the external MySQL.

--db_repl_user #

  • (default 'vt_repl')
  • Used to setup MySQL replication between shard primary and replica instance types.

--db_filtered_user #

  • (default 'vt_filtered')
  • Used by VReplication on the source (vstreamer) and target (vplayer) side when copying data.

vttablet user limit #

Flag: --transaction_limit_per_user

  • (default 0.4)
  • This flag determines the fraction of connections in the transaction_pool and found_rows_pool that can be used by a single user. The username is passed to vttablet from vtgate.
    If you are using a limited set of users, you may want to increase this limit.
    Or disable this limit feature by setting --transaction_limit_by_username to false as the default is true. This option only comes into play if the TX limiter is enabled by --enable_transaction_limit, which it is not by default.

vtgate system settings #

Flag: --enable_system_settings

This vtgate flag allows clients to modify a subset of system settings on the MySQL. This is done using the mechanism of reserved connection. Once a reserved connection is created, it lives for the life of the vtgate client session. These connections live outside of the regular connection pool and as a result, the number of MySQL server connections used by vttablet may become significantly higher than what you might expect based on the pool settings.

vttablet settings pool #

Flag: --queryserver-enable-settings-pool

This vttablet flag enables pooling of connections with modified settings. This overcomes the issue described with the number of MySQL connections in vtgate system settings. Both these flags should be enabled for clients to be able to modify system settings without foregoing the benefits of connection pooling.

Calculating maximum db connections used by vttablet #

You can use the following formula to approximate the maximum MySQL connections per vttablet instance:

    --queryserver-config-transaction-cap x 2  (transaction_pool and found_rows_pool)
  + --queryserver-config-pool-size            (conn_pool)
  + --queryserver-config-stream-pool-size     (stream_conn_pool)
  + --dba_pool_size                           (dba_conn_pool)
  + --app_pool_size                           (app_conn_pool)
  + 3                                        (tx_read_pool, hardcoded)
  + 7                                        (online DDL)
  + variable                                 (on demand:  for vreplication, MySQL replication, etc;  should < 10)
  + variable                                 (reserved connections used by `enable_system_settings`)
Note that most servers will not use this many connections, since most workloads do not exercise all the pools.
VTTablet Connection Pools and Sizing