Query

Query Prometheus metrics using PromQL.

Execute PromQL queries against Prometheus and return structured metric data.

yaml
type: "io.kestra.plugin.prometheus.Query"

Examples

Query CPU usage

yaml
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

yaml
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 *string

PromQL query

Prometheus query language expression

fetchType string

Default NONE

Possible Values

STOREFETCHFETCH_ONENONE

The way you want to store the data.

FETCH_ONE outputs the first row, FETCH outputs all the rows, STORE stores all rows in a file, NONE does nothing.

headers object

SubType string

HTTP headers

HTTP headers to include in the request

options HttpConfiguration

HTTP options

HTTP client configuration

password string

Password

Optional basic auth password

time string

Query time

Time for the query (RFC3339 or Unix timestamp). Defaults to current time.

url string

Default http://localhost:9090

Base URL

Prometheus server URL

username string

Username

Optional basic auth username

Definitions

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeout string

Format duration

The time allowed to establish a connection to the server before failing.

readIdleTimeout string

Default PT5M

Format duration

The time allowed for a read connection to remain idle before closing it.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type *object

password string

The password for HTTP basic authentication.

username string

The username for HTTP basic authentication.

java.nio.charset.Charset

io.kestra.core.http.client.configurations.HttpConfiguration

allowFailed booleanstring

Default false

If true, allow a failed response code (response code >= 400)

allowedResponseCodes array

SubType integer

List of response code allowed for this request

auth BasicAuthConfiguration BearerAuthConfiguration

The authentification to use.

defaultCharset Charsetstring

Default UTF-8

The default charset for the request.

followRedirects booleanstring

Default true

Whether redirects should be followed automatically.

logs array

SubType string

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

proxy ProxyConfiguration

The proxy configuration.

ssl SslOptions

The SSL request options

timeout TimeoutConfiguration

The timeout configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

address string

The address of the proxy server.

password string

The password for proxy authentication.

port integerstring

The port of the proxy server.

type string

Default DIRECT

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

username string

The username for proxy authentication.

io.kestra.core.http.client.configurations.SslOptions

insecureTrustAllCertificates booleanstring

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.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type *object

token string

The token for bearer token authentication.

​Query

Query