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
configuration file that can
enable TLS or authentication.
--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.tsdb.path= Base path for metrics storage.
--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 (29)
| Option | Description | Source |
|---|---|---|
-v, --version | print out version and exit | help |
--check-config | check config files and exit | help |
--bind-addr | address for promxy to listen on (default: :8082) | help |
--config | path to the config file (default: config.yaml) | help |
--log-level | Log level (default: info) | help |
--log-format | Log format(text|json) (default: text) | help |
--log-max-form-prefix | Max prefix for form values in log entries (default: 256) | help |
--web.config.file | [EXPERIMENTAL] Path to configuration file that can enable TLS or authentication. | help |
--web.cors.origin | Regex for CORS origin. | help |
--web.read-timeout | Maximum duration before timing out read of the request, and closing idle connections. | help |
--metrics-path | URL path for the prometheus metrics endpoint. | help |
--proxy-headers | a list of headers to proxy to downstream servergroups. | help |
--web.external-url | The URL under which Prometheus is externally reachable (for example, if Prometheus is served via a reverse proxy). | help |
--web.route-prefix | Prefix for the internal routes of web endpoints. | help |
--web.enable-lifecycle | Enable shutdown and reload via HTTP request. | help |
--query.timeout | Maximum time a query may take before being aborted. | help |
--query.max-samples | Maximum number of samples a single query can load into memory. | help |
--query.lookback-delta | The maximum lookback duration for retrieving metrics during expression evaluations. | help |
--query.max-concurrency | Maximum number of queries executed concurrently. | help |
--storage.tsdb.path | Base path for metrics storage. | help |
--remote-read.max-concurrency | Maximum number of concurrent remote read calls. | help |
--access-log-destination | where to log access logs, options (none, stderr, stdout) (default: stdout) | help |
--rules.alert.for-outage-tolerance | Max time to tolerate prometheus outage for restoring for state of alert. | help |
--rules.alert.for-grace-period | Minimum duration between alert and restored for state. | help |
--rules.alert.resend-delay | Minimum amount of time to wait before resending an alert to Alertmanager. | help |
--rules.alertbackfill | Enable promxy to recalculate alert state on startup when the downstream datastore doesn't have an ALERTS_FOR_STATE | help |
--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) | help |
--http.shutdown-timeout | max time to wait for a graceful shutdown of the HTTP server (default: 60s) | help |
-h, --help | Show this help message | help |