A python-based script to provide the JSON-based output for HetrixTools server monitoring. See [HetrixTools](https://github.com/hetrixtools/agent) https://docs.hetrixtools.com/category/server-monitor/
Go to file
Nicholas Hope e5b5136e9c created a to-do list 2024-03-24 12:05:58 -04:00
docs updated 2023-10-03 09:19:59 -04:00
src created a to-do list 2024-03-24 12:05:58 -04:00
.gitignore Initial draft 2023-10-03 08:53:47 -04:00
AUTHORS.rst initial commit 2023-10-02 15:35:01 -04:00
CHANGELOG.rst Initial drafts 2023-10-03 08:53:15 -04:00
CONTRIBUTING.rst Initial adds 2023-10-04 08:52:34 -04:00
LICENSE.txt Switched to BSD-3-Clause 2023-10-03 09:30:52 -04:00
README.rst Switched from README.md to README.rst 2023-10-03 09:21:17 -04:00
pyproject.toml Initial adds 2023-10-04 08:52:34 -04:00
setup.cfg Discovered and added jc dependency 2023-10-04 15:35:37 -04:00
setup.py Initial adds 2023-10-04 08:52:34 -04:00
tox.ini Initial adds 2023-10-04 08:52:34 -04:00

README.rst

.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold :alt: Project generated with PyScaffold :target: https://pyscaffold.org/ | =================== hetrixtools-freebsd =================== A Python script that collects monitoring data from FreeBSD_ hosts for HetrixTools_ The original `Linux-based HetrixTools`_ script is based on ``bash`` and uses a lot of ``sed`` and silly tricks to parse various kinds of Linux data. At the end of the day, we need to produce some JSON output with some values Base64 encoded and submit it to the HetrixTools monitoring service. This allows them to see things like RAM usage, disk usage, load average, etc. The Linux-based script uses a lot of Linux-specific mechanisms like querying ``/proc`` and parsing it. These methods don't work on FreeBSD. This aims to be a long-lived daemon process in python that periodically wakes up, gathers some data, uploads it to the API, and goes to sleep. I was going to adapt the `OpenBSD agent`_ but that was (a) written against an older version of the HetrixTools API, and (b) still using too much ``bash`` and ``sed`` nonsense. Python seemed like the right tool for the job. .. _pyscaffold-notes: .. _HetrixTools: https://hetrixtools.com/ .. _FreeBSD: https://freebsd.org/ .. _Linux-based HetrixTools: https://github.com/hetrixtools/agent .. _OpenBSD agent: https://github.com/sholwe/hetrixtools-agent-openbsd Note ==== This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.