Skip to main content

Prometheus

Type ID: prometheus  ·  Kind: Action  ·  Ports: 1 in, 1 out

Query metrics and alerting data from Prometheus.

Credentials​

Basic Auth (prometheus), No Auth (prometheus_noauth), Bearer Token (prometheus_bearer), Custom Headers (prometheus_headers)

Resources & operations​

  • Query (query)
    • Instant Query (instantQuery) - Evaluate a PromQL expression at a single point in time
    • Range Query (rangeQuery) - Evaluate a PromQL expression over a time range
  • Metadata (metadata)
    • Get Targets (getTargets) - Get health and scrape info for monitored targets
    • Get Alerts (getAlerts) - Get active alerts and their state

For agent integrations (name: 'prometheus' in permissions.integrations), grant '*', a resource key, or an operation key — see Tools and Permissions:

Resource key (<resource>)Operation keys (<resource>.<operation>)
queryquery.instantQuery, query.rangeQuery
metadatametadata.getTargets, metadata.getAlerts

Properties​

Common​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
ResourceresourceoptionsYesqueryQuery (query), Metadata (metadata)-
OperationoperationoptionsYesinstantQueryInstant Query (instantQuery), Range Query (rangeQuery)resource = query
OperationoperationoptionsYesgetTargetsGet Targets (getTargets), Get Alerts (getAlerts)resource = metadata

Query → Instant Query​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
PromQL ExpressionquerystringYes''PromQL expression to evaluate, e.g. 100 - (avg(rate(node_cpu_seconds_total{mode="idle"}[5m])) * 100)resource = query, operation = instantQuery
TimetimestringNo''Optional evaluation timestamp (RFC3339 or Unix timestamp). Defaults to now.resource = query, operation = instantQuery

Query → Range Query​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
PromQL ExpressionquerystringYes''PromQL expression to evaluate over the time range, e.g. rate(http_requests_total{code="500"}[5m])resource = query, operation = rangeQuery
Start TimestartstringYes''Start timestamp (RFC3339 or Unix timestamp)resource = query, operation = rangeQuery
End TimeendstringYes''End timestamp (RFC3339 or Unix timestamp)resource = query, operation = rangeQuery
StepstepstringYes1mQuery resolution step width, e.g. 1m, 1hresource = query, operation = rangeQuery

Metadata → Get Targets​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
StatestateoptionsYesanyAny (any), Active (active), Dropped (dropped)resource = metadata, operation = getTargets

Metadata → Get Alerts​

(No additional properties)

Notes​

  • Instant Query and Range Query output: { resultType, result }.
  • Get Targets output: { activeTargets, droppedTargets }.
  • Get Alerts output: { alerts }.