Reference on PIG.CENTER

pgBadger 13.x Release Notes

Mon, 01 Jan 0001 00:00:00 +0000

These entries preserve the complete upstream change record for pgBadger 13.x, newest first.

v13.2 · 2025-12-29

This is a maintenance release of pgBadger that fixes issues and applied patches reported by users since last release.

Fix normalization that was not handling properly balanced single-quoted strings along with escaped quotes inside. Thanks to Bertrand Bourgier for the report.
Fix placeholder requirements in the doc.
Fix case where no error sample log entries was reported. Thanks to john doe for the report.
Fix possible precedence problem between ! and %s. Thanks to Luca Santarelli and Philipp Trulson for the report.
Update pgFormatter code to v5.9
Add github CI action for testing on commit push.
Fix parsing of %r placeholder in log_line_prefix. Thanks to nike7o0 for the report.
Fix uninitialized value warning. Thanks to Ales Zeleny for the report.
Enhance docs of ssh-options for postgres log parsing with examples. Thanks to Ulrich Konrad for the patch.
Add command –ssh-sudo to run commands over ssh as sudo. Thanks to Andrew Jackson for the patch.
Fix possible precedence problem between ! and string eq. Thanks to Adrien Nayrat for the report.
Fix parsing of pgbouncer stats. Thanks to mrgtt for the report.

v13.1 · 2025-03-16

This is a maintenance release of pgBadger that fixes issues reported by users since last release and adds some new features:

Annotate Command (annotate)

Mon, 01 Jan 0001 00:00:00 +0000

Annotations included with the backup command can be added, modified, or removed afterwards using the annotate command.

Command Options

Backup Annotation Option (`--annotation`)

Annotate backup with user-defined key/value pairs.

Users can attach informative key/value pairs to the backup. This option may be used multiple times to attach multiple annotations.

Annotations are output by the info command text output when a backup is specified with --set and always appear in the JSON output.

Dynamic Configuration Settings

Mon, 01 Jan 0001 00:00:00 +0000

Dynamic configuration is stored in the DCS (Distributed Configuration Store) and applied on all cluster nodes.

In order to change the dynamic configuration you can use either patronictl_edit_config tool or Patroni REST API .

loop_wait: the number of seconds the loop will sleep. Default value: 10, minimum possible value: 1
ttl: the TTL to acquire the leader lock (in seconds). Think of it as the length of time before initiation of the automatic failover process. Default value: 30, minimum possible value: 20
retry_timeout: timeout for DCS and PostgreSQL operation retries (in seconds). DCS or network issues shorter than this will not cause Patroni to demote the leader. Default value: 10, minimum possible value: 3

Warning

when changing values of loop_wait, retry_timeout, or ttl you have to follow the rule:

News

Mon, 01 Jan 0001 00:00:00 +0000

pgBackRest 2.59.1 Released

August 17, 2026

The pgBackRest community is pleased to announce the release of pgBackRest 2.59.1, the latest version of the reliable, easy-to-use backup and restore solution that can seamlessly scale up to the largest databases and workloads.

pgBackRest supports a robust set of features for managing your backup and recovery infrastructure, including: parallel backup/restore, full/differential/incremental backups, block incremental backup, multiple repositories, delta restore, parallel asynchronous archiving, malware/ransomware protection, per-file checksums, page checksums (when enabled) validated during backup, multiple compression types, encryption, partial/failed backup resume, backup from standby, tablespace and link support, S3/Azure/GCS/SFTP support, backup expiration, local/remote operation via SSH or TLS, flexible configuration, and more.

YAML Configuration Settings

Mon, 01 Jan 0001 00:00:00 +0000

Global/Universal

thread_pool_size: size of thread pool used by Patroni to execute asynchronous tasks and communicate via REST API with other members during leader race or failsafe checks. Minimal value is 5, default value is 5.
thread_stack_size: specifies the stack size to be used for threads started by Patroni. Value must be aligned by 64kB. Minimal value is 64kB, default value (set by Patroni) is 512kB.
name: the name of the host. Must be unique for the cluster. The value __patroni_strict_sync_replica_placeholder__ is reserved for internal use by Patroni and cannot be used as a node name.
namespace: path within the configuration store where Patroni will keep information about the cluster. Default value: “/service”
scope: cluster name

pgBadger 12.x Release Notes

Mon, 01 Jan 0001 00:00:00 +0000

These entries preserve the complete upstream change record for pgBadger 12.x, newest first.

v12.4 · 2023-12-25

This is a maintenance release of pgBadger that fixes issues reported by users since last release.

Fix pgbouncer report with version 1.21. Thanks to Ales Zeleny for the patch.
Prevent parallelism perl file to be higher than the number of files. Thanks to maliangzhu for the report.
Fix regression test broken since v12.3. Thanks to ieshin for the report.
Fix cases where LOG entries where counted as ERROR log level entries. Thanks to Matti Linnanvuori for the report.

v12.3 · 2023-11-27

This is a maintenance release of pgBadger that fixes issues reported by users since last release. It also adds some new features:

Archive Get Command (archive-get)

Mon, 01 Jan 0001 00:00:00 +0000

This command is used by PostgreSQL to restore a backup, perform PITR, or as an alternative to streaming for keeping a replica up to date. WAL segments are required for PostgreSQL recovery or to maintain a replica.

When multiple repositories are configured, WAL will be fetched from the repositories in priority order (e.g. repo1, repo2, etc.). In general it is better if faster/cheaper storage has higher priority. If a repository is specified with the --repo option then only that repository will be searched.

Configuration: pgbouncer.ini

Mon, 01 Jan 0001 00:00:00 +0000

Description

The configuration file is in “ini” format. Section names are between [ and ]. Lines starting with ; or # are taken as comments and ignored. The characters ; and # are not recognized as special when they appear later in the line.

Generic settings

logfile

Specifies the log file. For daemonization (-d), either this or syslog need to be set.

pgBadger 11.x Release Notes

Mon, 01 Jan 0001 00:00:00 +0000

These entries preserve the complete upstream change record for pgBadger 11.x, newest first.

v11.8 · 2022-04-08

This release of pgBadger fix some issues reported by users since past three months and especially two fixes on new log entries detection in incremental mode.

Fix detection of new log entries with timestamp when millisecond (%m) or epoch (%n) was used in log_line_prefix.
Fix detection of new log entries in local file when multiprocess was not used.

Here is the complete list of changes and acknowledgments:

Archive Push Command (archive-push)

Mon, 01 Jan 0001 00:00:00 +0000

Accepts a WAL segment from PostgreSQL and archives it in each repository defined by the indexed repo-path option (see the Repository section for information on configuring repositories). The WAL segment may be pushed immediately to the archive or stored locally depending on the value of archive-async. With multiple repositories configured, archive-push will attempt to push to as many repositories as possible.

The archive-push is intended to be configured and called by PostgreSQL. See Configure Archiving for an example.

Command-Line Reference

Mon, 01 Jan 0001 00:00:00 +0000

This page preserves the command reference generated from the pinned upstream source. Option names and help text remain verbatim so they can be compared directly with pgbadger --help.

Usage and options

Usage: pgbadger [options] logfile […]

PostgreSQL log analyzer with fully detailed reports and graphs.

Arguments:

logfile can be a single log file, a list of files, or a shell command
returning a list of files. If you want to pass log content from stdin
use - as filename. Note that input from stdin will not work with csvlog.

Options:

Environment Configuration Settings

Mon, 01 Jan 0001 00:00:00 +0000

It is possible to override some of the configuration parameters defined in the Patroni configuration file using the system environment variables. This document lists all environment variables handled by Patroni. The values set via those variables always take precedence over the ones set in the Patroni configuration file.

Global/Universal

PATRONI_CONFIGURATION: it is possible to set the entire configuration for the Patroni via PATRONI_CONFIGURATION environment variable. In this case any other environment variables will not be considered!
PATRONI_THREAD_POOL_SIZE: size of thread pool used by Patroni to execute asynchronous tasks and communicate via REST API with other members during leader race or failsafe checks. Minimal value is 5, default value is 5.
PATRONI_THREAD_STACK_SIZE: specifies the stack size to be used for threads started by Patroni. Value must be aligned by 64kB. Minimal value is 64kB, default value (set by Patroni) is 512kB.
PATRONI_NAME: name of the node where the current instance of Patroni is running. Must be unique for the cluster. The value __patroni_strict_sync_replica_placeholder__ is reserved for internal use by Patroni and cannot be used as a node name.
PATRONI_NAMESPACE: path within the configuration store where Patroni will keep information about the cluster. Default value: “/service”
PATRONI_SCOPE: cluster name
PG_MALLOC_ARENA_MAX: custom value for MALLOC_ARENA_MAX environment variable for postmaster process. If not set, postmaster will inherit MALLOC_ARENA_MAX value.

Log

