Skip to main content

Exports data from APIs to Prometheus

Project description

garf exporter - Prometheus exporter for garf.

PyPI Downloads PyPI

Installation and usage

Locally

  1. Install garf-exporter from pip:
pip install garf-exporter
  1. Run garf-exporter:
garf-exporter

Docker

docker run --network=host \
  -v `pwd`/garf_exporter.yaml:/app/garf_exporter.yaml \
  garf_exporter
docker run --network=host garf_exporter \
  --config gs://path/to/garf_config.yaml

By default it will start http_server on localhost:8000 and will push some basic metrics to it.

Customization

  • --config - path to garf_exporter.yaml

    config can be taken from local storage or remote storage.

  • --expose-type - type of exposition (http or pushgateway, http is used by default)
  • --host - address of your http server (localhost by default)
  • --port - port of your http server (8000 by default)
  • --delay-minutes - delay in minutes between scrapings (15 by default)

Customizing fetching dates

By default garf-exporter fetches performance data for TODAY; if you want to customize it you can provide optional flags:

  • --macro.start_date=:YYYYMMDD-N, where N is number of days starting from today
  • --macro.end_date=:YYYYMMDD-M, where N is number of days starting from today

It will add an additional metric to be exposed to Prometheus *_n_days (i.e. googleads_clicks_n_days).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

garf_exporter-0.0.1.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

garf_exporter-0.0.1-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file garf_exporter-0.0.1.tar.gz.

File metadata

  • Download URL: garf_exporter-0.0.1.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.4

File hashes

Hashes for garf_exporter-0.0.1.tar.gz
Algorithm Hash digest
SHA256 68e0fe859648582d1878059567f8093d58a07117ac703f5b5e6ae28abf44fe4b
MD5 66086a475731cd6af5435cbb093ac0cd
BLAKE2b-256 be7f3da83185a2257456cd56023986132e73de0ee71087cb43fdc0252cee4f8c

See more details on using hashes here.

File details

Details for the file garf_exporter-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for garf_exporter-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b741be733ee545953aae9b771002253c1fbed37d0bbcf15cdbd5724cb5853955
MD5 662fd768c7fb3f0b4e898cfd6767847c
BLAKE2b-256 f7c47617a2828b6b568a1c011171fb8d44cbbb1527a534418cb23dfe4fea45a9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page