This guide will teach you how to configure health checks in Alumio. Health Checks allows users to perform actions to check whether parts of Alumio are performing as expected.
Creating a new Health Check
Navigate to Settings > Health Checks in the dashboard. A list of all available Health Checks is shown. Then click on the add button to create a new Health Check.
Health Checks Form
A form is shown to create a new Health Check. Fill in the basic information: a name, identifier and description. Then select the type of Health Check to create by selecting an item from the drop down of the prototype field.
Task Health Checker
The Task Health Checker allows users to register a Health Check that can query the task queue. It returns the amount of tasks that matched the configured criteria.
Criteria
The criteria field can be used to enter a criteria that the tasks must match. For example, to match on the status "processing" the following criteria can be used.
{
"status": "processing"
}
Age of Tasks
The amount of time the task should be on the configured criteria.
Message
The message written to the log when tasks where found matching the criteria.
Threshold
The amount of tasks that should match the criteria.
Log Level
The log level used to write to the log when tasks where found matching the criteria.
Task Status Repair
The Task status repair Health Check can be used to automatically update the status of a task when it matches a configured criteria.
Criteria
The criteria field can be used to enter a criteria that the tasks must match. For example, to match on the status "processing" the following criteria can be used.
{
"status": "processing"
}
Age of Tasks
The amount of time the task should be on the configured criteria.
Message
The message written to the log when tasks where found matching the criteria.
Status
The status that tasks matching the criteria will be set to.
Log Level
The log level used to write to the log when tasks where found matching the criteria.
Configuring a Health Check for a specific Route
{
"route": "xyz"
}
Executing Health Checks
Health Checks can be executed from the command line, for example with a cron job.
vendor/bin/magement health:check