Prometheus

Run PromQL instant and range queries against a Prometheus server, and list label names or series metadata — all via the Prometheus HTTP API v1.

Operations

Authentication

Prometheus itself has no built-in authentication. When your Prometheus instance is protected by a reverse proxy (e.g. Grafana Cloud, nginx with Basic Auth middleware, or a JWT gateway), pass a Bearer token in the apiKey field. It is sent as:

Authorization: Bearer <apiKey>

For unauthenticated Prometheus instances on a private network, leave apiKey blank.

Inputs

Outputs

Examples

Check which targets are up (instant query)

[
  {
    "name": "check_targets",
    "tool": "prometheus",
    "input": {
      "serverUrl": "http://prometheus.example.com:9090",
      "operation": "instant_query",
      "query": "up"
    }
  }
]

CPU usage over the last hour (range query)

[
  {
    "name": "cpu_usage",
    "tool": "prometheus",
    "input": {
      "serverUrl": "http://prometheus.example.com:9090",
      "operation": "range_query",
      "query": "100 - (avg by(instance) (rate(node_cpu_seconds_total{mode=\"idle\"}[5m])) * 100)",
      "start": "2024-01-15T11:00:00Z",
      "end": "2024-01-15T12:00:00Z",
      "step": "1m"
    }
  }
]

List all label names

[
  {
    "name": "labels",
    "tool": "prometheus",
    "input": {
      "serverUrl": "http://prometheus.example.com:9090",
      "operation": "list_labels"
    }
  }
]

Find all series for a specific job

[
  {
    "name": "series",
    "tool": "prometheus",
    "input": {
      "serverUrl": "http://prometheus.example.com:9090",
      "operation": "list_series",
      "match": "{job=\"node_exporter\"}"
    }
  }
]

Grafana Cloud (authenticated)

[
  {
    "name": "gf_query",
    "tool": "prometheus",
    "input": {
      "serverUrl": "https://prometheus-prod-01-eu-west-0.grafana.net",
      "apiKey": "glc_eyJ...",
      "operation": "instant_query",
      "query": "up"
    }
  }
]

Notes

• The result output contains the raw Prometheus JSON response, which has the shape {"status":"success","data":{"resultType":"...","result":[...]}}.
• Response bodies are capped at 5 MB. For very high-cardinality queries, add aggregation to your PromQL expression.
• list_series with broad selectors (e.g. {__name__=~".+"}) can be extremely expensive on large Prometheus instances; prefer narrower selectors.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• result
• status
• truncated

Input Properties

Every property this tool accepts, from its own tool.iml.