ObjMonitor API

Method	Signature	Description
system_run	`system_run(command: str, timeout: int = 10) -> str`	Run a system command and return its output.
check_environment	`check_environment() -> Dict[str, Any]`	Performs a comprehensive check of the system's environment.
run_monitor_preflight	`run_monitor_preflight() -> bool`	Run the full preflight suite plus Monitor-specific Proxmox check.
sync_to_def_host	`sync_to_def_host() -> dict`	Collect local system info and upsert
sync_wireguard_status	`sync_wireguard_status() -> list`	Check WireGuard tunnel status and update
sync_proxmox_hosts	`sync_proxmox_hosts() -> int`	Scan Proxmox for all LXCs and update
poll_snmp_hosts	`poll_snmp_hosts(community: str = 'public', timeout: int = 3, max_workers: int = 20) -> int`	Poll all SNMP-enabled hosts in parallel
poll_proxmox	`poll_proxmox() -> int`	Poll Proxmox API for per-LXC metrics.
poll_routeros	`poll_routeros() -> int`	Poll MikroTik RouterOS API for
poll_synology	`poll_synology() -> int`	Poll Synology NAS DSM API for
poll_rabbitmq	`poll_rabbitmq() -> int`	Poll RabbitMQ management API for
poll_local	`poll_local() -> int`	Poll the local host via psutil.
poll_all	`poll_all() -> dict`	Run all poll sources and return
collect_fast	`collect_fast() -> Dict[str, Any]`	Lightweight system snapshot — CPU, memory, and disk only.
get_status_json	`get_status_json() -> str`	Build a comprehensive system status snapshot
get_supervisor_services_summary	`get_supervisor_services_summary() -> dict`	Parse `supervisorctl status` into a nested
check_and_create_tables	`check_and_create_tables() -> None`	Checks for the existence of monitor-related tables and creates them
get_ip_address	`get_ip_address(host: str = '') -> str`	Retrieves the local IP address of the machine.
get_ip_gateway	`get_ip_gateway(host: str = '') -> str`	Retrieves the IP address of the default gateway.
read	`read(client: str, host: str) -> None`	Reads host information from the database and populates instance attributes.
create	`create(client: str = '', host: str = '') -> None`	Creates a new host entry in the database if it doesn't already exist.
update	`update() -> str`	Updates the host's details in the database.
collect_db	`collect_db() -> None`	Collects database-related metrics such as uptime and version.
collect_dns	`collect_dns(context: dict) -> None`	Collects DNS information for a configured domain.
run_collection	`run_collection(mode: str, arg2: str = '', arg3: str = '') -> Dict[str, Any]`	Executes various data collection routines based on the specified mode.
get_cpu_counts	`get_cpu_counts() -> None`	Prints the number of logical and physical CPUs using psutil.
select_compute	`select_compute() -> None`	Presents interactive options for selecting a data collection event.
collector_sink	`collector_sink() -> None`	Start the MQTT collector sink (placeholder).
collect_all_processes	`collect_all_processes(process_filter: str) -> None`	List running Python processes matching a
scan_log	`scan_log(log_file_path: str) -> None`	Scan an access log file for anomalies
SingleInstance	`SingleInstance(service_name: str) -> bool`	Check whether only one instance of the
micro_service	`micro_service() -> None`	Run the monitor as a continuous

Method	Signature	Description
run	`run() -> None`

¶ ObjMonitor (API Reference)

¶ class Monitor(ObjMonitorPingMixin, ObjMonitorLoginMixin, ObjMonitorCommandMixin, ObjMonitorSecurityMixin, ObjMonitorCollectorMixin, ObjMonitorPersistMixin, ObjMonitorReportMixin, ObjData.ObjData)

¶ class ObjMonitorTUI

¶ tui()

¶ preflight()

¶ collect(mode: str = typer.Argument(..., help='Mode of collection: fast, complete, or daily'))

¶ cpu_count()

¶ sink()

¶ upload()

¶ alert()

¶ process()

¶ log()

¶ service()

¶ snmp_poll(community: str = typer.Option('public', help='SNMP community string'))

¶ poll_all()

¶ check_virt()

¶ status()

¶ main(ctx: typer.Context)