Skip to main content

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"
}
}
```

Project details


Download files

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

Source Distribution

kenkou-0.5.5.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

kenkou-0.5.5-py2-none-any.whl (14.2 kB view details)

Uploaded Python 2

File details

Details for the file kenkou-0.5.5.tar.gz.

File metadata

  • Download URL: kenkou-0.5.5.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for kenkou-0.5.5.tar.gz
Algorithm Hash digest
SHA256 f8698384b9019151d16883982c52101bb2e30a936b8a8b9f1bdd332026846ff5
MD5 595b398534a4a7ba76908daa5911ed00
BLAKE2b-256 877c3927818aa80da9ddab55cd63f1be18f856da7bc0f6c871b44eaafc5dcd18

See more details on using hashes here.

File details

Details for the file kenkou-0.5.5-py2-none-any.whl.

File metadata

File hashes

Hashes for kenkou-0.5.5-py2-none-any.whl
Algorithm Hash digest
SHA256 8fcb9d7c4986a62b9b7410d766c8354eb8e7530710b887c662e1ef0fb9721952
MD5 13ba2cc719f698822e9d5754639c12c0
BLAKE2b-256 aa54d68cf7057c5f3ebda37dad115b5d5a65273f6541774385433fa754229521

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page