Skip to content

pg_hardstorage_wal_audit.md

Latest commit

 

History

History
66 lines (51 loc) · 3.72 KB

pg_hardstorage_wal_audit.md

File metadata and controls

66 lines (51 loc) · 3.72 KB
Raw
title pg hardstorage wal audit
description CLI reference for the pg hardstorage wal audit command.
tags
cli
reference

pg_hardstorage wal audit

Detect WAL gaps and alarm on findings (cron-friendly)

Synopsis

wal audit walks the repo's wal/// tree and asserts every committed segment fits exactly after its predecessor on the same timeline. A non-contiguous range is a gap — the "WAL got lost between agent disconnect and slot recreate" case the plan calls out.

Findings flip the exit code to ExitVerifyFailed (9) so cron-driven audits alarm. A wal.gap_detected audit-chain entry is appended on every gap-finding run — bit-rot-style: rare enough to be signal, not noise.

For the read-only "what segments do I have?" query, use wal list <deployment> --gaps-only — same gap-detection primitive, no exit-code flip, no audit emission.

pg_hardstorage wal audit <deployment> [flags]

Options

  -h, --help              help for audit
      --repo string       repository URL (file://, s3://, ...) — must already exist (required)
      --timeline uint32   only audit segments on this timeline (0 = all timelines)

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