PATRONI_LOG_TYPE: sets the format of logs. Can be either plain or json. To use json format, you must have the jsonlogger installed. The default value is plain.
PATRONI_LOG_LEVEL: sets the general logging level. Default value is INFO (see the docs for Python logging )
PATRONI_LOG_TRACEBACK_LEVEL: sets the level where tracebacks will be visible. Default value is ERROR. Set it to DEBUG if you want to see tracebacks only if you enable PATRONI_LOG_LEVEL=DEBUG.
PATRONI_LOG_FORMAT: sets the log formatting string. If the log type is plain, the log format should be a string. Refer to the LogRecord attributes for available attributes. If the log type is json, the log format can be a list in addition to a string. Each list item should correspond to LogRecord attributes. Be cautious that only the field name is required, and the %( and ) should be omitted. If you wish to print a log field with a different key name, use a dictionary where the dictionary key is the log field, and the value is the name of the field you want to be printed in the log. Default value is %(asctime)s %(levelname)s: %(message)s
PATRONI_LOG_DATEFORMAT: sets the datetime formatting string. (see the formatTime() documentation )
PATRONI_LOG_STATIC_FIELDS: add additional fields to the log. This option is only available when the log type is set to json. Example PATRONI_LOG_STATIC_FIELDS="{app: patroni}"
PATRONI_LOG_MAX_QUEUE_SIZE: Patroni is using two-step logging. Log records are written into the in-memory queue and there is a separate thread which pulls them from the queue and writes to stderr or file. The maximum size of the internal queue is limited by default by 1000 records, which is enough to keep logs for the past 1h20m.
PATRONI_LOG_DIR: Directory to write application logs to. The directory must exist and be writable by the user executing Patroni. If you set this env variable, the application will retain 4 25MB logs by default. You can tune those retention values with PATRONI_LOG_FILE_NUM and PATRONI_LOG_FILE_SIZE (see below).
PATRONI_LOG_MODE: Permissions for log files (for example, 0644). If not specified, permissions will be set based on the current umask value.
PATRONI_LOG_FILE_NUM: The number of application logs to retain.
PATRONI_LOG_FILE_SIZE: Size of patroni.log file (in bytes) that triggers a log rolling.
PATRONI_LOG_LOGGERS: Redefine logging level per python module. Example PATRONI_LOG_LOGGERS="{patroni.postmaster: WARNING, urllib3: DEBUG}"
PATRONI_LOG_DEDUPLICATE_HEARTBEAT_LOGS: If set to true, successive heartbeat logs that are identical shall not be output. Default value is false.

Warning

The time the HA loop executes at can be very valuable information in diagnosing failovers due to resource exhaustion and similar problems. When PATRONI_LOG_DEDUPLICATE_HEARTBEAT_LOGS is set to true there will be no log generated for the HA loop execution (unless the leader changes) and hence this potentially useful information will not be available from the logs.

Patroni configuration

Mon, 01 Jan 0001 00:00:00 +0000

There are 3 types of Patroni configuration:

Global dynamic configuration .
These options are stored in the DCS (Distributed Configuration Store) and applied on all cluster nodes. Dynamic configuration can be set at any time using patronictl_edit_config tool or Patroni REST API . If the options changed are not part of the startup configuration, they are applied asynchronously (upon the next wake up cycle) to every node, which gets subsequently reloaded. If the node requires a restart to apply the configuration (for PostgreSQL parameters with context postmaster, if their values have changed), a special flag pending_restart indicating this is set in the members.data JSON. Additionally, the node status indicates this by showing "restart_pending": true.

pgBadger 10.x Release Notes

Mon, 01 Jan 0001 00:00:00 +0000

These entries preserve the complete upstream change record for pgBadger 10.x, newest first.

v10.3 · 2019-02-14

This release of pgBadger is a maintenance release that fixes some log format autodetection issues another pgBouncer log parsing issue reported by users. There is also a new feature:

The -o | --outfile option can now be used multiple time to dump
output in several format in a single command. For example:
 pgbadger -o out.html -o out.json /log/pgsql-11.log
will create two reports in html and json format saved in the
two corresponding files.

There’s also some bugs fixes and features enhancements.

Backup Command (backup)

Mon, 01 Jan 0001 00:00:00 +0000

When multiple repositories are configured, pgBackRest will backup to the highest priority repository (e.g. repo1) unless the --repo option is specified.

pgBackRest does not have a built-in scheduler so it’s best to run it from cron or some other scheduling mechanism.

See Perform a Backup for more details and examples.

Command Options

Backup Annotation Option (`--annotation`)

Annotate backup with user-defined key/value pairs.

Command Reference

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Commands are used to execute the various pgBackRest functions. Here the command options are listed exhaustively, that is, each option applicable to a command is listed with that command even if it applies to one or more other commands. This includes all the options that may also be configured in pgbackrest.conf.

Non-boolean options configured in pgbackrest.conf can be reset to default on the command-line by using the reset- prefix. This feature may be used to restore a backup directly on a repository host. Normally, pgBackRest will error because it can see that the database host is remote and restores cannot be done remotely. By adding --reset-pg1-host on the command-line, pgBackRest will ignore the remote database host and restore locally. It may be necessary to pass a new --pg1-path to force the restore to happen in a specific path, i.e. not the path used on the database host.

Patroni REST API

Mon, 01 Jan 0001 00:00:00 +0000

Patroni has a rich REST API, which is used by Patroni itself during the leader race, by the patronictl tool in order to perform failovers/switchovers/reinitialize/restarts/reloads, by HAProxy or any other kind of load balancer to perform HTTP health checks, and of course could also be used for monitoring. Below you will find the list of Patroni REST API endpoints.

Health check endpoints

For all health check GET requests Patroni returns a JSON document with the status of the node, along with the HTTP status code. If you don’t want or don’t need the JSON document, you might consider using the HEAD or OPTIONS method instead of GET.

pgBadger 9.x Release Notes

Mon, 01 Jan 0001 00:00:00 +0000

These entries preserve the complete upstream change record for pgBadger 9.x, newest first.

v9.2 · 2017-07-27

This release of pgBadger is a maintenance release that adds some new features.

Add report of checkpoint distance and estimate.
Add support of AWS Redshift keywords to SQL code beautifier.
Add autodetection of log format in remote mode to allow remote parsing of pgbouncer log file together with PostgreSQL log file.

There’s also some bugs fixes and features enhancements.

Check Command (check)

Mon, 01 Jan 0001 00:00:00 +0000

The check command validates that pgBackRest and the archive_command setting are configured correctly for archiving and backups for the specified stanza. It will attempt to check all repositories and databases that are configured for the host on which the command is run. It detects misconfigurations, particularly in archiving, that result in incomplete backups because required WAL segments did not reach the archive. The command can be run on the PostgreSQL or repository host. The command may also be run on the standby host, however, since pg_switch_xlog()/pg_switch_wal() cannot be performed on the standby, the command will only test the repository configuration.

Configuration Reference

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

pgBackRest can be used entirely with command-line parameters but a configuration file is more practical for installations that are complex or set a lot of options. The default location for the configuration file is /etc/pgbackrest/pgbackrest.conf. If no file exists in that location then the old default of /etc/pgbackrest.conf will be checked.

The following option types are used:

String: A text string, commonly an identifier, password, etc.

Source Releases Download

Mon, 01 Jan 0001 00:00:00 +0000

PgBouncer 1.25

File	Date	Size	SHA256
pgbouncer-1.25.2.tar.gz	2026-05-08	865371 bytes	sha256
pgbouncer-1.25.1.tar.gz	2025-12-03	864801 bytes	sha256
pgbouncer-1.25.0.tar.gz	2025-11-09	863322 bytes	sha256

PgBouncer 1.24

File	Date	Size	SHA256
pgbouncer-1.24.1.tar.gz	2025-04-16	717796 bytes	sha256
pgbouncer-1.24.0.tar.gz	2025-01-10	706573 bytes	sha256

PgBouncer 1.23

File	Date	Size	SHA256
pgbouncer-1.23.1.tar.gz	2024-08-02	700025 bytes	sha256
pgbouncer-1.23.0.tar.gz	2024-07-03	694845 bytes	sha256

PgBouncer 1.22

File	Date	Size	SHA256
pgbouncer-1.22.1.tar.gz	2024-03-04	677351 bytes	sha256
pgbouncer-1.22.0.tar.gz	2024-01-31	670589 bytes	sha256

PgBouncer 1.21

File	Date	Size	SHA256
pgbouncer-1.21.0.tar.gz	2023-10-16	668211 bytes	sha256

PgBouncer 1.20

File	Date	Size	SHA256
pgbouncer-1.20.1.tar.gz	2023-08-09	638844 bytes	sha256
pgbouncer-1.20.0.tar.gz	2023-07-20	638020 bytes	sha256

PgBouncer 1.19

File	Date	Size	SHA256
pgbouncer-1.19.1.tar.gz	2023-05-31	623569 bytes	sha256
pgbouncer-1.19.0.tar.gz	2023-05-04	616947 bytes	sha256

PgBouncer 1.18

File	Date	Size	SHA256
pgbouncer-1.18.0.tar.gz	2022-12-12	600825 bytes	sha256

PgBouncer 1.17

File	Date	Size	SHA256
pgbouncer-1.17.0.tar.gz	2022-03-23	598294 bytes	sha256

PgBouncer 1.16

File	Date	Size	SHA256
pgbouncer-1.16.1.tar.gz	2021-11-11	591450 bytes	sha256
pgbouncer-1.16.0.tar.gz	2021-08-09	592136 bytes	sha256

PgBouncer 1.15

