| Endpoint | Method | Description |
|---|---|---|
/health |
GET | Returns 200 OK |
/metrics |
GET | Returns the all system metrics(cpu,memory,disk,host) |
/metrics/cpu |
GET | Returns the system cpu metrics |
/metrics/memory |
GET | Returns the system memory metrics |
/metrics/disk |
GET | Returns the system disk metrics |
/metrics/host |
GET | Returns the system host informations |
/ws/metrics |
GET | Returns the all system metrics(cpu,memory,disk,host) in every n seconds (n=2) |
{
"physical_core": integer, // Physical cores
"logical_core": integer, // Logical cores aka Threads
"frequency": integer, // Frequency in mHz
"current_frequency": integer, // Current Frequency in mHz
"temperature": float, // Temperature in Celsius
"free_percent": float, // Free percentage //* 1- Usage
"usage_percent": float // Usage percentage //* Total - Idle / Total
}{
"total_bytes": integer, // Total space in bytes
"available_bytes": integer, // Available space in bytes
"used_bytes": integer, // Used space in bytes //* Total - Free - Buffers - Cached
"usage_percent": float // Usage Percent //* (Used / Total) * 100.0
}[
{
"read_speed_bytes": integer, // WIP
"write_speed_bytes": integer, // WIP
"total_bytes": integer, // Total space of "/" in bytes
"free_bytes": integer, // Free space of "/" in bytes
"usage_percent": float // Usage Percent of "/"
}
]{
"os": string, // linux, darwin, windows
"platform": string, // arch, debian, suse...
"kernel_version": string, // 6.10.10, 6.0.0, 6.10.0-zen...
}| CPU | GNU/Linux | Windows | MacOS |
|---|---|---|---|
| Physical Core Count | ✅ | - | - |
| Logical Core Count | ✅ | - | - |
| Frequency | ✅ | - | - |
| Current Frequency | ✅ | - | - |
| Temperature | ✅ | - | - |
| Free Percent | ✅ | - | - |
| Usage Percent | ✅ | - | - |
| Memory | GNU/Linux | Windows | MacOS |
|---|---|---|---|
| Total Bytes | ✅ | - | - |
| Available Bytes | ✅ | - | - |
| Used Bytes | ✅ | - | - |
| Usage Percent | ✅ | - | - |
| Disk | GNU/Linux | Windows | MacOS |
|---|---|---|---|
| Read Speed Bytes | - | - | - |
| Write Speed Byres | - | - | - |
| Total Bytes | ✅ | - | - |
| Free Bytes | ✅ | - | - |
| Usage Percent | ✅ | - | - |
| Host | GNU/Linux | Windows | MacOS |
|---|---|---|---|
| OS | ✅ | - | - |
| Platform | ✅ | - | - |
| Kernel Version | ✅ | - | - |
-
Git Clone
git clone REPO_LINK
-
Change your directory
cd bluewave-uptime-agent -
Install dependencies
go mod download
-
Build the project
just build
or
go build -o bwuagent ./cmd/bwuagent/
-
Run the project
./bwuagent
or
go run ./cmd/bwuagent/
-
Environment Variables
If you want to change the port, api secret or allow public api, you can use this environment variables.
PORT = your_port API_SECRET = your_secret ALLOW_PUBLIC_API = true/false GIN_MODE = release/debug
Usage:
PORT=8080 API_SECRET=your_secret ALLOW_PUBLIC_API=true GIN_MODE=release ./bwuagent