Skip to content

pg_hardstorage_wal_preflight.md

Latest commit

 

History

History
65 lines (50 loc) · 3.72 KB

pg_hardstorage_wal_preflight.md

File metadata and controls

65 lines (50 loc) · 3.72 KB
Raw
title pg hardstorage wal preflight
description CLI reference for the pg hardstorage wal preflight command.
tags
cli
reference

pg_hardstorage wal preflight

Validate PostgreSQL configuration for WAL streaming

Synopsis

Run the WAL-stream readiness checks against the source PostgreSQL.

Checks (fatal first):

  • wal_level >= replica
  • max_replication_slots > current count
  • max_wal_senders > current active count
  • the connecting role has the REPLICATION attribute (when --role given)
  • max_slot_wal_keep_size > 0 (warning: caps slot retention, can lose WAL)
  • max_slot_wal_keep_size unbounded (info: surfaces the disk-fill risk)
  • idle_replication_slot_timeout = 0 (warning, PG 17+)

Exits 0 when no fatal findings. Use --json for the structured form suitable for piping into automation.

pg_hardstorage wal preflight <deployment> [flags]

Options

  -h, --help                   help for preflight
      --pg-connection string   libpq connection string for the source PostgreSQL (required)
      --role user=             role the streamer connects as; if empty, the role is inferred from --pg-connection (user= parameter)

Options inherited from parent commands

      --airgapped airgapped: strict                                                       refuse outbound endpoints (LLM providers, sinks, OTLP collectors) outside loopback / RFC1918 / explicit airgap.allowlist. Also enabled by PG_HARDSTORAGE_AIRGAPPED=1 or airgapped: strict in the config file.
  -c, --config string                                                                     path to config file (default: XDG/FHS lookup)
      --cpu-profile go tool pprof <path>                                                  write a pprof CPU profile to this path for the duration of the command (go tool pprof <path> to analyse). Off when empty.
      --mem-profile string                                                                write a pprof heap profile to this path at command exit. Off when empty.
      --no-color                                                                          disable ANSI color in text output
      --on-error-llm                                                                      on a structured-error failure, drop into the matching LLM helper skill (auto_on_error trigger). Also enabled by PG_HARDSTORAGE_ON_ERROR_LLM=1.
      --otel-endpoint string                                                              OpenTelemetry OTLP/HTTP endpoint (e.g. http://otel-collector:4318); empty disables tracing
      --otel-stdout                                                                       also export OpenTelemetry traces to stderr (useful for dev)
  -o, --output string                                                                     output format: text|json|ndjson|yaml|template|csv|markdown|html|tap|junit|pdf (default: text on TTY, json off-TTY)
      --profile-port go tool pprof http://127.0.0.1:6060/debug/pprof/profile?seconds=30   if non-zero, expose net/http/pprof on 127.0.0.1:<port> for live profiling of long-running commands (e.g. go tool pprof http://127.0.0.1:6060/debug/pprof/profile?seconds=30). Off when zero.
  -q, --quiet                                                                             suppress non-essential output
      --template string                                                                   Go text/template applied when --output template (or implied if --template is set without --output)

SEE ALSO