Env
Environment variables recognized by the Proxy and Agent processes.
Values are resolved with the precedence: CLI argument → environment variable → config file → built-in default. Use getEnv to read a variable with a typed default; missing values fall through to the supplied default, and malformed numeric or boolean values raise IllegalArgumentException.
Entries
Path or URL to the Proxy HOCON config file. Equivalent to the --config/-c CLI flag.
TCP port the Proxy serves proxied scrape requests on (the port Prometheus connects to). Default 8080.
TCP port the Proxy listens on for incoming gRPC connections from agents. Default 50051.
Enable Prometheus HTTP service-discovery on the Proxy. When true the Proxy serves a discovery document listing currently registered agent paths. Default false.
Base URL used to build per-target entries in the service-discovery document (e.g. http://proxy:8080/).
Disable the gRPC server reflection service on the Proxy. Default false (reflection enabled).
gRPC handshake timeout for the Proxy server, in seconds. -1 uses the gRPC default.
If true, allow gRPC keepalive pings from agents even when no RPCs are in-flight. Default false.
Minimum interval the Proxy will accept gRPC keepalive pings from agents, in seconds.
gRPC server MAX_CONNECTION_IDLE in seconds — idle connections are closed after this period. -1 disables.
gRPC server MAX_CONNECTION_AGE in seconds — connections older than this are gracefully closed. -1 disables.
Grace period after MAX_CONNECTION_AGE_SECS before forced close, in seconds. -1 disables.
Proxy log level: one of all, trace, debug, info, warn, error, off. Empty leaves the configured level unchanged.
Path or URL to the Agent HOCON config file. Equivalent to the --config/-c CLI flag.
Hostname (or host:port) of the Proxy the Agent should connect to.
Friendly name for this Agent reported in metrics and logs.
Run the Agent in consolidated mode, allowing multiple agents to register the same path for redundancy. Default false.
Per-scrape timeout when the Agent fetches the underlying metrics endpoint, in seconds.
Maximum number of retries the Agent attempts on a failed scrape before giving up. 0 disables retries.
Threshold above which a scrape response is split into chunked gRPC messages, in kilobytes. Also doubles as the chunk buffer size. Default 32.
Scrape responses larger than this size are gzipped before being streamed to the Proxy, in bytes.
Disable X.509 certificate verification for HTTPS scrape targets. Insecure — only enable for self-signed internal endpoints. Default false.
Maximum number of concurrent HTTP scrape requests the Agent will issue.
HTTP client request timeout used by the Agent when scraping endpoints, in seconds.
Maximum number of pooled HTTP clients the Agent caches (keyed by auth credentials / target).
Maximum age before a cached HTTP client is evicted, in minutes.
Maximum idle time before a cached HTTP client is evicted, in minutes.
Interval between HTTP-client-cache cleanup sweeps, in minutes.
If true, the Agent sends gRPC keepalive pings even when no RPCs are in-flight. Default false.
Per-call deadline applied to unary gRPC calls from the Agent to the Proxy, in seconds.
Agent log level: one of all, trace, debug, info, warn, error, off. Empty leaves the configured level unchanged.
Enable the /debug admin servlet on whichever process this variable is read by. Default false.
Enable the Prometheus metrics endpoint on this process. Default false.
Listen port for this process's Prometheus metrics endpoint.
Enable the admin servlets (ping, version, healthcheck, threaddump) on this process. Default false.
Listen port for this process's admin servlets.
Disable the gRPC transport filter that records remote-peer information per call. Set true when running behind an L7 reverse proxy (e.g. nginx) that strips this information. Default false.
Filesystem path to the TLS certificate chain file (PEM). Empty disables TLS on this side.
Filesystem path to the TLS private key file (PEM). Empty disables TLS on this side.
Filesystem path to the trust-store certificate collection (PEM) used to validate the peer.
TLS authority override for the Agent's gRPC channel. Useful when the Proxy hostname does not match its certificate SAN.
gRPC keepalive ping interval, in seconds. -1 uses the gRPC default.
gRPC keepalive ping timeout, in seconds. -1 uses the gRPC default.