Category: Reference

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 …

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 …

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 …

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 …

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 …

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 …

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 …

Benchmarks etcd benchmarks will be published regularly and tracked for each release below: etcd v2.1.0-alpha etcd v2.2.0-rc etcd v3 demo Memory Usage Benchmarks It records expected memory usage in different scenarios. etcd v2.2.0-rc

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 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 …

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, …

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 …

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 …

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. …

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 …

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 …

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 …

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 …

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 …

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 …

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 …

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 …

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 …

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 …

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 …

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, …

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 …

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 …

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. See also: “filter” 9.1. Trace …

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: …

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 …

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 …

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 …

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 …

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 …

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 …

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 “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 …

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 …

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 …

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 …

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 …

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 …

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 …

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 …

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. …

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 Copyright (c) 2012-2026, …

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 …

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 …

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 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 …

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 …

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 …

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 …

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 …

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 …

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 …

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, …

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 …

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 …

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 …

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. …

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 …

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 …

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 …

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 …

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 …

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 …

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. …

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 …

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 …

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 …

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 …

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 …

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 …

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 …

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 …

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 …

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. …

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: …

New Distribution Tarball July 20, 2026 Starting with pgBackRest 2.59.0, every release includes a distribution tarball that makes building from source simpler. Unlike a checkout of the git repository, the tarball ships the generated source and the …

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 …

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 …

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 …