ays-agent

The At Your Service Agent Sensor is a Python app that allows you to monitor a system.

The agent provides a few mechanisms to report status to @ys. You can:

• Use the built-in resource usage agent. This will send CPU, HDD, RAM, and/or network usage to @ys.
• Call the agent as a one-shot script with a value or status.
• Execute a program, on a specified interval, and report the values it produces.

This agent integrates directly with the Agent Sensor Service. Therefore, the property values provided to the CLI app are the same as those described in the documentation. For example, the alerting levels (critical ... warning), status states (critical ... healthy), etc. use the same parameter values.

Installation

Install using pip (requires Python v3.8+).

pip install ays-agent

TODO: Windows self-contained installer

What Next?

Please refer to

• API documentation
• Usage examples