Skip to main content

Monitor batch pipelines via API and email alerts — install and deploy on Linux servers from PyPI

Project description

inferyx-monitoring

Monitor batch jobs from CSV, poll Inferyx API status, and send email (and optional Teams/Google Chat) alerts for failures, missed runs, long-running jobs, and missing API data.

Package: inferyx-monitoring · CLI: inferyx-monitoring · Version: 1.0.28 · PyPI


Documentation

Document Description
docs/GUIDE.md Full pipeline guide — install, configure, operate, troubleshoot
docs/README.md Documentation hub
docs/versions/ Release notes for every version (1.0.15 – 1.0.27)
docs/ADMIN_UI.md Optional web admin (OAuth, .env, batch CSV)

Latest release: 1.0.28 — Admin CLI --help fix, Nginx production guide.


Quick install

sudo mkdir -p /opt/pipeline-monitor && sudo chown inferyx:inferyx /opt/pipeline-monitor
sudo -u inferyx python3 -m venv /opt/pipeline-monitor/.venv
sudo -u inferyx /opt/pipeline-monitor/.venv/bin/pip install --upgrade pip inferyx-monitoring
sudo -u inferyx /opt/pipeline-monitor/.venv/bin/inferyx-monitoring --init-config --work-dir /opt/pipeline-monitor

Edit /opt/pipeline-monitor/.env and batch_file.csv, then follow docs/GUIDE.md for test, systemd, and upgrade steps.

Admin UI (optional):

pip install 'inferyx-monitoring[admin]'
inferyx-monitoring-admin --help    # show options (does not start server on 1.0.28+)

Production setup with Nginx + systemd: docs/ADMIN_UI.md


Version history

Version Summary
1.0.28 Admin CLI --help fix, Nginx docs
1.0.27 Admin UI, security, mail status text
1.0.26 Startup hotfix
1.0.25 Teams / Google Chat
1.0.24 PyPI docs
1.0.21–23 Email fixes
1.0.20 Auto migration
1.0.15–19 Schedule windows, structured email

→ All versions


Upgrade

sudo -u inferyx /opt/pipeline-monitor/.venv/bin/pip install --upgrade inferyx-monitoring
sudo systemctl restart inferyx-monitoring.service

Version-specific steps: docs/versions/


Paths

Item Path
Install /opt/pipeline-monitor
Config /opt/pipeline-monitor/.env
Batch list /opt/pipeline-monitor/batch_file.csv
Service inferyx-monitoring.service

Troubleshooting

Symptom Fix
API errors Base URL without name=; PIPELINE_API_FILTER_BY_SCHEDULE_DATE=false
No email Check SMTP in .env
Service crash (1.0.25) Upgrade to 1.0.26+
Alert send error Upgrade to 1.0.21+

Full table: docs/GUIDE.md § Troubleshooting

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

inferyx_monitoring-1.0.28.tar.gz (46.5 kB view details)

Uploaded Source

Built Distribution

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

inferyx_monitoring-1.0.28-py3-none-any.whl (54.1 kB view details)

Uploaded Python 3

File details

Details for the file inferyx_monitoring-1.0.28.tar.gz.

File metadata

  • Download URL: inferyx_monitoring-1.0.28.tar.gz
  • Upload date:
  • Size: 46.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for inferyx_monitoring-1.0.28.tar.gz
Algorithm Hash digest
SHA256 15d28640cf62316d48129c6630e617e9127b0684d21927d4f0b4e32fa1ce2172
MD5 8eb38d48b742263cf427ca9c261873e7
BLAKE2b-256 e108a81275fb68090efc3892fd60715f02add21ea750fbed0f9361dc9865be30

See more details on using hashes here.

File details

Details for the file inferyx_monitoring-1.0.28-py3-none-any.whl.

File metadata

File hashes

Hashes for inferyx_monitoring-1.0.28-py3-none-any.whl
Algorithm Hash digest
SHA256 977aa0b421d8dbf549ec490209cd030e721ff7cb6e1dc57c2ec834da84861d9b
MD5 1bd6ca9f55e27f26ae25cb83fb61eb84
BLAKE2b-256 857a6a9ce784a1eb9077247343cf1b10123de5fa97a615f10d968d2116a0d98c

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