健康 - health -- small python tool to check that an http resource is alive
Python Makefile
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
kenkou
tests
.gitignore
LICENSE
MANIFEST.in
Makefile
README.md
circle.yml
kenkou.cfg.example
kenkou_check.cfg.example
requirements.txt
setup.cfg
setup.py

README.md

健康 - kenkou - health

Downloads Build Status Requirements Status Code Coverage

A python based tool to check that a given resource is alive and valid.

It can check on URLs, Certificates and also DNS entries.

All redirects are followed and once the final URL is discovered it is tested for a 2XX result. If a 2XX is returned it is also scanned for mixed-content items if the url is HTTPS. Certificates are verified for any HTTPS site.

Currently it assumes port 443 for TLS and also that the given domain resolves to an IP address.

Designed to be run from a cronjob as often as you want to check the sites.

Note: Kenkou will check to see if the Certifi Python package is installed, and if so, it will use the CA Bundle from that. If not it will check to see if /etc/ssl/certs/ca-certificates.crt exists. If neither is found it will exit with an error if a certificate check was requested.

Usage

python kenkou.py [--config FILE] [--checks FILE] [--cafile FILE] [list,of,namespaces]

Where:
    --config  Configuration file (JSON format)
    --checks  Checks to run (JSON format)
    --cafile  ca-certificates file

    [list,of,namespaces] optional list of which namespaces to process

The output is a based on the value of the "onevent" configuration key:
  "json" (default if not present)
  "pagerduty"
  "postageapp"

Requirements

See requirements.txt for details about what Python modules to install.

Configuration

Example kenkou.cfg file:

{ "pagerduty": {
    "url":    "https://events.pagerduty.com/generic/2010-04-15/create_event.json",
    "method": "POST",
    "params": { "service_key":  "secret",
                "incident_key": "incident_secret",
                "event_type":   "trigger",
                "description":  "FAILURE for production/HTTP"
              }
  },
  "postageapp": {
    "api_key":    "secret",
    "recipients": [ "email@example.com" ]
  },
  "onevent": [ "postageapp" ],
  "checks": "kenkou_check.cfg"
}

kenkou_check.cfg:

{ "web": { "url":  "https://example.com",
           "dns":  { "domain": "example.com",
                     "ip": "127.0.0.1",
                     "namespaces": [ "ns1.dnsimple.com", "ns2.dnsimple.com" ]
                   },
           "cert": "example.com"
         },
  "lb": { "url":  "http://lb.example.com",
          "dns":  { "domain": "lb.example.com",
                    "ip": "127.0.0.1", 
                    "namespaces": [ "ns1.dnsimple.com", "ns2.dnsimple.com" ]
                  },
          "cert": "lb.example.com"
         }
}