System Monitor

System Monitor is a background service that collects system information and sends it to a server using a POST request.

The data is sent in JSON format.

Settings can be updated in the app.

Interval is the amount of time in seconds the app will wait before checking and sending.

• System Monitor
  • JSON Sent to Server
  • Install on Windows
  • Uninstall on Windows
  • Development Environment
    • Windows
      • Setup
      • Run the server
      • Run the GUI app
      • Run the background service
      • Build the exe
      • Build the installer
    • Darwin / GNU/Linux
      • Setup
      • Run the server
      • Run the GUI app
      • Run the background service
  • Available CLI Commands
  • Server API
    • action
    • Responses

JSON Sent to Server

action: str
system_id: str
url: str
interval: int
epoch: int
stats: object
    cpu: object
        count: int
        frequency: int
        percent_used: float
    memory: object
        total: int
        available: int
        percent_used: float
        used: int
        free: int
    processes: array of objects
        pid: int
        name: str
        username: str
    disks: object
        <device>: object
            file_system: str
            mount_point: str
            total: int
            used: int
            free: int
    network: object
        <network name>: object
            ip: str
            netmask: str
            bytes_sent: int
            bytes_recv: int

Install on Windows

Download the setup exe in inno\Output\system_monitor_setup.exe and run it or click here:

💿 system_monitor_setup.exe

Restart the computer after installation for the background service to start.

Uninstall on Windows

Go to the settings > apps > System Monitor > uninstall

Development Environment

• Windows
• Darwin / GNU/Linux

Windows

NOTE: pyinstaller is required to build the exe, the exe is only built in a Windows environment.

NOTE: Inno Setup is required to build the installer.

Ensure you have python 3.10+ installed.

Setup

Navigate to the project directory.

Create virtual environment

python -m venv venv

This will create a virtual environment in the project directory, like so:

ProjectDir/
    ...
    README.md
    venv/

Activate virtual environment

.\venv\Scripts\activate

Install dependencies

pip install -r .\requirements\main.txt

Run the server

flask --app .\server.py run --debug

Run the GUI app

python .\src\system_monitor.py

Run the background service

python .\src\system_monitor.py background

Build the exe

pyinstaller .\src\system_monitor.py -w -D --noconsole

Build the installer

1. Install Inno Setup (https://www.jrsoftware.org/isdl.php)
2. Open the script inno\system_monitor_setup.iss in Inno Compiler
3. Click on the Run button

Darwin / GNU/Linux

Ensure you have python 3.10+ installed.

Setup

Navigate to the project directory.

Create virtual environment

python3 -m venv venv

This will create a virtual environment in the project directory, like so:

ProjectDir/
    ...
    README.md
    venv/

Activate virtual environment

source venv/bin/activate

Install dependencies

pip install -r requirements/main.txt

Run the server

flask --app server.py run --debug

Run the GUI app

python3 src/system_monitor.py

Run the background service

python3 src/system_monitor.py background

Available CLI Commands

Show stats > cpu

python3 src/system_monitor.py cpu

Show stats > memory

python3 src/system_monitor.py memory

Show stats > processes

python3 src/system_monitor.py processes

Show stats > disks

python3 src/system_monitor.py disks

Show stats > network

python3 src/system_monitor.py network

Generate system id

python3 src/system_monitor.py generate_system_id

Run the background service

python3 src/system_monitor.py background

Server API

The example server is Flask, but this can be any server that can accept POST requests and send the appropriate responses.

action

The system monitor reports its action when sending data to the server.

This is included in the JSON data sent to the server.

{
  "action": <action here>,
  ...
}

These actions are:

• check_url - The system monitor is checking the server URL.
• check_system_id - The system monitor is checking if the system ID is available.
• send_stats - The system monitor is sending stats to the server.

Responses

The server is expected to use HTTP status codes to respond to the system monitor.

For check_url:

A response of 202 is expected to pass the check.

Any other response will be considered a connection error.

For check_system_id:

A response of 200 is expected to let the system monitor know that the username exists on the system.

A response of 204 is expected to let the system monitor know that the connection is fine and that the username does not exist on the system.

Any other response will be considered a connection error.

For send_stats:

A response of 200 is expected to let the system monitor know that the stats were received successfully.