Skip to main content
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"
}
}
```

Metadata

Release files for kenkou 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kenkou 0.5.0
File Size Uploaded
kenkou-0.5.0.tar.gz 9.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kenkou 0.5.0
File Interpreter ABI Platform
kenkou-0.5.0-py2-none-any.whl Python 2 none any Details

Total release size: 21.1 kB

Release files / kenkou-0.5.0.tar.gz

Download URL kenkou-0.5.0.tar.gz
Size 9.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e0c529c23b76064747532e926d78a7d5b78f549a3f4c00edd58218ac581e80f4
BLAKE2b-256 checksum
How to use checksums
11bec0402ccad9a2035691a7e8fcc04150eaf56abf0354b58b7417110a4a991f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / kenkou-0.5.0-py2-none-any.whl

Download URL kenkou-0.5.0-py2-none-any.whl
Size 11.3 kB
Tags Python 2
SHA-256 checksum
How to use checksums
490ba8bca1420a4c09f33ff3472af0e283fe20e336313bfa9e3d66ad1f8fe078
BLAKE2b-256 checksum
How to use checksums
e1ec134371683c69ed2537d332ac436c0352251c2a2963430172fb8f2adc10fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.5.5

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

This release

0.5.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page