schulzwill/pyhealthchecker

Flask HealthChecker APP

PyHealthChecker

PyChecker is a Python 3.7 RESTful health-checker API using Flask, SQLite, and APScheduler.

Usage

1. Clone this repository or its image;
2. Follow the instructions below to have it running
3. Send an HTTP Post to the http://server:port/application following the example:

POST /application HTTP/1.1
Host: localhost:5000
Content-Type: application/json

{
    "name":"My App",
    "check_interval": 20,
    "check_data":{
    	"method":"GET",
        "endpoint":"http://localhost:5000/check",
    	"headers":"",
    	"body":""
    },
    "expected":{
    	"code": "200",
    	"headers":"",
    	"body":""
    },
    "http_notification":{
    	"method":"POST",
    	"headers":{"Content-Type": "application/json","Authorization": "Bearer 12345678901234567890123456789"},
    	"endpoint":"https://some.notification.server",
    	"body":{"service": "${FAILING_SERVICE}","description": "${FAILING_SERVICE_DESCRIPTION}"}
    }
}

This POST will create an application entry, named "My App" and a task to verify it every X seconds, defined in the "check_interval" variable. Our PyHealthCheck then will try to reach "My App" by the means defined in the "check_data" using the response of that call to compare with the "expected" one. If there are more differences between the actual response and the expected data OR the service fails to answer, a notification will be sent over HTTP using the data on the "http_notification".

All other endpoints and its examples are covered in this read.me and the postman collection.

Installation on Dev Environment

Clone this repository and then run use the package manager pip to install it.

pip install -r ./requirements.txt

After packages installation , run ./app.py

python3 run app.py

Running in Docker

Clone this repository and then run:

docker build . -t pyhealthchecker

Once the image has been built, run

docker run -p 5000:5000 pyhealthchecker

Testing

There is a Postman Collection available for local and remote tests

You can also run the ./load.sh to make some initial requests and validations.

On Linux and MacOS environments, you will need to give permissions to the bash file:

chmod +x load.sh 

Now, run the curl initial file

./load.sh

All logs will be written on ./app.log .

Distributing

The docker image of this project is available at Docker Hub and can be pulled and executed independently:

 docker pull schulzwill/pyhealthchecker

Running on K8s

All files necessary are included in the k8s folder of this project.

To deploy this solution in an already existing Kubernetes cluster:

1. Clone this repository and go to its root folder
2. Create the namespace:

kubectl create -f ./k8s/ns-pyhealthchecker.yaml 

3. Create the service for PyHealthChecker Application

kubectl create -f ./k8s/service-pyhealthchecker.yaml 

4. Deploy it:

kubectl create -f ./k8s/deployment.yaml

To check if it is up and running:

kubectl get deployment pyhealthchecker -n pyhealthchecker

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT