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.0.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

kenkou-0.5.0-py2-none-any.whl (11.3 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for kenkou-0.5.0.tar.gz
Algorithm Hash digest
SHA256 e0c529c23b76064747532e926d78a7d5b78f549a3f4c00edd58218ac581e80f4
MD5 96580ddef5bd183d3ec28fd49c4c2845
BLAKE2b-256 11bec0402ccad9a2035691a7e8fcc04150eaf56abf0354b58b7417110a4a991f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kenkou-0.5.0-py2-none-any.whl
Algorithm Hash digest
SHA256 490ba8bca1420a4c09f33ff3472af0e283fe20e336313bfa9e3d66ad1f8fe078
MD5 c46392f1efb0c0a3701411dfdd04be02
BLAKE2b-256 e1ec134371683c69ed2537d332ac436c0352251c2a2963430172fb8f2adc10fe

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