Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juanhuttemann/go-server-monitor-api
Gathers and Publish information about the Hardware, OS, Network and Processes of the current running machine through a JSON API (Linux & Windows Compatible)
https://github.com/juanhuttemann/go-server-monitor-api
api go golang json monitor
Last synced: about 1 month ago
JSON representation
Gathers and Publish information about the Hardware, OS, Network and Processes of the current running machine through a JSON API (Linux & Windows Compatible)
- Host: GitHub
- URL: https://github.com/juanhuttemann/go-server-monitor-api
- Owner: juanhuttemann
- License: mit
- Created: 2019-07-01T23:02:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-16T04:04:43.000Z (over 4 years ago)
- Last Synced: 2024-06-20T14:21:28.031Z (5 months ago)
- Topics: api, go, golang, json, monitor
- Language: Go
- Size: 202 KB
- Stars: 26
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-server-monitor-api
Gathers and Publish information about the Hardware, OS, Network and Processes of the current running machine through a JSON API (Linux & Windows Compatible)
#### Clone
```sh
git clone [email protected]:juanhuttemann/go-server-monitor-api.git
```
#### Dependencies
```sh
go get github.com/shirou/gopsutil/cpu
go get github.com/shirou/gopsutil/disk
go get github.com/shirou/gopsutil/host
go get github.com/shirou/gopsutil/mem
go get github.com/mitchellh/go-ps
go get github.com/spf13/viper
```
#### Build
```sh
go build -o gomonitor src/*.go
```
#### Usage
```sh
./gomonitor
```
Then go to your web browser at [http:\//localhost:3000](http://localhost:3000)
### JSON Data References
* **hostInfo** (object)
* name (string): Host name
* os (string): Operative System
* arch (string): x86/x64
* platform (string): OS Name, Version and Build
* uptime (integer): amount of seconds since bootup
* **cpu** (object)
* name (string): Brand - Model of the Physical CPU
* total (integer): Amount of Physical Cores
* usage (float): Percentage of Physical CPU Usage
* usagePerCore (Array): Array of Percentage of Logical CPU Usage
* **ram** (object)
* free (integer): Available Physical RAM in bytes
* total (integer): Total of Physical RAM in bytes
* usage (integer): Usage of Physical RAM in bytes
* **disks** (array of objects)
* mountPoint (string): Disk current mount path or Unit in Windows
* size (integer): Total Disk space in bytes
* used (integer): Used Disk space in bytes
* percent (integer): Percentage of Disk Usage
* **networkDevices** (array of objects)
* name (string): Name of the Network Interface
* addresses (array of objects):
* cidr (string): Classless Inter-Domain Routing
* ip (string): IP Address
* mac (string): Mac Address
* up (boolean): If the Net Interface is Up or Down
### Custom Settings
#### Webserver API Port
By default, the embedded server start on port 3000. We can provide a different value in the config.yml file:
```
# api server port
port: 45000
```
#### Modules
For enabling/disabling modules just edit the config.yml file changing the values by **true** or **false**
```
#available modules
hostInfo: true
cpu: true
ram: true
disks: true
networkDevices: false
networkBandwidth: true
processes: false
```