https://github.com/codemonauts/craft-healthz

Craft CMS module to answer healthz checks
https://github.com/codemonauts/craft-healthz

cms craft craftcms healthz plugin

Last synced: about 4 hours ago
JSON representation

Craft CMS module to answer healthz checks

• Host: GitHub
• URL: https://github.com/codemonauts/craft-healthz
• Owner: codemonauts
• License: mit
• Created: 2019-03-12T13:57:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-04-04T09:57:54.000Z (over 5 years ago)
• Last Synced: 2024-09-18T01:13:47.370Z (2 months ago)
• Topics: cms, craft, craftcms, healthz, plugin
• Language: PHP
• Homepage:
• Size: 7.81 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Healthz module for Craft CMS 3.x

![Icon](resources/healthz.png)

A really basic healthz check module for Craft CMS.

## Background

If you running your Craft CMS servers behind a loadbalancer or you are monitoring your site with an external monitoring tools, you need an endpoint which

* answers early and doesn't walk through the whole stack

* answers with an 200 Ok even when a migration is waiting

* checks if the connection to the database and cache is available

## Requirements

* Craft CMS >= 3.0.0

## Installation

```shell

cd /path/to/project

composer require codemonauts/craft-healthz

```

Then add the module to the ```app.php``` in your Craft config directory like this:

```php

 [

        // ...

        'healthz' => codemonauts\healthz\Healthz::class,

    ],

    'bootstrap' => ['healthz'],

];

```

## Usage

The endpoint for your monitoring system or loadbalancer is

```http(s)://yoursite.com/healthz```

The script answers with ```200 Ok``` or ```503 Not Ok```

With ❤ by [codemonauts](https://codemonauts.com)