Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A python based tool to check that a given resource (URL, Certificate and DNS entry) is alive and valid.

Project Description
kenkou
======
健康 - kenkou - health

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](https://certifi.io/en/latest/) 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 [-c|--config FILENAME]

Where:
-c --config Configuration file (json format)

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:

```json
{ "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:

```json
{ "web": { "url": "https://example.com",
"dns": [ "example.com", "127.0.0.1",
[ "ns1.dnsimple.com", "ns2.dnsimple.com" ]
],
"cert": "example.com"
},
"lb": { "url": "http://lb.example.com",
"dns": [ "lb.example.com", "127.0.0.1",
[ "ns1.dnsimple.com", "ns2.dnsimple.com" ]
],
"cert": "lb.example.com"
}
}
```
Release History

Release History

This version
History Node

0.5.5

History Node

0.5.4

History Node

0.5.3

History Node

0.5.2

History Node

0.5.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
kenkou-0.5.5-py2-none-any.whl (14.2 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Dec 21, 2015
kenkou-0.5.5.tar.gz (9.7 kB) Copy SHA256 Checksum SHA256 Source Dec 21, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting