https://github.com/segpacto/ejabberd_healthcheck

module for ejabberd that creates an endpoints for healthcheck
https://github.com/segpacto/ejabberd_healthcheck

ejabberd ejabberd-api erlang healthcheck module mysql ssl

Last synced: 23 days ago
JSON representation

module for ejabberd that creates an endpoints for healthcheck

• Host: GitHub
• URL: https://github.com/segpacto/ejabberd_healthcheck
• Owner: segpacto
• Created: 2018-09-04T13:53:13.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-03-31T12:11:40.000Z (almost 3 years ago)
• Last Synced: 2024-11-12T16:49:46.079Z (3 months ago)
• Topics: ejabberd, ejabberd-api, erlang, healthcheck, module, mysql, ssl
• Language: Erlang
• Homepage:
• Size: 8.79 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#mod_health

Monitor Ejabberd and any applications running on it.

Based on https://github.com/nycholas/ which is based on https://www.ejabberd.im/mod_monitor_web 14.02+

## Objective

The target is to include the status code on the response of the healthcheck on the response status code.

- 204 response for all checked and properly running.

- 503 response when any of the services defined on the module are failling.

## Ejabberd Config

First make sure the module is added in ejabberd.yml on the server port

```yml

  -

    port: 5281

    module: ejabberd_http

    request_handlers:

      "/healthcheck": mod_health

    web_admin: false

    http_poll: false

    http_bind: false

    ## register: true

    captcha: true

```

This will create an endpoint for mod_health to listen to at localhost:5281/healthcheck

## Adding additional applications to check

Define the application name as a constant at the top of the file:

```erlang

-define(MYSQL, mysql).

```

then add subsecuently on function ```get_all_status``` another check variable for the new status 

added (like: ```EJABBERDStatus = lists:keymember(?EJABBERD, 1, application:which_applications()),```), add this new obtained variable status to the list of results.