yb-tserver
Logging options
Raft options
Write ahead log (WAL) options
Geo-distribution options
YSQL options
YCQL options
YEDIS options
- —redis_proxy_bind_address
- —redis_proxy_webserver_port
Performance options
Security options
Change data capture (CDC) options
Admin UI

yb-tserver

Use the yb-tserver binary and its options to configure the YB-TServer server. The yb-tserver executable file is located in the bin directory of YugabyteDB home.

Syntax

yb-tserver [ options ]

Example

$ ./bin/yb-tserver \
--tserver_master_addrs 172.151.17.130:7100,172.151.17.220:7100,172.151.17.140:7100 \
--rpc_bind_addresses 172.151.17.130 \
--start_pgsql_proxy \
--fs_data_dirs "/home/centos/disk1,/home/centos/disk2" &

Online help

To display the online help, run yb-tserver —help from the YugabyteDB home directory.

$ ./bin/yb-tserver --help

Help options

—help

Displays help on all options.

—helpon

Displays help on modules named by the specified option (or flag) value.

General options

—flagfile

Specifies the file to load the configuration options (or flags) from. The configuration settings, or flags, must be in the same format as supported by the command line options.

—version

Shows version and build info, then exits.

—tserver_master_addrs

Specifies a comma-separated list of all the yb-master RPC addresses.

Required.

Default: 127.0.0.1:7100

NoteThe number of comma-separated values should match the total number of YB-Master servers (or the replication factor).

—fs_data_dirs

Specifies a comma-separated list of mount directories, where yb-tserver will add a yb-data/tserver data directory, tserver.err, tserver.out, and pg_data directory.

Required.

—fs_wal_dirs

Specifies a comma-separated list of directories, where yb-tserver will store write-ahead (WAL) logs. This can be the same as one of the directories listed in —fs_data_dirs, but not a subdirectory of a data directory.

Default: Same value as —fs_data_dirs

—max_clock_skew_usec

Specifies the expected maximum clock skew, in microseconds (µs), between any two nodes in your deployment.

Default: 50000 (50,000 µs = 50ms)

—rpc_bind_addresses

Specifies the comma-separated list of the network interface addresses to bind to for RPC connections. Typically, the value is set to the private IP address of the host on which the server is running. When using the default, or explicitly setting the value to 0.0.0.0:9100, the server will listen on all available network interfaces.

Default: 0.0.0.0:9100

NoteIn cases where rpc_bind_addresses is set to 0.0.0.0 (or not explicitly set, and uses the default) or in cases involving public IP addresses, make sure that server_broadcast_addresses is correctly set.

—server_broadcast_addresses

Specifies the public IP or DNS hostname of the server (with an optional port). This value is used by servers to communicate with one another, depending on the connection policy parameter.

Default: 0.0.0.0:9100

—use_private_ip

Specifies the policy that determines when to use private IP addresses for inter-node communication. Possible values are never (default),zone,cloud and region. Based on the values of the placement (—placement_*) configuration options.

Valid values for the policy are:

never — Always use the —server_broadcast_addresses.
zone — Use the private IP inside a zone; use the —server_broadcast_addresses outside the zone.
region — Use the private IP address across all zone in a region; use —server_broadcast_addresses outside the region.

Default: never

—webserver_interface

The address to bind for the web server user interface.

Default: 0.0.0.0 (127.0.0.1)

—webserver_port

The port for monitoring the web server.

Default: 9000

—webserver_doc_root

The monitoring web server home directory..

Default: The www directory in the YugabyteDB home directory.

Logging options

—log_dir

The directory to write yb-tserver log files.

Default: Same as —fs_data_dirs

—logemaillevel

Email log messages logged at this level, or higher. Values: 0 (all), 1, 2, 3 (FATAL), 999 (none)

Default: 999

—logmailer

The mailer used to send logging email messages.

