Skip to main content

Faktory metrics exporter for Prometheus, written in Python

Project description

faktory-prometheus-exporter

A Faktory Exporter written in Python for Prometheus.


In a nutshell

The faktory_exporter is a simple server that scrapes a configured Faktory instance for stats by issuing the "INFO" command and exports them via string message for Prometheus consumption.

Usage

The URL used to scrape info from faktory is by default tcp://:@localhost:7419, but can be overwritten by using the --faktory_url arg or by specifying a FAKTORY_URL environment variable.

Install with pip

Fastest way is simply running (preferably in a python env):

pip install faktory-prometheus-exporter
faktory-prometheus-exporter [--faktory_url='tcp://:[password]@localhost:7419']

Develop using uv or pip-compile

The requirements format are the ones defined by pip-compile, from pip-tools. You may also equally use uv pip compile from uv.

uv pip compile requirements.in -o requirements.txt
uv pip compile requirements-dev.in -o requirements-dev.txt

Then you can either install locally to use the CLI or to run the python function:

uv pip install -e .
faktory-prometheus-exporter [--faktory_url='tcp://:[password]@localhost:7419']
python faktory_prometheus_exporter.py

Build and use as docker container

You may use the Dockerfile and run something like the following. Make sure that the exporter is in the same network than faktory, i.e. with docker-compose.

docker build -t faktory-prometheus-exporter:latest .
docker run -d [--rm] faktory-prometheus-exporter:latest [--faktory_url='tcp://:[password]@localhost:7419']

Inspiration / prior work

Inspired by this Faktory Exporter written in go, but only partially maintained and not working out of the box when we needed it, so we built our own one.

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

faktory_prometheus_exporter-0.1.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file faktory_prometheus_exporter-0.1.0.tar.gz.

File metadata

File hashes

Hashes for faktory_prometheus_exporter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7600f3731d48c7ed35d076d8d8ee9e254c65232fba3961e6e36d29da102772cc
MD5 bdcef29ead3bf0926622a04bd4f8ccf9
BLAKE2b-256 e1ba5832462a915e5d2e2254d7769ced02d8fbb6dd903cfd2b82dd975c8e971b

See more details on using hashes here.

File details

Details for the file faktory_prometheus_exporter-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for faktory_prometheus_exporter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68018f20295e3b6ae6e0940d85b6a4fa4424a4169f7aa5a797d6b3fb9b300d37
MD5 71fdb2541236cd5dc4444c6509db5817
BLAKE2b-256 f4f8c494af7d4ebcb0bbb0dc21ab7ce44129a087ff0f6b0e53b91ad6710f47ab

See more details on using hashes here.

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