File	Date	Size	SHA256
pgbouncer-1.15.0.tar.gz	2020-11-19	588042 bytes	sha256

PgBouncer 1.14

File	Date	Size	SHA256
pgbouncer-1.14.0.tar.gz	2020-06-11	578955 bytes	sha256

PgBouncer 1.13

File	Date	Size	SHA256
pgbouncer-1.13.0.tar.gz	2020-04-27	574955 bytes	sha256

PgBouncer 1.12

File	Date	Size	SHA256
pgbouncer-1.12.0.tar.gz	2019-10-17	567465 bytes	sha256

PgBouncer 1.11

File	Date	Size	SHA256
pgbouncer-1.11.0.tar.gz	2019-08-27	571414 bytes	sha256

PgBouncer 1.10

File	Date	Size	SHA256
pgbouncer-1.10.0.tar.gz	2019-07-01	480571 bytes	sha256

PgBouncer 1.9

File	Date	Size	SHA256
pgbouncer-1.9.0.tar.gz	2018-08-13	469300 bytes	sha256

PgBouncer 1.8

File	Date	Size	SHA256
pgbouncer-1.8.1.tar.gz	2017-12-20	465930 bytes	sha256
pgbouncer-1.8.tar.gz	2017-12-19	465612 bytes	sha256

PgBouncer 1.7

File	Date	Size	SHA256
pgbouncer-1.7.2.tar.gz	2016-02-26	462374 bytes	sha256
pgbouncer-1.7.1.tar.gz	2016-02-18	461903 bytes	sha256
pgbouncer-1.7.tar.gz	2015-12-18	459080 bytes	sha256

PgBouncer 1.6

File	Date	Size	SHA256
pgbouncer-1.6.1.tar.gz	2015-09-03	431076 bytes	sha256
pgbouncer-1.6.tar.gz	2015-08-01	412700 bytes	sha256

PgBouncer 1.5

File	Date	Size	SHA256
pgbouncer-1.5.5.tar.gz	2015-04-09	336145 bytes	sha256
pgbouncer-1.5.4.tar.gz	2012-11-28	339610 bytes	sha256
pgbouncer-1.5.3.tar.gz	2012-09-12	339013 bytes	sha256
pgbouncer-1.5.2.tar.gz	2012-05-29	335338 bytes	sha256
pgbouncer-1.5.1.tar.gz	2012-04-17	334413 bytes	sha256
pgbouncer-1.5.tar.gz	2012-01-05	411488 bytes	sha256

PgBouncer 1.4

File	Date	Size	SHA256
pgbouncer-1.4.2.tgz	2011-06-16	283204 bytes	sha256
pgbouncer-1.4.1.tgz	2011-04-01	282728 bytes	sha256
pgbouncer-1.4.tgz	2011-01-11	231691 bytes	sha256

PgBouncer 1.3

File	Date	Size	SHA256
pgbouncer-1.3.4.tgz	2010-09-09	167957 bytes	sha256
pgbouncer-1.3.3.tgz	2010-05-10	167476 bytes	sha256
pgbouncer-1.3.2.tgz	2010-03-15	166756 bytes	sha256
pgbouncer-1.3.1.tgz	2009-07-06	161518 bytes	sha256
pgbouncer-1.3.tgz	2009-02-18	160154 bytes	sha256

PgBouncer 1.2

File	Date	Size	SHA256
pgbouncer-1.2.3.tgz	2008-08-08	145372 bytes	sha256
pgbouncer-1.2.2.tgz	2008-08-06	145017 bytes	sha256
pgbouncer-1.2.1.tgz	2008-08-04	144903 bytes	sha256
pgbouncer-1.2.tgz	2008-07-29	143915 bytes	sha256

PgBouncer 1.1

File	Date	Size	SHA256
pgbouncer-1.1.2.tgz	2007-12-10	122054 bytes	sha256
pgbouncer-1.1.1.tgz	2007-10-26	121042 bytes	sha256
pgbouncer-1.1.tgz	2007-10-09	120462 bytes	sha256

PgBouncer 1.0

File	Date	Size	SHA256
pgbouncer-1.0.8.tgz	2007-06-18	93636 bytes	sha256
pgbouncer-1.0.7.tgz	2007-04-19	93086 bytes	sha256
pgbouncer-1.0.6.tgz	2007-04-12	92244 bytes	sha256
pgbouncer-1.0.5.tgz	2007-04-11	91934 bytes	sha256
pgbouncer-1.0.4.tgz	2007-04-11	91889 bytes	sha256
pgbouncer-1.0.3.tgz	2007-04-11	91489 bytes	sha256
pgbouncer-1.0.2.tgz	2007-03-28	90555 bytes	sha256
pgbouncer-1.0.1.tgz	2007-03-15	89609 bytes	sha256
pgbouncer-1.0.tgz	2007-03-13	88587 bytes	sha256

Binary Packages

Various OS distributions have their native package/port of PgBouncer. So it might be good to first check if it is already available on your OS.

HAProxy 3.4.4 Documentation

Mon, 01 Jan 0001 00:00:00 +0000

HAProxy is a free, fast, and reliable reverse proxy for high availability, TCP and HTTP load balancing, and application traffic management. This component contains the complete English text of the three core HAProxy 3.4 manuals, reorganized as one flat Markdown reading sequence for OINK.

Choose a manual

Starter Guide — 9 topics on load-balancing concepts, HAProxy architecture, features, sizing, releases, and ecosystem.
Configuration Manual — 12 chapters covering proxies, ACLs, samples, logging, filters, and every option family.
Management Guide — 13 chapters on startup, reloads, resources, logging, statistics, runtime CLI, debugging, and security.

Edition coverage

Manual	Upstream source	Local organization
Starter Guide	1,695 lines	9 flat topic pages
Configuration Manual	33,148 lines	12 flat chapter pages
Management Guide	5,285 lines	13 flat chapter pages

All 34 reading pages live directly under the HAProxy component root. Three non-linking divider placeholders separate the manuals in the sidebar without adding directory levels or pager stops.

patronictl

Mon, 01 Jan 0001 00:00:00 +0000

Patroni has a command-line interface named patronictl , which is used basically to interact with Patroni’s REST API and with the DCS. It is intended to make it easier to perform operations in the cluster, and can easily be used by humans or scripts.

Configuration

patronictl uses 3 sections of the configuration:

ctl: how to authenticate against the Patroni REST API, and how to validate the server identity. Refer to ctl settings for more details;
restapi: how to authenticate against the Patroni REST API, and how to validate the server identity. Only used if ctl configuration is not enough. patronictl is mainly interested in restapi.authentication section (in case ctl.authentication is missing) and restapi.cafile setting (in case ctl.cacert is missing). Refer to REST API settings for more details;
DCS (e.g. etcd): how to contact and authenticate against the DCS used by Patroni.

Those configuration options can come either from environment variables or from a configuration file. Look for the above sections in Environment Configuration Settings or YAML Configuration Settings to understand how you can set the options for them through environment variables or through a configuration file.

Expire Command (expire)

Mon, 01 Jan 0001 00:00:00 +0000

pgBackRest does full backup rotation based on the retention type which can be a count or a time period. When a count is specified, then expiration is not concerned with when the backups were created but with how many must be retained. Differential backups are count-based but will always be expired when the full backup they depend on is expired. Incremental backups are not expired by retention independently — they are always expired with their related full or differential backup. See sections Full Backup Retention and Differential Backup Retention for details and examples.

Release Notes

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

pgBackRest release numbers consist of two parts, major and minor. A major release may break compatibility with the prior major release, but v2 releases are fully compatible with v1 repositories and will accept all v1 options. Minor releases can include bug fixes and features but do not change the repository format and strive to avoid changing options and naming. Documentation for the v1 release can be found here . The notes for a release may also contain “Additional Notes” but changes in this section are only to documentation or the test suite and have no direct impact on the pgBackRest codebase.

Changelog

Mon, 01 Jan 0001 00:00:00 +0000

PgBouncer 1.25.x

2026-05-08 - PgBouncer 1.25.2 - “Human touch with fresh twist in title race full of uncertainties”

Security
- Fix CVE-2026-6664: An integer overflow in network packet parsing code in PgBouncer before 1.25.2 bypasses a boundary check and can lead to a crash. An unauthenticated remote attacker can crash PgBouncer with a malformed SCRAM authentication packet.
- Fix CVE-2026-6665: The SCRAM code in PgBouncer before 1.25.2 did not check the return value of strlcat() correctly when building the contents of the SCRAM client-final-message. A malicious backend that sends a SCRAM server-final-message with a long nonce can trigger a stack overflow.
- Fix CVE-2026-6666: A possible null pointer reference in PgBouncer before 1.25.2 could lead to a crash if a server sends an error response without an SQLSTATE field.
- Fix CVE-2026-6667: PgBouncer before 1.25.2 did not perform an appropriate authorization check for the KILL_CLIENT admin command. All users with access to the administration console, which itself requires authorization, could run this command. It should only be allowed for users listed in the admin_users parameter.
Fixes

Frequently Asked Questions

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Frequently Asked Questions are intended to provide details for specific questions that may or may not be covered in the User Guide, Configuration, or Command reference. If you are unable to find details for your specific issue here, remember that the pgBackRest Issues List in GitHub is also a valuable resource.

