Prometheus Query
CertifiedRun PromQL query against Prometheus
Prometheus Query
Run PromQL query against Prometheus
Execute a PromQL query and return metrics as vector, matrix, scalar, or string. Defaults to http://localhost: 9090 and uses fetchType (default NONE) to control outputs
type: io.kestra.plugin.prometheus.QueryExamples
Query CPU usage
id: prometheus-up-query
namespace: company.team
tasks:
- id: check_up
type: io.kestra.plugin.prometheus.Query
url: "http://localhost:9090"
query: "up"
Query a pushed custom metric
id: query-custom-metric
namespace: io.kestra.tests
tasks:
- id: query_metric
type: io.kestra.plugin.prometheus.Query
url: "http://localhost:9090"
query: "kestra_test_metric"
Properties
query *Requiredstring
PromQL query
Prometheus query language expression
fetchType string
NONESTOREFETCHFETCH_ONENONEFetch behavior
Controls how results are returned: FETCH_ONE first row, FETCH all rows, STORE writes all rows to storage, NONE skips storage. Default NONE
headers object
Additional HTTP headers
Headers added to every Prometheus request; later values override duplicates
options Non-dynamic
HTTP client options
Override client settings such as timeouts, TLS, or proxy. Defaults to standard Kestra HTTP configuration
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
password string
Basic auth password
Optional password paired with username for HTTP basic authentication
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
time string
Query time
Query evaluation time (RFC3339 or Unix timestamp); defaults to current time
url string
http://localhost:9090Base URL
Prometheus server URL; defaults to http://localhost: 9090
username string
Basic auth username
Optional username used for HTTP basic authentication