Default: `“/bin/mail”

—logtostderr

Write log messages to stderr instead of logfiles.

Default: false

—max_log_size

The maximum log size, in megabytes (MB). A value of 0 will be silently overridden to 1.

Default: 1800 (1.8 GB)

—minloglevel

The minimum level to log messages. Values are: 0 (INFO), 1, 2, 3 (FATAL).

Default: 0 (INFO)

—stderrthreshold

Log messages at, or above, this level are copied to stderr in addition to log files.

Default: 2

—stop_logging_if_full_disk

Stop attempting to log to disk if the disk is full.

Default: false

Raft options

NoteEnsure that values used for Raft and the write ahead log (WAL) in yb-tserver configurations match the values in yb-master configurations.

—follower_unavailable_considered_failed_sec

The duration, in seconds, after which a follower is considered to be failed because the leader has not received a heartbeat. The follower is then evicted from the configuration and the data is rereplicated elsewhere.

Default: 900 (15 minutes)

ImportantThe —follower_unavailable_considered_failed_sec value should match the value for —log_min_seconds_to_retain.

—leader_failure_max_missed_heartbeat_periods

The maximum heartbeat periods that the leader can fail to heartbeat in before the leader is considered to be failed. The total failure timeout, in milliseconds (ms), is —raft_heartbeat_interval_ms multiplied by —leader_failure_max_missed_heartbeat_periods.

For read replica clusters, set the value to 10 in all yb-tserver and yb-master configurations. Because the the data is globally replicated, RPC latencies are higher. Use this option to increase the failure detection interval in such a higher RPC latency deployment.

Default: 6

—raft_heartbeat_interval_ms

The heartbeat interval, in milliseconds (ms), for Raft replication. The leader produces heartbeats to followers at this interval. The followers expect a heartbeat at this interval and consider a leader to have failed if it misses several in a row.

Default: 500

Write ahead log (WAL) options

NoteEnsure that values used for the write ahead log (WAL) in yb-tserver configurations match the values for yb-master configurations.

—fs_wal_dirs

The directory where the yb-tserver retains WAL files. May be the same as one of the directories listed in —fs_data_dirs, but not a subdirectory of a data directory.

Default: Same as —fs_data_dirs

—durable_wal_write

If set to false, the writes to the WAL are synced to disk every interval_durable_wal_write_ms milliseconds (ms) or every bytes_durable_wal_write_mb megabyte (MB), whichever comes first. This default setting is recommended only for multi-AZ or multi-region deployments where the availability zones (AZs) or regions are independent failure domains and there is not a risk of correlated power loss. For single AZ deployments, this option should be set to true.

Default: false

—interval_durable_wal_write_ms

When —durable_wal_write is false, writes to the WAL are synced to disk every —interval_durable_wal_write_ms or —bytes_durable_wal_write_mb, whichever comes first.

Default: 1000

—bytes_durable_wal_write_mb

When —durable_wal_write is false, writes to the WAL are synced to disk every —bytes_durable_wal_write_mb or —interval_durable_wal_write_ms, whichever comes first.

Default: 1

—log_min_seconds_to_retain

The minimum duration, in seconds, to retain WAL segments, regardless of durability requirements. WAL segments can be retained for a longer amount of time, if they are necessary for correct restart. This value should be set long enough such that a tablet server which has temporarily failed can be restarted within the given time period.

Default: 900 (15 minutes)

—log_min_segments_to_retain

The minimum number of WAL segments (files) to retain, regardless of durability requirements. The value must be at least 1.

Default: 2

—log_segment_size_mb

The size, in megabytes (MB), of a WAL segment (file). When the WAL segment reaches the specified size, then a log rollover occurs and a new WAL segment file is created.

Default: 64

Geo-distribution options

Settings related to managing geo-distributed clusters.

—placement_zone

The name of the availability zone, or rack, where this instance is deployed.

Default: rack1

—placement_region

Specifies the name of the region, or data center, where this instance is deployed.

Default: datacenter1

—placement_cloud

Specifies the name of the cloud where this instance is deployed.

Default: cloud1

YSQL options

The following options, or flags, support the use of the YSQL API.

—enable_ysql

Enables the YSQL API. Replaces the deprecated —start_pgsql_proxy option.

Default: true

—ysql_enable_auth

Enables YSQL authentication.

Note

Yugabyte 2.0: Assign a password for the default yugabyte user to be able to sign in after enabling YSQL authentication.

Yugabyte 2.0.1: When YSQL authentication is enabled, you can sign into ysqlsh using the default yugabyte user that has a default password of `yugabyte”.

Default: false

—pgsql_proxy_bind_address

Specifies the TCP/IP bind addresses for the YSQL API. The default value of 0.0.0.0:5433 allows listening for all IPv4 addresses access to localhost on port 5433. The —pgsql_proxy_bind_address value overwrites listen_addresses (default value of 127.0.0.1:5433) that controls which interfaces accept connection attempts.

To specify fine-grained access control over who can access the server, use —ysql_hba_conf.

Default: 0.0.0.0:5433

NoteWhen using local YugabyteDB clusters built using the

—pgsql_proxy_webserver_port

Specifies the web server port for YSQL metrics monitoring.

Default: 13000

—ysql_hba_conf

Specifies a comma-separated list of PostgreSQL client authentication settings that is written to the ysql_hba.conf file.

For details on using —ysql_hba_conf to specify client authentication, see Fine-grained authentication.

