rdcarrera/healthcheck repository overview

⁠HEALTHCHECK

Simple healthcheck service created in python

The project still in the design step.

⁠Table of Contents

• Next-step⁠
• Container⁠
  • Container info⁠
• INSTRUCTIONS⁠
  • Execution⁠
  • Config file⁠
  • Modules⁠
• SCREENSHOT⁠
• VERSION History⁠
• Author⁠
• Mentions⁠

⁠Next-step

Created more modules and a frontend to visualize the healthcheck from a website.

⁠Container

If you want, you can use a container image allocated in the DockerHub⁠

The container accept a ENV: CONFIG_PATH where you can pass the healthcheck config file path.

I recommend to mount an external volume for the config of the healthcheck and modules, and another one to mount the history folder to save all the state changes.

⁠Container info

⁠INSTRUCTIONS

⁠Execution

The proccess accept a the param -c or --config where you have to pass the path of the config file.

⁠Config file

The config file has 2 parts:

⁠config

Here you can configure the proccess:

• default_seconds_interval

The default time to wait in seconds between iteration to check the tasks

• default_proccess_wait_time

The engine is in an infinity loop, this param configure the time to wait between iterations of the sequence.

• default_retry_on_faults

The number of try before to accept an non ok in a check.

• default_max_history_data

The maximun number of state changes saved in the history file.

• default_history_folder

The folder where are allocated the history files.

• default_config_folder

The folder where are allocated the configuration of the tasks.

• default_lock_folder

The folder where are allocated the specific lock file of the task for the threadings.

⁠tasks

Here you're going to define a list of task.

• name

The name of the tasks, this name would be the same as the config file.

• module

The module what you're going to use.

• seconds_interval

The time to wait in seconds between iteration to check this task

⁠Modules

• This proccess is develop in a module mind, all the different check are modules (actually only one has been develop [HttpGetString])

• All the modules could have different configuration style (but everything in a yaml file)

⁠SCREENSHOT

⁠VERSION History

VERSION History⁠

⁠Author

⁠Mentions

Arrow logo taken from: https://www.flaticon.com/free-icon/up-arrow_23714⁠