Skip to content

Prometheus

garf for Prometheus HTTP API

PyPI Downloads PyPI

garf-prometheus simplifies fetching data from Prometheus HTTP API using SQL-like queries.

Install

Install garf-prometheus library

pip install garf-executors garf-prometheus

uv pip install garf-executors garf-prometheus

Usage

Prerequisites

  • Running Prometheus instance
echo """
SELECT
  timestamp,
  job,
  instance,
  value
FROM query
WHERE
  query = up
" > query.sql
garf query.sql --source prometheus \
  --output csv --prometheus.endpoint=http://localhost:9090

import os

from garf.io import writer
from garf.community.prometheus import PrometheusApiReportFetcher

query = """
SELECT
  timestamp,
  job,
  instance,
  value
FROM query
WHERE
  query = up
"""

fetched_report = (
  PrometheusApiReportFetcher(
    endpoint='http://localhost:9090'
  )
  .fetch(query)
)

csv_writer = writer.create_writer('csv')
csv_writer.write(fetched_report, 'query')

Available source parameters

name values comments
endpoint Base URL when Prometheus is running (http://localhost:9090 by default)