What if I get the “could not find WAL segment” error?

The cause of this error can be a result of many different issues, some of which may be:

Help Command (help)

Mon, 01 Jan 0001 00:00:00 +0000

Three levels of help are provided. If no command is specified then general help will be displayed. If a command is specified (e.g. pgbackrest help backup) then a full description of the command will be displayed along with a list of valid options. If an option is specified in addition to a command (e.g. pgbackrest help backup type) then a full description of the option as it applies to the command will be displayed.

Output Formats

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger selects output from the filename extension or from -x / --extension. Use -o / --outfile more than once to create multiple formats from the same parse.

Format	Typical extension	Best use
HTML	`.html`	interactive, human-readable report with charts
Text	`.txt`	terminal review and plain archival output
Binary	`.bin`	mergeable intermediate statistics and report rebuilds
JSON	`.json`	integration with other software; requires `JSON::XS`
Raw CSV	chosen output file	row-oriented extraction with `--dump-raw-csv`

HTML and text

The default output is out.html:

Sizing and Performance

Mon, 01 Jan 0001 00:00:00 +0000

Typical CPU usage figures show 15% of the processing time spent in HAProxy versus 85% in the kernel in TCP or HTTP close mode, and about 30% for HAProxy versus 70% for the kernel in HTTP keep-alive mode. This means that the operating system and its tuning have a strong impact on the global performance.

Usages vary a lot between users, some focus on bandwidth, other ones on request rate, others on connection concurrency, others on SSL performance. This section aims at providing a few elements to help with this task.

Info Command (info)

Mon, 01 Jan 0001 00:00:00 +0000

The info command operates on a single stanza or all stanzas. Text output is the default and gives a human-readable summary of backups for the stanza(s) requested. This format is subject to change with any release.

For machine-readable output use --output=json. The JSON output contains far more information than the text output and is kept stable unless a bug is found.

To speed up execution, limit the output to only progress information by specifying --detail-level=progress. Note that this skips all checks except for availability of the stanza.

Sample Reports

Mon, 01 Jan 0001 00:00:00 +0000

The example content was generated by pgBadger 11.8 in May 2022. The original examples are stored with this site, so report navigation, charts, styles, and scripts remain available without reaching the upstream server.

Example	What it demonstrates	Local copy
Complete report	PostgreSQL activity together with PgBouncer statistics	Open the complete report
Incremental report	Calendar index, weekly aggregation, and daily pages	Open the incremental index
Errors and events	A report restricted to errors and operational events	Open the error report

Complete report

The complete report is a self-contained HTML document. Use its top navigation to inspect global statistics, queries, sessions, connections, temporary files, checkpoints, autovacuum activity, locks, and PgBouncer-specific charts.

Frequently Asked Questions

Mon, 01 Jan 0001 00:00:00 +0000

How to connect to PgBouncer?

PgBouncer acts as a Postgres server, so simply point your client to the PgBouncer port.

How to load-balance queries between several servers?

PgBouncer does not have an internal multi-host configuration. It is possible via external tools:

DNS round-robin. Use several IPs behind one DNS name. PgBouncer does not look up DNS each time a new connection is launched. Instead, it caches all IPs and does round-robin internally. Note: if there are more than 8 IPs behind one name, the DNS backend must support the EDNS0 protocol. See README for details.

Release History

Mon, 01 Jan 0001 00:00:00 +0000

The official website publishes release news inline on its home page. That page stops at 12.4 and accidentally repeats 11.1–11.3 with conflicting dates. This edition uses the pinned upstream ChangeLog as the canonical record, removes only those duplicate renderings, and adds the later 13.x releases. Entries are preserved in full and ordered newest first within each series.

Series	Versions included	First–last release	Page
13.x	13.0–13.2	2024-12-08 – 2025-12-29	Read 13.x
12.x	12.0–12.4	2022-09-13 – 2023-12-25	Read 12.x
11.x	11.0–11.8	2019-06-25 – 2022-04-08	Read 11.x
10.x	10.0–10.3	2018-09-09 – 2019-02-14	Read 10.x
9.x	9.0–9.2	2016-09-02 – 2017-07-27	Read 9.x

For downloadable archives and assets, use GitHub Releases . Release dates in this section describe upstream source history; they are not the download time of this documentation snapshot.

Repository Get Command (repo-get)

Mon, 01 Jan 0001 00:00:00 +0000

Similar to the unix cat command but works on any supported repository type. This command requires a fully qualified file name and is primarily for administration, investigation, and testing. It is not a required part of a normal pgBackRest setup.

If the repository is encrypted then repo-get will automatically decrypt the file. Files are not automatically decompressed but the output can be piped through the appropriate decompression command, e.g. gzip -d.

Repository List Command (repo-ls)

Mon, 01 Jan 0001 00:00:00 +0000

Similar to the unix ls command but works on any supported repository type. This command accepts a path, absolute or relative to the repository path defined by the --repo-path option, and is primarily for administration, investigation, and testing. It is not a required part of a normal pgBackRest setup.

The default text output prints one file name per line. JSON output is available by specifying --output=json.

If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the --repo option is specified.

Documentation and Community

Mon, 01 Jan 0001 00:00:00 +0000

1. Available documentation

The complete HAProxy documentation is contained in the following documents. Please ensure to consult the relevant documentation to save time and to get the most accurate response to your needs. Also please refrain from sending questions to the mailing list whose responses are present in these documents.

intro.txt (this document): it presents the basics of load balancing, HAProxy as a product, what it does, what it doesn’t do, some known traps to avoid, some OS-specific limitations, how to get it, how it evolves, how to ensure you’re running with all known fixes, how to update it, complements and alternatives.

License and Credits

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger is free and open-source software distributed under the PostgreSQL License. It may be used, copied, modified, and distributed without a fee, subject to retaining the copyright and license notices.

PostgreSQL License

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.

Restore Command (restore)

Mon, 01 Jan 0001 00:00:00 +0000

The restore command automatically defaults to selecting the latest backup from the first repository where backups exist (see Quick Start - Restore a Backup ). The order in which the repositories are checked is dictated by the pgbackrest.conf (e.g. repo1 will be checked before repo2). To select from a specific repository, the --repo option can be passed (e.g. --repo=1). The --set option can be passed if a backup other than the latest is desired.

Server Command (server)

Mon, 01 Jan 0001 00:00:00 +0000

The pgBackRest server allows access to remote hosts without using the SSH protocol.

Command Options

TLS Server Address Option (`--tls-server-address`)

TLS server address.

IP address the server will listen on for client requests.

default: localhost
example: --tls-server-address=*

TLS Server Authorized Clients Option (`--tls-server-auth`)

TLS server authorized clients.

Clients are authorized on the server by verifying their certificate and checking their certificate CN (Common Name) against a list on the server configured with the tls-server-auth option.

2. Configuring HAProxy

Mon, 01 Jan 0001 00:00:00 +0000

2.1. Configuration file format

HAProxy’s configuration process involves 3 major sources of parameters:

the arguments from the command-line, which always take precedence
the configuration file(s), whose format is described here
the running process’s environment, in case some environment variables are explicitly referenced

The configuration file follows a fairly simple hierarchical format which obey a few basic rules:

Server Ping Command (server-ping)

Mon, 01 Jan 0001 00:00:00 +0000

Ping a pgBackRest TLS server to ensure it is accepting connections. This serves as an aliveness check only since no authentication is attempted.

If no host is specified on the command-line then the tls-server-host option will be used.

Command Options

TLS Server Address Option (`--tls-server-address`)

TLS server address.

IP address the server will listen on for client requests.

default: localhost
example: --tls-server-address=*

TLS Server Port Option (`--tls-server-port`)

TLS server port.

3. Global Section

Mon, 01 Jan 0001 00:00:00 +0000

Parameters in the “global” section are process-wide and often OS-specific. They are generally set once for all and do not need being changed once correct. Some of them have command-line equivalents.

The following keywords are supported in the “global” section:

Process management and security
- 51degrees-allow-unmatched
- 51degrees-cache-size
- 51degrees-data-file
- 51degrees-difference
- 51degrees-drift
- 51degrees-property-name-list
- 51degrees-property-separator
- 51degrees-use-performance-graph
- 51degrees-use-predictive-graph
- ca-base
- chroot
- cluster-secret
- cpu-affinity
- cpu-map
- cpu-policy
- cpu-set
- crt-base
- daemon
- default-path
- description
- deviceatlas-json-file
- deviceatlas-log-level
- deviceatlas-properties-cookie
- deviceatlas-separator
- dns-accept-family
- expose-deprecated-directives
- expose-experimental-directives
- external-check
- fd-hard-limit
- gid
- grace
- group
- h1-accept-payload-with-any-method
- h1-case-adjust
- h1-case-adjust-file
- h1-do-not-close-on-insecure-transfer-encoding
- h2-workaround-bogus-websocket-clients
- hard-stop-after
- harden.reject-privileged-ports.tcp
- harden.reject-privileged-ports.quic
- insecure-fork-wanted
- insecure-setuid-wanted
- issuers-chain-path
- jwt.decrypt_alg_list
- jwt.decrypt_enc_list
- key-base
- limited-quic
- localpeer
- log
- log-send-hostname
- log-tag
- lua-load
- lua-load-per-thread
- lua-prepend-path
- max-threads-per-group
- mworker-max-reloads
- nbthread
- node
- numa-cpu-mapping
- ocsp-update.disable
- ocsp-update.maxdelay
- ocsp-update.mindelay
- ocsp-update.httpproxy
- ocsp-update.mode
- pidfile
- pp2-never-send-local
- presetenv
- prealloc-fd
- resetenv
- set-dumpable
- set-var
- setenv
- ssl-default-bind-ciphers
- ssl-default-bind-ciphersuites
- ssl-default-bind-client-sigalgs
- ssl-default-bind-curves
- ssl-default-bind-options
- ssl-default-bind-sigalgs
- ssl-default-server-ciphers
- ssl-default-server-ciphersuites
- ssl-default-server-client-sigalgs
- ssl-default-server-curves
- ssl-default-server-options
- ssl-default-server-sigalgs
- ssl-dh-param-file
- ssl-propquery
- ssl-provider
- ssl-provider-path
- ssl-security-level
- ssl-server-verify
- ssl-skip-self-issued-ca
- stats
- stats-file
- strict-limits
- uid
- ulimit-n
- unix-bind
- unsetenv
- user
- wurfl-cache-size
- wurfl-data-file
- wurfl-information-list
- wurfl-information-list-separator
Performance tuning

