garf-prometheus 0.0.1

Garf implementation for Prometheus API

garf for Prometheus HTTP API

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

Prerequisites

• Running Prometheus instance

Installation

pip install garf-prometheus

Usage

Run as a library

import os

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

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

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

console_writer = writer.create_writer('console')
console_writer.write(fetched_report, 'query')

Run via CLI

Install garf-executors package to run queries via CLI (pip install garf-executors).

garf <PATH_TO_QUERIES> --source prometheus \
  --output <OUTPUT_TYPE> \
  --prometheus.endpoint=http://localhost:9090

where:

• PATH_TO_QUERIES - local or remove files containing queries
• output - output supported by garf-io library.
• SOURCE_PARAMETER=VALUE - key-value pairs to refine fetching, check available source parameters.

Available source parameters

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

Documentation

You can find a documentation on garf-prometheus here.