OS Manuals

/usr/bin/promxy

An aggregating proxy to enable HA prometheus.

From promxy-fips 0.0.97-r7 (enterprise-packages), captured 2026-11-08 by running promxy --help (exit 1). permalink

Usage:
  promxy [OPTIONS]

Application Options:
  -v, --version                                   print out version and exit
      --check-config                              check config files and exit
      --bind-addr=                                address for promxy to listen
                                                  on (default: :8082)
      --config=                                   path to the config file
                                                  (default: config.yaml)
      --log-level=                                Log level (default: info)
      --log-format=                               Log format(text|json)
                                                  (default: text)
      --log-max-form-prefix=                      Max prefix for form values in
                                                  log entries (default: 256)
      --web.config.file=                          [EXPERIMENTAL] Path to a
                                                  Prometheus-format web config
                                                  file (TLS, HTTP headers,
                                                  basic auth users). See
                                                  https://prometheus.io/docs/pr-

                                                  ometheus/latest/configuration-

                                                  /https/ for the schema.
      --web.cors.origin=                          Regex for CORS origin. It is
                                                  fully anchored. (default: .*)
      --web.read-timeout=                         Maximum duration before
                                                  timing out read of the
                                                  request, and closing idle
                                                  connections. (default: 5m)
      --metrics-path=                             URL path for the prometheus
                                                  metrics endpoint. (default:
                                                  /metrics)
      --proxy-headers=                            a list of headers to proxy to
                                                  downstream servergroups.
                                                  [$PROXY_HEADERS]
      --web.external-url=                         The URL under which
                                                  Prometheus is externally
                                                  reachable (for example, if
                                                  Prometheus is served via a
                                                  reverse proxy). Used for
                                                  generating relative and
                                                  absolute links back to
                                                  Prometheus itself. If the URL
                                                  has a path portion, it will
                                                  be used to prefix all HTTP
                                                  endpoints served by
                                                  Prometheus. If omitted,
                                                  relevant URL components will
                                                  be derived automatically.
      --web.route-prefix=                         Prefix for the internal
                                                  routes of web endpoints.
                                                  Defaults to path of
                                                  --web.external-url.
      --web.enable-lifecycle                      Enable shutdown and reload
                                                  via HTTP request.
      --query.timeout=                            Maximum time a query may take
                                                  before being aborted.
                                                  (default: 2m)
      --query.max-samples=                        Maximum number of samples a
                                                  single query can load into
                                                  memory. Note that queries
                                                  will fail if they would load
                                                  more samples than this into
                                                  memory, so this also limits
                                                  the number of samples a query
                                                  can return. (default:
                                                  50000000)
      --query.lookback-delta=                     The maximum lookback duration
                                                  for retrieving metrics during
                                                  expression evaluations.
                                                  (default: 5m)
      --query.max-concurrency=                    Maximum number of queries
                                                  executed concurrently.
                                                  (default: -1)
      --storage.path=                             Base directory for promxy's
                                                  local working state (active
                                                  query tracker file,
                                                  remote_write WAL).
      --storage.tsdb.path=                        DEPRECATED: use
                                                  --storage.path instead.
                                                  (Promxy has no TSDB; this
                                                  flag is misnamed.)
      --remote-read.max-concurrency=              Maximum number of concurrent
                                                  remote read calls. (default:
                                                  10)
      --alertmanager.notification-queue-capacity= The capacity of the queue for
                                                  pending alert manager
                                                  notifications. (default:
                                                  10000)
      --access-log-destination=                   where to log access logs,
                                                  options (none, stderr,
                                                  stdout) (default: stdout)
      --rules.alert.for-outage-tolerance=         Max time to tolerate
                                                  prometheus outage for
                                                  restoring for state of alert.
                                                  (default: 1h)
      --rules.alert.for-grace-period=             Minimum duration between
                                                  alert and restored for state.
                                                  This is maintained only for
                                                  alerts with configured for
                                                  time greater than grace
                                                  period. (default: 10m)
      --rules.alert.resend-delay=                 Minimum amount of time to
                                                  wait before resending an
                                                  alert to Alertmanager.
                                                  (default: 1m)
      --rules.alertbackfill                       Enable promxy to recalculate
                                                  alert state on startup when
                                                  the downstream datastore
                                                  doesn't have an
                                                  ALERTS_FOR_STATE
      --http.shutdown-delay=                      time to wait before shutting
                                                  down the http server, this
                                                  allows for a grace period for
                                                  upstreams (e.g.
                                                  LoadBalancers) to discover
                                                  the new stopping status
                                                  through healthchecks
                                                  (default: 10s)
      --http.shutdown-timeout=                    max time to wait for a
                                                  graceful shutdown of the HTTP
                                                  server (default: 60s)

Help Options:
  -h, --help                                      Show this help message
Options (30)
OptionDescriptionSource
-v, --versionprint out version and exithelp
--check-configcheck config files and exithelp
--bind-addraddress for promxy to listen on (default: :8082)help
--configpath to the config file (default: config.yaml)help
--log-levelLog level (default: info)help
--log-formatLog format(text|json) (default: text)help
--log-max-form-prefixMax prefix for form values in log entries (default: 256)help
--web.config.file[EXPERIMENTAL] Path to a Prometheus-format web config file (TLS, HTTP headers, basic auth users).help
--web.cors.originRegex for CORS origin.help
--web.read-timeoutMaximum duration before timing out read of the request, and closing idle connections.help
--metrics-pathURL path for the prometheus metrics endpoint.help
--proxy-headersa list of headers to proxy to downstream servergroups.help
--web.external-urlThe URL under which Prometheus is externally reachable (for example, if Prometheus is served via a reverse proxy).help
--web.route-prefixPrefix for the internal routes of web endpoints.help
--web.enable-lifecycleEnable shutdown and reload via HTTP request.help
--query.timeoutMaximum time a query may take before being aborted.help
--query.max-samplesMaximum number of samples a single query can load into memory.help
--query.lookback-deltaThe maximum lookback duration for retrieving metrics during expression evaluations.help
--query.max-concurrencyMaximum number of queries executed concurrently.help
--storage.pathBase directory for promxy's local working state (active query tracker file, remote_write WAL).help
--storage.tsdb.pathDEPRECATED: usehelp
--remote-read.max-concurrencyMaximum number of concurrent remote read calls.help
--access-log-destinationwhere to log access logs, options (none, stderr, stdout) (default: stdout)help
--rules.alert.for-outage-toleranceMax time to tolerate prometheus outage for restoring for state of alert.help
--rules.alert.for-grace-periodMinimum duration between alert and restored for state.help
--rules.alert.resend-delayMinimum amount of time to wait before resending an alert to Alertmanager.help
--rules.alertbackfillEnable promxy to recalculate alert state on startup when the downstream datastore doesn't have an ALERTS_FOR_STATEhelp
--http.shutdown-delaytime to wait before shutting down the http server, this allows for a grace period for upstreams (e.g. LoadBalancers) to discover the new stopping status through healthchecks (default: 10s)help
--http.shutdown-timeoutmax time to wait for a graceful shutdown of the HTTP server (default: 60s)help
-h, --helpShow this help messagehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.