Stanza Create Command (stanza-create)

Mon, 01 Jan 0001 00:00:00 +0000

The stanza-create command must be run after the stanza has been configured in pgbackrest.conf. If there is more than one repository configured, the stanza will be created on each. Stanzas that have already been created will be skipped so it is always safe to run stanza-create, even when a new repository has been configured.

See Create the Stanza for more information and an example.

Command Options

Online Option (`--online`)

Create on an online cluster.

4. Proxies

Mon, 01 Jan 0001 00:00:00 +0000

Proxy configuration can be located in a set of sections:

defaults [<name>] [ from <defaults_name> ]
frontend <name> [ from <defaults_name> ]
backend <name> [ from <defaults_name> ]
listen <name> [ from <defaults_name> ]

A “frontend” section describes a set of listening sockets accepting client connections.

A “backend” section describes a set of servers to which the proxy will connect to forward incoming connections.

Stanza Delete Command (stanza-delete)

Mon, 01 Jan 0001 00:00:00 +0000

The stanza-delete command removes data in the repository associated with a stanza.

WARNING:

Use this command with caution — it will permanently remove all backups and archives from the pgBackRest repository for the specified stanza.

To delete a stanza:

Shut down the PostgreSQL cluster associated with the stanza (or use –force to override).
Run the stop command on the host where the stanza-delete command will be run.
Run the stanza-delete command.

Once the command successfully completes, it is the responsibility of the user to remove the stanza from all pgBackRest configuration files and/or environment variables.

5. Bind and Server Options

Mon, 01 Jan 0001 00:00:00 +0000

The “bind”, “server” and “default-server” keywords support a number of settings depending on some build options and on the system HAProxy was built on. These settings generally each consist in one word sometimes followed by a value, written on the same line as the “bind” or “server” line. All these options are described in this section.

5.1. Bind options

The “bind” keyword supports a certain number of settings which are all passed as arguments on the same line. The order in which those arguments appear makes no importance, provided that they appear after the bind address. All of these parameters are optional. Some of them consist in a single words (booleans), while other ones expect a value after them. In this case, the value must be provided immediately after the setting name.

Stanza Upgrade Command (stanza-upgrade)

Mon, 01 Jan 0001 00:00:00 +0000

Immediately after upgrading PostgreSQL to a newer major version, the pg-path for all pgBackRest configurations must be set to the new database location and the stanza-upgrade command run. If there is more than one repository configured on the host, the stanza will be upgraded on each. If the database is offline use the --no-online option.

Command Options

Online Option (`--online`)

Update an online cluster.

6. Cache

Mon, 01 Jan 0001 00:00:00 +0000

HAProxy provides a cache, which was designed to perform cache on small objects (favicon, css…). This is a minimalist low-maintenance cache which runs in RAM.

The cache is based on a memory area shared between all threads, and split in 1kB blocks.

If an object is not used anymore, it can be deleted to store a new object independently of its expiration date. The oldest objects are deleted first when we try to allocate a new one.

Start Command (start)

Mon, 01 Jan 0001 00:00:00 +0000

If the pgBackRest processes were previously stopped using the stop command then they can be started again using the start command. Note that this will not immediately start up any pgBackRest processes but they are allowed to run. See Starting and Stopping for more information and examples.

General Options

Allow Run as Root Option (`--allow-root`)

Allow the command to run as the root user.

7. ACLs and Sample Fetching

Mon, 01 Jan 0001 00:00:00 +0000

HAProxy is capable of extracting data from request or response streams, from client or server information, from tables, environmental information etc… The action of extracting such data is called fetching a sample. Once retrieved, these samples may be used for various purposes such as a key to a stick-table, but most common usages consist in matching them against predefined constant data called patterns.

FAQ

Mon, 01 Jan 0001 00:00:00 +0000

In this section you will find answers for the most frequently asked questions about Patroni. Each sub-section attempts to focus on different kinds of questions.

We hope that this helps you to clarify most of your questions. If you still have further concerns or find yourself facing an unexpected issue, please refer to chatting and reporting_bugs for instructions on how to get help or report issues.

Comparison with other HA solutions

Why does Patroni require a separate cluster of DCS nodes while other solutions like repmgr do not?
There are different ways of implementing HA solutions, each of them with their pros and cons.

Stop Command (stop)

Mon, 01 Jan 0001 00:00:00 +0000

Does not allow any new pgBackRest processes to run. By default running processes will be allowed to complete successfully. Use the --force option to terminate running processes.

pgBackRest processes will return an error if they are run after the stop command completes. See Starting and Stopping for more information and examples.

Command Options

Force Option (`--force`)

Force all pgBackRest processes to stop.

Release notes

Mon, 01 Jan 0001 00:00:00 +0000

Version 4.1.5

Released 2026-08-12

Compatibility improvements

Compatibility with PostgreSQL 14.24, 15.19, 16.15, 17.11, 18.6 (Alexander Kukushkin)

Add the new output_plugin_libraries GUC, which restricts logical decoding output plugins.

Improvements

Log REST API connection resets at DEBUG instead of WARNING (Kyle McLaren)

Ensure the common “client went away mid-write” variants are silenced without affecting the handling of genuine (non-connection) errors.

Bugfixes

Fix thread_stack_size validation alignment (Sundong Kim)

Verify Command (verify)

Mon, 01 Jan 0001 00:00:00 +0000

Verify determines if the backups and archives in a repository are valid.

Command Options

Output Option (`--output`)

Output type.

The following output types are supported:

none - No verify output.
text - Output verify information to stdout.

default: none
example: --output=text

Set Option (`--set`)

Backup set to verify.

Verify all database and archive files associated with the specified backup set.

9. Supported Filters

Mon, 01 Jan 0001 00:00:00 +0000

Here are listed officially supported filters with the list of parameters they accept. Depending on compile options, some of these filters might be unavailable. The list of available filters is reported in haproxy -vv.

9.1. Trace

filter trace [name <name>] [random-forwarding] [max-fwd <max>] [hexdump]

Arguments:

<name> is an arbitrary name that will be reported in
 messages. If no name is provided, "TRACE" is used.

<quiet> inhibits trace messages.

<random-forwarding> enables the random forwarding of parsed data. By
 default, this filter forwards all previously parsed
 data. With this parameter, it only forwards a random
 amount of the parsed data.

<max> is the maximum amount of data that can be forwarded at
 a time. "max-fwd" option can be combined with the
 random forwarding. <max> must be an positive integer.
 0 means there is no limit.

<hexdump> dumps all forwarded data to the server and the client.

This filter can be used as a base to develop new filters. It defines all callbacks and print a message on the standard error stream (stderr) with useful information for all of them. It may be useful to debug the activity of other filters or, quite simply, HAProxy’s activity.

Version Command (version)

Mon, 01 Jan 0001 00:00:00 +0000

Displays installed pgBackRest version.

Command Options

Output Option (`--output`)

Output type.

The following output types are supported:

text - Display the installed pgBackRest version as text.
num - Display the installed pgBackRest version as an integer.

default: text
example: --output=num

10. FastCGI Applications

Mon, 01 Jan 0001 00:00:00 +0000

HAProxy is able to send HTTP requests to Responder FastCGI applications. This feature was added in HAProxy 2.1. To do so, servers must be configured to use the FastCGI protocol (using the keyword “proto fcgi” on the server line) and a FastCGI application must be configured and used by the backend managing these servers (using the keyword “use-fcgi-app” into the proxy section). Several FastCGI applications may be defined, but only one can be used at a time by a backend.

11. Stick Tables and Peers

Mon, 01 Jan 0001 00:00:00 +0000

Stick-tables in HAProxy are a mechanism which permits to associate a certain number of information and metrics with a key of a certain type, and this for a certain duration after the last update. This can be seen as a multicolumn line in a table, where the line number is defined by the key value, and the columns all represent distinct criteria.

12. Other Sections

Mon, 01 Jan 0001 00:00:00 +0000

