landrok / webstatus
A PHP library for monitoring Raspbian, Ubuntu or Debian
Installs: 16
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=5.4.0 || ^7.0
- rain/raintpl: >=3.0.0
Requires (Dev)
- codeclimate/php-test-reporter: dev-master
README
It is a simple and easy monitoring tool. It was designed for Raspbian OS but is compatible with Debian and Ubuntu.
There is nothing to configure. Just run the installer and use it.
Want to have a look ? See Live Demo
Features
-
Easy to install
-
A global summary for processor, memory, temperature, disk space, network and more
-
Clear status labels & trends for main metrics
-
Each metric is bounded to a dump of the corresponding shell command result
-
Live monitoring for CPU, memory and network bandwith usage
-
Easy to customize: specific processes, log files
Supported OS
- Raspbian >=8
- Debian >=8
- Ubuntu >=14.04
Install
# Download the latest version wget https://github.com/landrok/webstatus/archive/0.4.0.tar.gz # Unzip tar -xf 0.4.0.tar.gz # Install (Must be done with root rights) ./webstatus-0.4.0/bin/install.sh
If the installation failed:
- Check that your system is up to date
- Create an issue and Copy/Paste installation logs
Easy install
You have a full-automated mode with -y argument:
./webstatus-0.4.0/bin/install.sh -y
Customize title
- Edit app/config/global-custom.ini.php
- In the
[webapp]
section, change-
title
value, for web browser status bar title -
label
value, for the HTML navbar title -
icon
value, must be selected among glyphicons, delete the "glyphicon glyphicon-", just keep the last part of the string.Example: To print an asterisk, the proposed class is
glyphicon glyphicon-asterisk
. Just indicateasterisk
.
-
Hide IP addresses
This feature is only working for IPv4 addresses
- Edit app/config/global-custom.ini.php
- In the
[webapp]
section, sethide-ip
value toon
or1
Customize thresholds
- Edit app/config/global-custom.ini.php
- In the
[thresholds]
section, change-
*.mid
or*.high
values for each metricExample: To have a green flag below 50% CPU usage, an orange flag for CPU usage between 50 and 70%, and a red flag when CPU usage is over 70%, the values should be
cpu.mid=50
andcpu.high=70
-
Customize processes
- Edit app/config/global-custom.ini.php
- In the
[cron]
section, change-
processes.pattern
valueExample: To focus on apache and mysql processes, the value should be
"apache|mysql"
-
Customize logs
Coming soon
Customize menus
Coming soon
Activate remote feature
Remote feature has 2 parts: a client and a server
-
Install webstatus on the 2 machines
-
On the client machine, edit app/config/global-custom.ini.php
- In the
[remote]
section, changeremote.client
value toon
remote.url
value tohttp://your-server-url/webstatus/remote.php
- In the
-
On the server machine, edit app/config/global-custom.ini.php
- In the
[remote]
section, changeremote.server
value toon
- In the
That's all. Now you can follow the client status on the server.