Default: "host all all 0.0.0.0/0 trust,host all all ::0/0 trust"

—ysql_pg_conf

Comma-separated list of PostgreSQL setting assignments.

—ysql_timezone

Specifies the time zone for displaying and interpreting timestamps.

Default: Uses the YSQL time zone.

—ysql_datestyle

Specifies the display format for data and time values.

Default: Uses the YSQL display format.

—ysql_max_connections

Specifies the maximum number of concurrent YSQL connections.

Default: 300

—ysql_default_transaction_isolation

Specifies the default transaction isolation level.

Valid values: READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, and SERIALIZABLE.

Default: READ COMMITTED (implemented in YugabyteDB as REPEATABLE READ)

NoteYugabyteDB supports two transaction isolation levels: REPEATABLE READ (aka snapshot) and SERIALIZABLE. The transaction isolation levels of READ UNCOMMITTED and READ COMMITTED are implemented in YugabyteDB as REPEATABLE READ.

—ysql_log_statement

Specifies the types of YSQL statements that should be logged.

Valid values: none (off), ddl (only data definition queries, such as create/alter/drop), mod (all modifying/write statements, includes DDLs plus insert/update/delete/trunctate, etc), and all (all statements).

Default: none

—ysql_log_min_messages

Specifies the lowest YSQL message level to log.

YCQL options

The following options, or flags, support the use of the YCQL API.

—use_cassandra_authentication

Specify true to enable YCQL authentication (username and password), enable YCQL security statements (CREATE ROLE, DROP ROLE, GRANT ROLE, REVOKE ROLE, GRANT PERMISSION, and REVOKE PERMISSION), and enforce permissions for YCQL statements.

Default: false

—cql_proxy_bind_address

Specifies the bind address for the YCQL API.

Default: 0.0.0.0:9042 (127.0.0.1:9042)

—cql_proxy_webserver_port

Specifies the port for monitoring YCQL metrics.

Default: 12000

—cql_table_is_transactional_by_default

Specifies if YCQL tables are created with transactions enabled by default.

Default: false

YEDIS options

The following options, or flags, support the use of the YEDIS API.

—redis_proxy_bind_address

Specifies the bind address for the YEDIS API.

Default: 0.0.0.0:6379

—redis_proxy_webserver_port

Specifies the port for monitoring YEDIS metrics.

Default: 11000

Performance options

—enable_ondisk_compression

Enable Snappy compression at the the cluster level.

Default: true

—rocksdb_compact_flush_rate_limit_bytes_per_sec

Used to control rate of memstore flush and SSTable file compaction.

Default: 256MB

—rocksdb_universal_compaction_min_merge_width

Compactions run only if there are at least rocksdb_universal_compaction_min_merge_width eligible files andtheir running total (summation of size of files considered so far) iswithin rocksdb_universal_compaction_size_ratio of the next file in consideration to be included into the same compaction.

Default: 4

—rocksdb_universal_compaction_size_ratio

Default: 20

—timestamp_history_retention_interval_sec

The time interval, in seconds, to retain history/older versions of data. Point-in-time reads at a hybrid time prior to this intervalmight not be allowed after a compaction and return a Snapshot too old error.Set this to be greater than the expected maximum duration of any single transaction in your application.

Default: 120

—remote_bootstrap_rate_limit_bytes_per_sec

Rate control across all tablets being remote bootstrapped from or to this process.

Default: 256MB

—yb_num_shards_per_tserver

The number of shards per YB-TServer per table when a user table is created.

Default: Server automatically picks a valid default internally, typically 8.

Security options

For details on enabling client-server encryption, see Client-server encryption.

—certs_dir

Directory that contains certificate authority, private key, and certificates for this server.

Default: "" (Uses <data drive>/yb-data/tserver/data/certs.)

—allow_insecure_connections

Allow insecure connections. Set to false to prevent any process with unencrypted communication from joining a cluster. Note that this option requires the use_node_to_node_encryption to be enabled and use_client_to_server_encryption to be enabled.

Default: true

—certs_for_client_dir

The directory that contains certificate authority, private key, and certificates for this server that should be used for client-to-server communications.

Default: "" (Use the same directory as for server-to-server communications.)

—dump_certificate_entries

Dump certificate entries.

Default: false

—use_client_to_server_encryption

Use client-to-server, or client-server, encryption with YCQL.

Default: false

—use_node_to_node_encryption

Enable server-server, or node-to-node, encryption between YugabyteDB YB-Master and YB-TServer servers in a cluster or universe. To work properly, all YB-Master servers must also have their —use_node_to_node_encryption setting enabled. When enabled, then —allow_insecure_connections must be disabled.

Default: false