Simple HTTP process monitor

This module allows to scan for responses of certain HTTP addresses.

License

Method

Very simple: a series of URLs for GET requests is defined and queried. The results are stored in a JSON data file. This file is updated in subsequent executions. Other later added (pseudo-)protocols are processed in the same manner (mysql, ssh). Keeo in mind, Python stands here always for Python3.

Requirements

• Python 3 installed. Python
• Module requirements are resolved by setup.py
• Internet connection for setup

Overview

Installation and execution

Fetch the source:

git clone [email protected]:bernd-clemenz/pmon.git

The tool is a simple Python 3 module it can be installed manually into the local Python 3 environment by switching to the directory with pmon files and executing

python setup.py install

After installation it can be executed with the command:

python -m pmon [--conf=full-config-file-name] [--server=(True|False)] [--nomail=(True|False)]

Running the 0MQ responder:

python -m pmon [--conf=full-config-file-name] [--responder=(True|False)] [--nomail=(True|False)]

If one does not want to install it, it can be run just by switching to the directory and executing:

python -m pmon

Name	Description
conf	name of the configuration file
server	flag to start the internal HTTP server
responder	flag to start the internal 0MQ responder
nomail	flag to send no mail after processing

Automated execution via 'cron'

@reboot python -m pmon --conf=/configpath/pmon.ini --server=True --nomail=True

@daily python -m pmon --conf=/configpath/pmon.ini

Configuration

The module is configured via an traditional ini file. If no name is given the config file name defaults to pmon.ini.

Section 'pmon'

The general configuration of the tool.

Name	Description
id	Identifies the instance of the monitor. Set it to a unique number
data.file	Name of the file, to store the results for further evaluation
latest.file	Name of JSON file for just the latest result.
log.file	Name of log output file
log.level	Logging output level. Supported values are: DEBUG, INFO, WARN, ERROR, FATAL
timeout	Wait for response in seconds until fail
http.port	Port of http if the server module is started
http.bind	To what IP to bind the server, typically 0.0.0.0
http.public	public directory for the UI

Section 'urls'

A dynamic section where the URLs for GET access are configured. The entries follow the pattern url.XX where XX is a number, unique to the section.

Section 'remote'

This section contains sets keys prefixed with url-identifiers. The section is also dynamic.

Name	Description
url.XX.user	Name of a remote user
url.XX.pwd	Password
url.XX.process	string to search in command result
url.XX.scan_cmd	command to produce process list
url.XX.type	ssh only supported type in version 0.0.1
url.XX.log.dir	location of the log directory to scan
url.XX.log.pattern	grep pattern to scan in logs
url.XX.log.files	glob for to select the log files to scan

Section 'email'

Name	Description
server	mail server name or ip
port	the smtp port
pwd	the password of the mail sender
from	Mail address of the mail sender
to	comma separated list of mail addresses to notify

Example

[pmon]
id=isc_001
data.file = pmon.json
latest.file = current.json
log.file = pmon.log
log.level = INFO
http.port = 8080

[urls]
url.1 = https://some-valid-url.io
url.2 = http://invalid.url.io
url.3 = mysql://some-ip

[remote]
url.2.user = pi
url.2.pwd = raspberry
url.2.process = python com_srv.py
url.2.scan_cmd = sudo ps aux
url.2.type = ssh
url.3.user = pi
url.3.pwd = blubber1234
url.3.type = ssh
url.3.scan_cmd = sudo mysqladmin ping

Result

Every execution adds to the URL-named lists. The result codes are:

Code	Description
SUCCESS	All good
EXCEPTION_ERROR	Something in the environment went wrong, like network or system unavailable.
APPLICATION_ERROR	Service is there, but could not respond error-free to the request

The rest of the entries are self-explanatory.

{
    "http://invalid.url.io": [
        {
            "message": "HTTPConnectionPool(host='invalid.url.io', port=80):",
            "result": "EXCEPTION_ERROR",
            "time": "2018-07-17 00:16:53.259895"
        }
    ],
    "https://some-valid-url.io": [
        {
            "message": "OK",
            "result": "SUCCESS",
            "time": "2018-07-17 00:16:45.709041"
        }
    ],
    "https://some-valid-url.io/invalid-file.html": [
        {
            "message": 404,
            "result": "APPLICATION_ERROR",
            "time": "2018-07-17 00:16:55.263712"
        }
    ],
    "mysql://192.168.1.11": {
      "message": "OK",
      "result": "SUCCESS",
      "time": "2018-12-08 16:16:36.838626"
  }
}

Complex remote operations

The module can also perform some simple remote data digging, if access is configured. For more complex things it's recommended to use tools like Salt.

Copyrights

This repository contains Jquery and JqueryUI the copyrights remain with the respective owner(s).

Hints

Create a virtual Python environment for the project and activate it with:

cd YOUR_PROJECT_HOME
source venv/Scripts/activate

0MQ responder

With the parameter --responder=True a ver simple 0MQ listener of type REQ is launched. It receives messages and can perform some action according to the messages. The simplest one is forwarding the content to a 'incoming Slack-Webhook'. I found this particular useful for a simple lightweight and asynchronous notification system. The responder goes beyond the idea of a simple monitoring system it allows actions some, getting more like Salt, but with a limited scope. However, it requires an active sender, something like an monitoring-agent.

Additional sources

• Paramiko
• Requests
• ps command
• Cherrypy
• jQuery
• jQueryUI
• 0MQ
• 0MQ client/server
• Java 0MQ/jeroMQ