Skip to main content

Configurable Prometheus exporter for results of Elasticsearch queries

Project description

promesque is a configurable Prometheus exporter for results of Elasticsearch queries.


pip3 install promesque


promesque path/to/some/config.yml --log-level info

Refer to exporter_es.yml as an example for such a config. The supported fields are explained below.

Configuration File

Configuration file is in a yaml format with single configuration scope (metrics).

Each item in metrics scope define a metric and must have following attributes:

  • description: description of a metric (what it does)

  • data_path: jsonpath to data buckets in Elasticsearch response to build metrics from (default: $)

  • value_path: jsonpath to metric value within data bucket

  • labels: inner scope with name: reference for each metric:
    • name: name of label exposed by exporter

    • reference: jsonpath to label value within data bucket

  • url: url to Elasticsearch cluster (include index)

  • query: query in json format; must
    • either be inclosed in single quotes (e.g. '{ "query": {...} }')

    • or written in YAML block notation with proper indentation, e.g.,

      es_query: |
          "query": {

Project details

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

promesque-0.0.3-py3-none-any.whl (5.8 kB view hashes)

Uploaded Python 3

Supported by

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