Push metrics to Prometheus Pushgateway.
Send custom metrics to Prometheus via the Pushgateway.
type: "io.kestra.plugin.prometheus.Push"Examples
Push a custom metric
id: push-metric
namespace: company.team
tasks:
  - id: push
    type: io.kestra.plugin.prometheus.Push
    url: "http://localhost:9091"
    job: "test_job"
    instance: "test_instance"
    metrics:
      - name: "kestra_test_metric"
        value: "123"
        labels:
          env: "test"
          app: "kestra"
Properties
job *Requiredstring
Job name
Prometheus job name
headers object
HTTP headers
HTTP headers to include in the request
instance string
Instance
Optional instance label
options Non-dynamicHttpConfiguration
HTTP options
HTTP client configuration
password string
Password
Optional basic auth password
url string
http://localhost:9091Base URL
Pushgateway URL
username string
Username
Optional basic auth username
Definitions
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeout string
durationThe time allowed to establish a connection to the server before failing.
readIdleTimeout string
PT5MdurationThe time allowed for a read connection to remain idle before closing it.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type *Requiredobject
password string
The password for HTTP basic authentication.
username string
The username for HTTP basic authentication.
io.kestra.plugin.prometheus.Push-Metric
labels object
name string
value string
java.nio.charset.Charset
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailed booleanstring
falseIf true, allow a failed response code (response code >= 400)
allowedResponseCodes array
List of response code allowed for this request
auth BasicAuthConfigurationBearerAuthConfiguration
The authentification to use.
defaultCharset Charsetstring
UTF-8The default charset for the request.
followRedirects booleanstring
trueWhether redirects should be followed automatically.
logs array
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe 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
DIRECTDIRECTHTTPSOCKSThe 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 *Requiredobject
token string
The token for bearer token authentication.