pgflux
pgflux is a Python utility to send PostgreSQL metrics to InfluxDB. The drivers when developing this tool were:
Make it easy to extend: Authoring new queries should only require PostgreSQL knowledge to allow non-devs to easily add/fix/modify the collected metrics. pgflux does not require you to know Python, InfluxDB nor Grafana to work on the provided SQL queries.
Be independently runnable: pgflux should be runnable without first setting up a hugely complex dev-environment. All that is needed is a Python environment and a PostgreSQL server (a Dockerfile for testing is supplied for the latter).
Screenshots
It enables Grafana visualisations as seen in the screenshots below:
Installation
The project can be installed directly via pip:
python3 -m venv /path/to/virtual-env /path/to/virtual-env/bin/pip install pgflux
The use of a virtual environment is optional, but recommended.
Usage
Development & Extending
For detailed instructions, see https://post-luxembourg.github.io/pgflux/development.html
NOTE
This project uses fabric as task runner (see https://fabfile.org). To install it use either pipx install fabric (recommended) or, if you don’t have pipx: pip install --user fabric.
Commands
Listing all available development tasks:
fab -l
To set up or refresh the development environment:
fab develop
Run PostgreSQL, InfluxDB & Grafana containers (requires docker-compose):
fab run-dev-containers
Run the tests:
fab test
1 maintainer
Metadata
1 maintainer
Release files for pgflux 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pgflux-1.1.0.tar.gz | 14.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pgflux-1.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 35.2 kB
Release files / pgflux-1.1.0.tar.gz
| Download URL | pgflux-1.1.0.tar.gz |
|---|---|
| Size | 14.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d099a8fdca1ecb8d7aaaf193dc48bb9d832fd2c0bd908bef251d8a298e812dd
|
|
BLAKE2b-256 checksum How to use checksums |
0648b9409efbbd5c27acc36382db5af9abdf91e77445d58e0bcdd97d18f7cc85
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.7.13
|
Release files / pgflux-1.1.0-py3-none-any.whl
| Download URL | pgflux-1.1.0-py3-none-any.whl |
|---|---|
| Size | 20.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a8865c2f52ad5bff4cad748e6b76256e9336a0ebb9fb81628e7b1b4ed2d0b06e
|
|
BLAKE2b-256 checksum How to use checksums |
a2ee5c60e2da8779ab27a155a843874feb63c3b4a5ef77eadac8c45572d468f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.7.13
|
