Skip to content

Latest commit

 

History

History
52 lines (47 loc) · 1.41 KB

README.md

File metadata and controls

52 lines (47 loc) · 1.41 KB
Raw

HeaCat-API - The System Monitoring API

Introduction

HeaCat-API is a system monitoring API that provides information about the system's health and performance. It is designed to be used by system administrators and developers to monitor the system's health and performance. The API provides information about the system's CPU usage, memory usage, disk usage, network usage and more. It also provides information about the system's uptime, load average, and other system metrics.

Features

  • CPU monitoring
  • Memory monitoring
  • Disk monitoring (W.I.P)
  • System Information API

Installation

  1. Clone the repository
git clone https://github.com/heacat/heacat-api.git
  1. Install the dependencies
cd heacat-api
go mod tidy
  1. Build the project
go build src/main.go
  1. Run the project
./main

Usage

  1. Create a config file
cp config-example.yaml config.yaml
nano config.yaml                  # or use your favorite text editor
  1. Run the program
./main

API Endpoints

  • /api/v1/sysinfo - Get system information
  • /api/v1/cpu - Get CPU information
  • /api/v1/gpu - Get GPU information
  • /api/v1/memory - Get memory information
  • /api/v1/disk - Get disk information
  • /api/v1/network - Get network information
  • /api/v1/check/cpu - Check CPU usage
  • /api/v1/check/memory - Check memory usage
  • /api/v1/check/disk - Check disk usage
  • / - API Map