prometheus_flask_exporter

(★ 685)

Prometheus exporter for Flask applications

File Explorer

Download Latest Version (.zip)

- - test-and-publish.yml
- flask_webapp.json
- - Dockerfile
  - endpoint.py
  - main.py
  - my_api.yaml
  - README.md
  - run_tests.sh
- - Dockerfile
  - httpauth_example.py
  - README.md
  - run_tests.sh
- - Dockerfile
  - processes_example.py
  - README.md
  - run_tests.sh
- - app.py
  - Dockerfile
  - README.md
  - run_tests.sh
- - config.py
  - Dockerfile
  - README.md
  - requirements.txt
  - run_tests.sh
  - server.py
- - app_setup.py
  - config.py
  - Dockerfile
  - README.md
  - requirements.txt
  - run_tests.sh
  - server.py
- - config.py
  - Dockerfile
  - README.md
  - requirements.txt
  - run_tests.sh
  - server.py
- - config.py
  - Dockerfile
  - README.md
  - requirements.txt
  - run_tests.sh
  - server.py
- - Dockerfile
  - README.md
  - requirements.txt
  - run_tests.sh
  - server.py
- - Dockerfile
  - run_tests.sh
- - Dockerfile
  - reload_example.py
  - run_tests.sh
- - Dockerfile
  - README.md
  - run_tests.sh
  - server.py
- - Dockerfile
  - README.md
  - run_tests.sh
  - server.py
- - Dockerfile
  - README.md
  - run_tests.sh
  - server.py
- - dashboard.png
  - docker-compose.yml
  - README.md
- - Dockerfile
  - README.md
  - requirements.txt
  - run_tests.sh
  - server.py
- - Dockerfile
  - endpoint.py
  - main.py
  - my_api.yaml
  - README.md
  - run_tests.sh
- - Dockerfile
  - README.md
  - requirements.txt
  - run_tests.sh
  - server.py
- - app.py
  - Dockerfile
  - httpd.conf
  - README.md
  - requirements.txt
  - run_tests.sh
  - wsgi.py
- __init__.py
- multiprocess.py
- test_app_factory.py
- test_blueprint.py
- test_defaults.py
- test_endpoint.py
- test_extensions.py
- test_group_by.py
- test_metric_initialization.py
- test_metrics.py
- unittest_helper.py
.gitignore
LICENSE
MANIFEST.in
prepare_release.sh
README.md
requirements.txt
setup.py

🚀 Installation Guide

1. Get the code

git clone https://github.com/rycus86/prometheus_flask_exporter

Downloads the entire project code from GitHub to your computer.

cd prometheus_flask_exporter

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install prometheus-flask-exporter

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -f examples/connexion-pydantic/Dockerfile -t prometheus-flask-exporter .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 prometheus-flask-exporter

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install prometheus-flask-exporter

Installs the package published on PyPI directly — no need to clone the source.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.