The sections described below are less commonly used and usually support only a few parameters. There is no implicit relation between any of them. They’re all started using a single keyword. None of them is permitted before a “global” section. The support for some of them might be conditioned by build options (e.g. anything SSL-related).

12.1. Traces

For debugging purpose, it is possible to activate traces on an HAProxy’s subsystem. This will dump debug messages about a specific subsystem. It is a very powerful tool to diagnose issues. Traces can be dynamically configured via the CLI. It is also possible to predefined some settings in the configuration file, in dedicated “traces” sections. More details about traces can be found in the management guide. It remains a developer tools used during complex debugging sessions. It is pretty verbose and have a cost, so use it with caution. And because it is a developer tool, there is no warranty about the backward compatibility of this section.

Feature Gates

Mon, 01 Jan 0001 00:00:00 +0000

This page contains an overview of the various feature gates an administrator can specify on etcd.

See feature stages for an explanation of the stages for a feature.

Overview

Feature gates are a set of key=value pairs that describe etcd features. You can turn these features on or off using the --feature-gates command line flag on etcd.

etcd lets you enable or disable a set of feature gates. Use -h flag to see a full set of feature gates. To set feature gates, use the --feature-gates flag assigned to a list of feature pairs in commandline:

FAQ

Mon, 01 Jan 0001 00:00:00 +0000

etcd, general

What is etcd?

etcd is a consistent distributed key-value store. Mainly used as a separate coordination service, in distributed systems. And designed to hold small amounts of data that can fit entirely in memory.

How do you pronounce etcd?

etcd is pronounced /ˈɛtsiːdiː/, and means “distributed etc directory.”

Do clients have to send requests to the etcd leader?

Raft is leader-based; the leader handles all client requests which need cluster consensus. However, the client does not need to know which node is the leader. Any request that requires consensus sent to a follower is automatically forwarded to the leader. Requests that do not require consensus (e.g., serialized reads) can be processed by any cluster member.

Libraries and tools

Mon, 01 Jan 0001 00:00:00 +0000

