ServerStatus

Description

ServerStatus is a daemon that can be used on UNIX operation systems to create JSON files that contain system status informations. The general idea is to provide these files via http, https, ftp or any other way and let remote devices parse these informations.

An example is the iPad app StatusBoard that can print all these files in beautiful charts.

Dependencies

####Build dependencies

1. Any C++ compiler that supports C++11 (e.g. GCC 4.7 and above, clang 2.9 and above, ...).
2. libconfig (Link)
3. For optional data encryption: OpenSSL (Link)

####Runtime dependencies

1. libconfig
2. OpenSSL (optional encryption)
3. Any other third-party application to monitor an aspect of your server (e.g. smartmontools for HDD temperature)

####Installation#### If either GCC or clang is installed on your system all you need to do is to run:

 gmake install clean     # FreeBSD
  - or - 
 make install clean      # Debian / Ubuntu / OS X    

If you want to use a different C++ compiler you have to manually edit the Makefile and set CC = your_g++_compiler.

By default ServerStatus will be installed into a directory that allows to run it as a service:

 /usr/local/etc/rc.d/      # FreeBSD
  - or -
 /etc/init.d/              # Ubuntu / Debian
  - or - 
 /usr/local/bin/		   # OS X

Configuration

ServerStatus is looking for a configuration file named serverstatus.cfg and has to be located either at /etc/or at /usr/local/etc/.

A sample configuration file will be copied to /usr/local/etc/ if ServerStatus is installed with the provided Makefile.

The sample configuration file is written for FreeBSD. However, at the end of this readme file there will be collection of commands for different UNIX systems that can be used on Debian or Ubuntu.

Data Distribution

ServerStatus distinguishes between three modes:

1. If you only use it to monitor one server it can run in "standalone" mode. This will execute commands on your local system and provide these information.
2. However, if you own multiple servers (or jails) the distributed functions might come handy. ServerStatus can run as "server" which will extend the "standalone" functions with the ability to receive information from other systems
3. Or ServerStatus can run as "client". This will execute commands on the client and send their output to a "server" instance which will then use these transmitted information.

SSL

ServerStatus supports encrypted communication between client and server if using OpenSSL. All that is required is a SSL certificate which can be created using the following command:

openssl req -x509 -nodes -days 365 -newkey rsa:1024 -keyout serverstatus.pem -out serverstatus.pem

Specify the path of the certificate and key-file inside the cfg file.

Note: If you use the command above both certificate and key-file are the same (serverstatus.pem).

How to use...

You can start ServerStatus manually by running:

 service serverstatus start

But you might want to consider to add ServerStatus to your autostart programs so that your systems status can be monitored right after your system started.

Note: With the latest changes, ServerStatus will require root privileges to run.

Commands

The following commands return a numeric value without any units that can be used with serverstatus without any problems.

####CPU temperature####

OS	Command
FreeBSD	sysctl -n dev.cpu.<CORE>.temperature | sed 's/C//g' If not enabled run: kldload coretemp

####Load####

OS	Command
All	Load 1 Load 5 Load 15	uptime | awk '{print $(NF)}' | sed 's/,/./' uptime | awk '{print $(NF-1)}' | sed 's/,/./' uptime | awk '{print $(NF-2)}' | sed 's/,/./'

####HDD temperature####

OS	Command
FreeBSD	smartctl -a /dev/<DISC> | awk '/Temperature_Celsius/{print $0}' | awk '{print $10}'

####Disc Space####

OS	Command
All	Free Used	df | grep ^<MOUNT> | awk '{print $3}' df | grep ^<MOUNT> | awk '{print $4}'

####Memory####

OS	Command
FreeBSD	Active Inactive Wired Buffered Free	top -d1 | grep ^Mem | awk '{print $2}' | sed 's/M/000000/' | sed 's/K/000/' top -d1 | grep ^Mem | awk '{print $4}' | sed 's/M/000000/' | sed 's/K/000/' top -d1 | grep ^Mem | awk '{print $6}' | sed 's/M/000000/' | sed 's/K/000/' top -d1 | grep ^Mem | awk '{print $8}' | sed 's/M/000000/' | sed 's/K/000/' top -d1 | grep ^Mem | awk '{print $10}' | sed 's/M/000000/' | sed 's/K/000/'
Debian	Used Buffered Cached Free	free -m | egrep ^-/+ | awk '{print $3}' free -m | egrep ^Mem | awk '{print $6}' free -m | egrep ^Mem | awk '{print $7}' free -m | egrep ^Mem | awk '{print $4}'

####Network####

OS	Command
FreeBSD	In Out	netstat -I <INTERFACE> -b | awk '{ if (/Link/) { print $8 } }' netstat -I <INTERFACE> -b | awk '{ if (/Link/) { print $11 } }'
Debian	In Out	ifconfig wlan0 | grep "RX bytes" | awk '{ print $2 }' | sed 's/bytes://' ifconfig wlan0 | grep "RX bytes" | awk '{ print $6 }' | sed 's/bytes://'