This Go project implements a simple TCP server that responds to custom commands over the network. The server performs various system-related tasks and provides
information such as CPU usage, memory status, network statistics, storage details, and system uptime.
This Go project implements a simple TCP server that responds to custom commands over an internal network. The server performs various system-related tasks and provides information such as CPU usage, memory status, network statistics, storage details, and system uptime.
## Commands
The protocol supports the following commands:
- `cpu`: Returns the CPU usage as a percentage.
- `memory`: Returns the memory usage as a percentage.
- `network`: Returns the network statistics as a JSON object.
- `storage`: Returns the storage details as a JSON object.
- `uptime`: Returns the system uptime as a string.
## Usage
1. **Build the Server:**
```bash
CGO_ENABLED=0 GOARCH=<arch> go build -a -ldflags '-s -w' -o ./out/stats-server main.go
```bash shell
$ CGO_ENABLED=0 GOARCH=<arch> go build -a -ldflags '-s -w' -o ./out/stats-server main.go
```
2. **Run the Server:**
```bash
./out/stats-server
```bash shell
$ ./out/stats-server serve
```
3. **Connect to the Server:** Use a TCP client to connect to the server on port 12345. You can send commands like "cpu," "memory," "network," "storage,"
"uptime," and "exit."
3. **Connect to the Server:** Use a TCP client to connect to the server on port 12345. You can send commands like "cpu", "memory", "network", "storage" or
"uptime".
Example using `nc`:
```bash
echo "cpu" | nc localhost 12345
```bash shell
$ time ( echo "cpu" | nc <hostname> 12345 )
```
or using golang
or directly using golang:
```go
import "net"
func main() {
conn, err := net.Dial("tcp", "localhost:12345")
if err != nil {
// handle error
}
defer conn.Close()
conn, _ := net.Dial("tcp", "<hostname>:12345")
conn.Write([]byte("cpu"))
}
data, _ := io.RealAll(conn)
log.Printf("data: %s", data)
```
## GitHub Actions Workflow
The included GitHub Actions workflow automates the build and release process. On each push to the main branch, the workflow builds the Go program, creates a
GitHub release, and uploads the compiled binary as an artifact.
The included GitHub Actions workflow automates the build and release process. On each push to the main branch, the workflow builds the Go program, creates a GitHub release, and uploads the compiled binary as an artifact.
## Self-Installing Binary
Assuming you have a cluster of machines, you can use the following commands to download and install the latest version of the binary on all nodes. You must have root access to all nodes.
Assuming you have a cluster of machines, you can use the following commands to download, install and setup systemd services for the latest version of the binary on all nodes. You must have root access to all nodes.