Note that third-party libraries and tools (not hosted on https://github.com/etcd-io ) mentioned below are not tested or maintained by the etcd team. Before using them, users are recommended to read and investigate them.

Tools

etcdctl - A command line client for etcd
etcd-dump - Command line utility for dumping/restoring etcd.
etcd-fs - FUSE filesystem for etcd
etcddir - Realtime sync etcd and local directory. Work with windows and linux.
etcd-browser - A web-based key/value editor for etcd using AngularJS
etcd-lock - Master election & distributed r/w lock implementation using etcd - Supports v2
etcd-console - A web-base key/value editor for etcd using PHP
etcd-viewer - An etcd key-value store editor/viewer written in Java
etcdtool - Export/Import/Edit etcd directory as JSON/YAML/TOML and Validate directory using JSON schema
etcdloadtest - A command line load test client for etcd version 3.0 and above.
etcd-tui - A modern terminal user interface (TUI) for interacting with your etcd database. Navigate keys, view values, filter data, and manage your etcd cluster directly from your terminal.
etcdfinder - A lightning-fast, modern web UI for etcd with instant search. Supports both etcd v2 and v3.
lucas - A web-based key-value viewer for kubernetes etcd3.0+ cluster.
etcd-manager - A modern, efficient, multi-platform and free etcd 3.x GUI & client tool. Available for Windows, Linux and Mac.
etcd-backup-restore - Utility to periodically and incrementally backup and restore the etcd.
etcd-druid - A Kubernetes operator to deploy etcd clusters and manage day-2 operations.
etcdadm - A command-line tool for operating an etcd cluster.
etcd-defrag - An easier to use and smarter etcd defragmentation tool.
etcdhelper - An intellij platform plugin for etcd.

Libraries

The sections below list etcd client libraries by language.

Metrics

Mon, 01 Jan 0001 00:00:00 +0000

etcd uses Prometheus for metrics reporting. The metrics can be used for real-time monitoring and debugging. etcd does not persist its metrics; if a member restarts, the metrics will be reset.

The simplest way to see the available metrics is to cURL the metrics endpoint /metrics. The format is described in the Prometheus docs .

Follow the Prometheus getting started doc to spin up a Prometheus server to collect etcd metrics.

The naming of metrics follows the suggested Prometheus best practices . A metric name has an etcd or etcd_debugging prefix as its namespace and a subsystem prefix (for example wal and etcdserver).

Discovery service protocol

Mon, 01 Jan 0001 00:00:00 +0000

Discovery service protocol helps new etcd member to discover all other members in cluster bootstrap phase using a shared discovery URL.

Discovery service protocol is only used in cluster bootstrap phase, and cannot be used for runtime reconfiguration or cluster monitoring.

The protocol uses a new discovery token to bootstrap one unique etcd cluster. Remember that one discovery token can represent only one etcd cluster. As long as discovery protocol on this token starts, even if it fails halfway, it must not be used to bootstrap another etcd cluster.

Discovery service protocol

Mon, 01 Jan 0001 00:00:00 +0000

Discovery service protocol helps new etcd member to discover all other members in cluster bootstrap phase using a shared discovery token and endpoint list.

Discovery service protocol is only used in cluster bootstrap phase, and cannot be used for runtime reconfiguration or cluster monitoring.

Logging conventions

Mon, 01 Jan 0001 00:00:00 +0000

etcd uses the zap library for logging application output categorized into levels. A log message’s level is determined according to these conventions:

DebugLevel logs are typically voluminous, and are usually disabled in production.
- Examples:
  - Send a normal message to a remote peer
  - Write a log entry to disk
InfoLevel is the default logging priority.
- Examples:
  - Startup configuration
  - Start to do snapshot
  - Add a new node into the cluster
  - Add a new user into auth subsystem
WarnLevel logs are more important than Info, but don’t need individual human review.

Golang modules

Mon, 01 Jan 0001 00:00:00 +0000

The etcd project (since version 3.5) is organized into multiple golang modules hosted in a single repository .

There are following modules:

go.etcd.io/etcd/api/v3 - contains API definitions (like protos & proto-generated libraries) that defines communication protocol between etcd clients and server.
go.etcd.io/etcd/pkg/v3 - collection of utility packages used by etcd without being specific to etcd itself. A package belongs here only if it could possibly be moved out into its own repository in the future. Please avoid adding here code that has a lot of dependencies on its own, as they automatically becoming dependencies of the client library (that we want to keep lightweight).

Glossary

Mon, 01 Jan 0001 00:00:00 +0000

This document defines the various terms used in etcd documentation, command line and source code.

Alarm

The etcd server raises an alarm whenever the cluster needs operator intervention to remain reliable.

Authentication

Authentication manages user access permissions for etcd resources.

Client

A client connects to the etcd cluster to issue service requests such as fetching key-value pairs, writing data, or watching for updates.

System limits

Mon, 01 Jan 0001 00:00:00 +0000

Request size limit

etcd is designed to handle small key value pairs typical for metadata. Larger requests will work, but may increase the latency of other requests. By default, the maximum size of any request is 1.5 MiB. This limit is configurable through --max-request-bytes flag for etcd server.

Storage size limit

The default storage size limit is 2 GiB, configurable with --quota-backend-bytes flag. 8 GiB is a suggested maximum size for normal environments and etcd warns at startup if the configured value exceeds it.

etcd features

Mon, 01 Jan 0001 00:00:00 +0000

This document provides an overview of etcd features to help users better understand the features and related deprecation process. If you are interested in knowing about how features are developed in the etcd, please see these development guidelines .

The etcd features fall into three stages, experimental, stable, and unsafe. You can get the list of features by running etcd --help.

Experimental

In order to get early feedback, any new feature is usually added as an experimental feature. The experimental feature can be identified by looking at the flag name, which should have --experimental as a prefix. Please consider the following points while using an experimental feature:

API reference

Mon, 01 Jan 0001 00:00:00 +0000

This API reference is autogenerated from the named .proto files.

service `Auth` (api/etcdserverpb/rpc.proto)

Method	Request Type	Response Type	Description
AuthEnable	AuthEnableRequest	AuthEnableResponse	AuthEnable enables authentication.
AuthDisable	AuthDisableRequest	AuthDisableResponse	AuthDisable disables authentication.
AuthStatus	AuthStatusRequest	AuthStatusResponse	AuthStatus displays authentication status.
Authenticate	AuthenticateRequest	AuthenticateResponse	Authenticate processes an authenticate request.
UserAdd	AuthUserAddRequest	AuthUserAddResponse	UserAdd adds a new user. User name cannot be empty.
UserGet	AuthUserGetRequest	AuthUserGetResponse	UserGet gets detailed user information.
UserList	AuthUserListRequest	AuthUserListResponse	UserList gets a list of all users.
UserDelete	AuthUserDeleteRequest	AuthUserDeleteResponse	UserDelete deletes a specified user.
UserChangePassword	AuthUserChangePasswordRequest	AuthUserChangePasswordResponse	UserChangePassword changes the password of a specified user.
UserGrantRole	AuthUserGrantRoleRequest	AuthUserGrantRoleResponse	UserGrant grants a role to a specified user.
UserRevokeRole	AuthUserRevokeRoleRequest	AuthUserRevokeRoleResponse	UserRevokeRole revokes a role of specified user.
RoleAdd	AuthRoleAddRequest	AuthRoleAddResponse	RoleAdd adds a new role. Role name cannot be empty.
RoleGet	AuthRoleGetRequest	AuthRoleGetResponse	RoleGet gets detailed role information.
RoleList	AuthRoleListRequest	AuthRoleListResponse	RoleList gets lists of all roles.
RoleDelete	AuthRoleDeleteRequest	AuthRoleDeleteResponse	RoleDelete deletes a specified role.
RoleGrantPermission	AuthRoleGrantPermissionRequest	AuthRoleGrantPermissionResponse	RoleGrantPermission grants a permission of a specified key or range to a specified role.
RoleRevokePermission	AuthRoleRevokePermissionRequest	AuthRoleRevokePermissionResponse	RoleRevokePermission revokes a key or range permission of a specified role.

service `Cluster` (api/etcdserverpb/rpc.proto)

Method	Request Type	Response Type	Description
MemberAdd	MemberAddRequest	MemberAddResponse	MemberAdd adds a member into the cluster.
MemberRemove	MemberRemoveRequest	MemberRemoveResponse	MemberRemove removes an existing member from the cluster.
MemberUpdate	MemberUpdateRequest	MemberUpdateResponse	MemberUpdate updates the member configuration.
MemberList	MemberListRequest	MemberListResponse	MemberList lists all the members in the cluster.
MemberPromote	MemberPromoteRequest	MemberPromoteResponse	MemberPromote promotes a member from raft learner (non-voting) to raft voting member.

service `KV` (api/etcdserverpb/rpc.proto)

Method	Request Type	Response Type	Description
Range	RangeRequest	RangeResponse	Range gets the keys in the range from the key-value store.
Put	PutRequest	PutResponse	Put puts the given key into the key-value store. A put request increments the revision of the key-value store and generates one event in the event history.
DeleteRange	DeleteRangeRequest	DeleteRangeResponse	DeleteRange deletes the given range from the key-value store. A delete request increments the revision of the key-value store and generates a delete event in the event history for every deleted key.
Txn	TxnRequest	TxnResponse	Txn processes multiple requests in a single transaction. A txn request increments the revision of the key-value store and generates events with the same revision for every completed request. It is not allowed to modify the same key several times within one txn.
Compact	CompactionRequest	CompactionResponse	Compact compacts the event history in the etcd key-value store. The key-value store should be periodically compacted or the event history will continue to grow indefinitely.

service `Lease` (api/etcdserverpb/rpc.proto)

Method	Request Type	Response Type	Description
LeaseGrant	LeaseGrantRequest	LeaseGrantResponse	LeaseGrant creates a lease which expires if the server does not receive a keepAlive within a given time to live period. All keys attached to the lease will be expired and deleted if the lease expires. Each expired key generates a delete event in the event history.
LeaseRevoke	LeaseRevokeRequest	LeaseRevokeResponse	LeaseRevoke revokes a lease. All keys attached to the lease will expire and be deleted.
LeaseKeepAlive	LeaseKeepAliveRequest	LeaseKeepAliveResponse	LeaseKeepAlive keeps the lease alive by streaming keep alive requests from the client to the server and streaming keep alive responses from the server to the client.
LeaseTimeToLive	LeaseTimeToLiveRequest	LeaseTimeToLiveResponse	LeaseTimeToLive retrieves lease information.
LeaseLeases	LeaseLeasesRequest	LeaseLeasesResponse	LeaseLeases lists all existing leases.

service `Maintenance` (api/etcdserverpb/rpc.proto)

Method	Request Type	Response Type	Description
Alarm	AlarmRequest	AlarmResponse	Alarm activates, deactivates, and queries alarms regarding cluster health.
Status	StatusRequest	StatusResponse	Status gets the status of the member.
Defragment	DefragmentRequest	DefragmentResponse	Defragment defragments a member’s backend database to recover storage space.
Hash	HashRequest	HashResponse	Hash computes the hash of whole backend keyspace, including key, lease, and other buckets in storage. This is designed for testing ONLY! Do not rely on this in production with ongoing transactions, since Hash operation does not hold MVCC locks. Use “HashKV” API instead for “key” bucket consistency checks.
HashKV	HashKVRequest	HashKVResponse	HashKV computes the hash of all MVCC keys up to a given revision. It only iterates “key” bucket in backend storage.
Snapshot	SnapshotRequest	SnapshotResponse	Snapshot sends a snapshot of the entire backend from a member over a stream to a client.
MoveLeader	MoveLeaderRequest	MoveLeaderResponse	MoveLeader requests current leader node to transfer its leadership to transferee.
Downgrade	DowngradeRequest	DowngradeResponse	Downgrade requests downgrades, verifies feasibility or cancels downgrade on the cluster version. Supported since etcd 3.5.

service `Watch` (api/etcdserverpb/rpc.proto)

Method	Request Type	Response Type	Description
Watch	WatchRequest	WatchResponse	Watch watches for events happening or that have happened. Both input and output are streams; the input stream is for creating and canceling watchers and the output stream sends events. One watch RPC can watch on multiple key ranges, streaming events for several watches at once. The entire event history can be watched starting from the last compaction revision.

message `AlarmMember` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
memberID	memberID is the ID of the member associated with the raised alarm.	uint64
alarm	alarm is the type of alarm which has been raised.	AlarmType

message `AlarmRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
action	action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm.	AlarmAction
memberID	memberID is the ID of the member associated with the alarm. If memberID is 0, the alarm request covers all members.	uint64
alarm	alarm is the type of alarm to consider for this request.	AlarmType

message `AlarmResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader
alarms	alarms is a list of alarms associated with the alarm request.	(slice of) AlarmMember

message `AuthDisableRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option

message `AuthDisableResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthEnableRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option

message `AuthEnableResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthRoleAddRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
name	name is the name of the role to add to the authentication system.	string

message `AuthRoleAddResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthRoleDeleteRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
role		string

message `AuthRoleDeleteResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthRoleGetRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
role		string

message `AuthRoleGetResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
header		ResponseHeader
perm		(slice of) authpb.Permission

message `AuthRoleGrantPermissionRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
name	name is the name of the role which will be granted the permission.	string
perm	perm is the permission to grant to the role.	authpb.Permission

message `AuthRoleGrantPermissionResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthRoleListRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option

message `AuthRoleListResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader
roles		(slice of) string

message `AuthRoleRevokePermissionRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
role		string
key		bytes
range_end		bytes

message `AuthRoleRevokePermissionResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthStatusRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option

message `AuthStatusResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader
enabled		bool
authRevision	authRevision is the current revision of auth store	uint64

message `AuthUserAddRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
name		string
password		string
options		authpb.UserAddOptions
hashedPassword		string

message `AuthUserAddResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthUserChangePasswordRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
name	name is the name of the user whose password is being changed.	string
password	password is the new password for the user. Note that this field will be removed in the API layer.	string
hashedPassword	hashedPassword is the new password for the user. Note that this field will be initialized in the API layer.	string

message `AuthUserChangePasswordResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthUserDeleteRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
name	name is the name of the user to delete.	string

message `AuthUserDeleteResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthUserGetRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
name		string

message `AuthUserGetResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader
roles		(slice of) string

message `AuthUserGrantRoleRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
user	user is the name of the user which should be granted a given role.	string
role	role is the name of the role to grant to the user.	string

message `AuthUserGrantRoleResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthUserListRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option

message `AuthUserListResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader
users		(slice of) string

message `AuthUserRevokeRoleRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
name		string
role		string

message `AuthUserRevokeRoleResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader

message `AuthenticateRequest` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
name		string
password		string

message `AuthenticateResponse` (api/etcdserverpb/rpc.proto)

Field	Description	Type
(versionpb.etcd_version_msg)		option
header		ResponseHeader
token	token is an authorized token that can be used in succeeding RPCs	string

message `CompactionRequest` (api/etcdserverpb/rpc.proto)

CompactionRequest compacts the key-value store up to a given revision. All superseded keys with a revision less than the compaction revision will be removed.

API reference: concurrency

Mon, 01 Jan 0001 00:00:00 +0000

This API reference is autogenerated from the named .proto files.

service `Lock` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

The lock service exposes client-side locking facilities as a gRPC interface.

Method	Request Type	Response Type	Description
Lock	LockRequest	LockResponse	Lock acquires a distributed shared lock on a given named lock. On success, it will return a unique key that exists so long as the lock is held by the caller. This key can be used in conjunction with transactions to safely ensure updates to etcd only occur while holding lock ownership. The lock is held until Unlock is called on the key or the lease associate with the owner expires.
Unlock	UnlockRequest	UnlockResponse	Unlock takes a key returned by Lock and releases the hold on lock. The next Lock caller waiting for the lock will then be woken up and given ownership of the lock.

message `LockRequest` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

Field	Description	Type
name	name is the identifier for the distributed shared lock to be acquired.	bytes
lease	lease is the ID of the lease that will be attached to ownership of the lock. If the lease expires or is revoked and currently holds the lock, the lock is automatically released. Calls to Lock with the same lease will be treated as a single acquisition; locking twice with the same lease is a no-op.	int64

message `LockResponse` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

Field	Description	Type
header		etcdserverpb.ResponseHeader
key	key is a key that will exist on etcd for the duration that the Lock caller owns the lock. Users should not modify this key or the lock may exhibit undefined behavior.	bytes

message `UnlockRequest` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

Field	Description	Type
key	key is the lock ownership key granted by Lock.	bytes

message `UnlockResponse` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

Field	Description	Type
header		etcdserverpb.ResponseHeader

service `Election` (server/etcdserver/api/v3election/v3electionpb/v3election.proto)

The election service exposes client-side election facilities as a gRPC interface.

Configuration options

Mon, 01 Jan 0001 00:00:00 +0000

You can configure etcd through the following:

Command-line flags
Environment variables: every flag has a corresponding environment variable that has the same name but is prefixed with ETCD_ and formatted in all caps and snake case . For example, --some-flag would be ETCD_SOME_FLAG.
Configuration file

Warning

Caution: If you mix-and-match configuration options, then the following rules apply.

Command-line flags take precedence over environment variables.
If you provide a configuration file all command-line flags and environment variables are ignored.

Command-line flags

Flags are presented below using the format --flag-name DEFAULT_VALUE.

Hardware recommendations

Mon, 01 Jan 0001 00:00:00 +0000

etcd usually runs well with limited resources for development or testing purposes; it’s common to develop with etcd on a laptop or a cheap cloud machine. However, when running etcd clusters in production, some hardware guidelines are useful for proper administration. These suggestions are not hard rules; they serve as a good starting point for a robust production deployment. As always, deployments should be tested with simulated workloads before running in production.

Supported platforms

Mon, 01 Jan 0001 00:00:00 +0000

Support tiers

etcd runs on different platforms, but the guarantees it provides depends on a platform’s support tier:

Tier 1: fully supported by etcd maintainers ; etcd is guaranteed to pass all tests including functional and robustness tests.
Tier 2: etcd is guaranteed to pass integration and end-to-end tests but not necessarily functional or robustness tests.
Tier 3: etcd is guaranteed to build, may be lightly tested (or not), and so it should be considered unstable.

Current support

The following table lists currently supported platforms and their corresponding etcd support tier:

Benchmarks

Mon, 01 Jan 0001 00:00:00 +0000

Benchmarks

etcd benchmarks will be published regularly and tracked for each release below:

Memory Usage Benchmarks

It records expected memory usage in different scenarios.

etcd v2.2.0-rc

Storage Memory Usage Benchmark

Mon, 01 Jan 0001 00:00:00 +0000

Two components of etcd storage consume physical memory. The etcd process allocates an in-memory index to speed key lookup. The process’s page cache, managed by the operating system, stores recently-accessed data from disk for quick re-use.

The in-memory index holds all the keys in a B-tree data structure, along with pointers to the on-disk data (the values). Each key in the B-tree may contain multiple pointers, pointing to different versions of its values. The theoretical memory consumption of the in-memory index can hence be approximated with the formula:

Watch Memory Usage Benchmark

Mon, 01 Jan 0001 00:00:00 +0000

Note

The watch features are under active development, and their memory usage may change as that development progresses. We do not expect it to significantly increase beyond the figures stated below.

A primary goal of etcd is supporting a very large number of watchers doing a massively large amount of watching. etcd aims to support O(10k) clients, O(100K) watch streams (O(10) streams per client) and O(10M) total watchings (O(100) watching per stream). The memory consumed by each individual watching accounts for the largest portion of etcd’s overall usage, and is therefore the focus of current and future optimizations.

Benchmarking etcd v3

Mon, 01 Jan 0001 00:00:00 +0000

Physical machines

GCE n1-highcpu-2 machine type

1x dedicated local SSD mounted under /var/lib/etcd
1x dedicated slow disk for the OS
1.8 GB memory
2x CPUs
etcd version 2.2.0

etcd Cluster

1 etcd member running in v3 demo mode

Testing

Use etcd v3 benchmark tool .

Performance

reading one single key

key size in bytes	number of clients	read QPS	90th Percentile Latency (ms)
256	1	2716	0.4
256	64	16623	6.1
256	256	16622	21.7

The performance is nearly the same as the one with empty server handler.

Benchmarking etcd v2.2.0-rc-memory

Mon, 01 Jan 0001 00:00:00 +0000

Physical machine

GCE n1-standard-2 machine type

1x dedicated local SSD mounted under /var/lib/etcd
1x dedicated slow disk for the OS
7.5 GB memory
2x CPUs

etcd

etcd Version: 2.2.0-rc.0+git
Git SHA: 103cb5c
Go Version: go1.5
Go OS/Arch: linux/amd64

Testing

Start 3-member etcd cluster, each of which uses 2 cores.

The length of key name is always 64 bytes, which is a reasonable length of average key bytes.

Benchmarking etcd v2.2.0-rc

Mon, 01 Jan 0001 00:00:00 +0000

Physical machine

GCE n1-highcpu-2 machine type

1x dedicated local SSD mounted under /var/lib/etcd
1x dedicated slow disk for the OS
1.8 GB memory
2x CPUs

etcd Cluster

3 etcd 2.2.0-rc members, each runs on a single machine.

Detailed versions:

etcd Version: 2.2.0-alpha.1+git
Git SHA: 59a5a7e
Go Version: go1.4.2
Go OS/Arch: linux/amd64

Also, we use 3 etcd 2.1.0 alpha-stage members to form cluster to get base performance. etcd’s commit head is at c7146bd5 , which is the same as the one that we use in etcd 2.1 benchmark .

Benchmarking etcd v2.2.0

Mon, 01 Jan 0001 00:00:00 +0000

Physical Machines

GCE n1-highcpu-2 machine type

1x dedicated local SSD mounted as etcd data directory
1x dedicated slow disk for the OS
1.8 GB memory
2x CPUs

etcd Cluster

3 etcd 2.2.0 members, each runs on a single machine.

Detailed versions:

etcd Version: 2.2.0
Git SHA: e4561dd
Go Version: go1.5
Go OS/Arch: linux/amd64

Testing

Bootstrap another machine, outside of the etcd cluster, and run the hey HTTP benchmark tool with a connection reuse patch to send requests to each etcd cluster member. See the benchmark instructions for the patch and the steps to reproduce our procedures.

Benchmarking etcd v2.1.0

Mon, 01 Jan 0001 00:00:00 +0000

Physical machines

GCE n1-highcpu-2 machine type

1x dedicated local SSD mounted under /var/lib/etcd
1x dedicated slow disk for the OS
1.8 GB memory
2x CPUs
etcd version 2.1.0 alpha

etcd Cluster

3 etcd members, each runs on a single machine

Testing

Bootstrap another machine and use the hey HTTP benchmark tool to send requests to each etcd member. Check the benchmark hacking guide for detailed instructions.

Reference on PIG.CENTER

pgBadger 13.x Release Notes

v13.2 · 2025-12-29

v13.1 · 2025-03-16

Annotate Command (annotate)

Command Options

Backup Annotation Option (--annotation)

Dynamic Configuration Settings

News

pgBackRest 2.59.1 Released

YAML Configuration Settings

Global/Universal

pgBadger 12.x Release Notes

v12.4 · 2023-12-25

v12.3 · 2023-11-27

Archive Get Command (archive-get)

Configuration: pgbouncer.ini

Description

Generic settings

logfile

pgBadger 11.x Release Notes

v11.8 · 2022-04-08

Archive Push Command (archive-push)

Command-Line Reference

Usage and options

Environment Configuration Settings

Global/Universal

Log

Patroni configuration

pgBadger 10.x Release Notes

v10.3 · 2019-02-14

Backup Command (backup)

Command Options

Backup Annotation Option (--annotation)

Command Reference

Introduction

Patroni REST API

Health check endpoints

pgBadger 9.x Release Notes

v9.2 · 2017-07-27

Check Command (check)

Configuration Reference

Introduction

Source Releases Download

PgBouncer 1.25

PgBouncer 1.24

PgBouncer 1.23

PgBouncer 1.22

PgBouncer 1.21

PgBouncer 1.20

PgBouncer 1.19

PgBouncer 1.18

PgBouncer 1.17

PgBouncer 1.16

PgBouncer 1.15

PgBouncer 1.14

PgBouncer 1.13

PgBouncer 1.12

PgBouncer 1.11

PgBouncer 1.10

PgBouncer 1.9

PgBouncer 1.8

PgBouncer 1.7

PgBouncer 1.6

PgBouncer 1.5

PgBouncer 1.4

PgBouncer 1.3

PgBouncer 1.2

PgBouncer 1.1

PgBouncer 1.0

Binary Packages

HAProxy 3.4.4 Documentation

Choose a manual

Edition coverage

patronictl

Configuration

Expire Command (expire)

Release Notes

Introduction

Changelog

Backup Annotation Option (`--annotation`)

Backup Annotation Option (`--annotation`)

TLS Server Address Option (`--tls-server-address`)

TLS Server Authorized Clients Option (`--tls-server-auth`)

TLS Server Address Option (`--tls-server-address`)

TLS Server Port Option (`--tls-server-port`)

Online Option (`--online`)

Online Option (`--online`)

Allow Run as Root Option (`--allow-root`)

Force Option (`--force`)

Output Option (`--output`)

Set Option (`--set`)

Output Option (`--output`)