Healthcheck icon
Module Id
healthcheck
Group Id
org.jahia.modules
Updated
Requires Jahia
8.0.0.0
Author
jmaurel
Category
Tools and Utilities
Status
COMMUNITY info

Healthcheck group_work

Healthchecks provide insights about a platform's health and can help trigger alerts or pay attention to key components that might need close attention. Jahia's Healthcheck module provides a JSON output and is can be triggered at will with minimal impact on the platform load.

Official documentation

The healthcheck module is a core component that can be used in conjunction with extension modules in order to provide more information to the monitoring systems.

The healthcheck module returns a global status for the server, as well a status for all tested components. The status can be:

  • GREEN (Nominal status)
  • YELLOW (Non critical problem)
  • RED (Critical issue)

The healthcheck is available thourgh the servlet /healthcheck to all users who are granted the Jahia DX server role monitoring It returns a JSON object with the following structure:

Dependencies & Dependants

Dependencies
  • NONE
Dependants
  • NONE

Changelog 2.3.1

  • Fix a bug that prevents the Healthcheck module from overriding probe severity in the karaf configuration
  • Healthcheck module now logs the status of each probe when the status is RED
  • Add each healthcheck probe severity in the healthcheck response
  • Switch the default healthcheck ServerLoad severity from CRITICAL to HIGH

How To Install

The healthcheck is available thourgh the servlet /healthcheck to all users who are granted the Jahia DX server role monitoring It returns a JSON object with the following structure:

Images

License

====================================================================================
=                   JAHIA'S DUAL LICENSING - IMPORTANT INFORMATION                                                               =
====================================================================================
  
                                http://www.jahia.com

    Copyright (C) 2002-2017 Jahia Solutions Group SA. All rights reserved.
    
    THIS PROGRAM IS AVAILABLE UNDER TWO DIFFERENT LICENSES:
    1/GPL OR 2/JSEL

    1/ GPL
    ==================================================================================

    IF YOU DECIDE TO CHOOSE THE GPL LICENSE, YOU MUST COMPLY WITH THE FOLLOWING TERMS:

    This program is free software: you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.

        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.

        You should have received a copy of the GNU General Public License
        along with this program.  If not, see <http://www.gnu.org/licenses/>.


    2/ JSEL - Commercial and Supported Versions of the program
    ==================================================================================

    IF YOU DECIDE TO CHOOSE THE JSEL LICENSE, YOU MUST COMPLY WITH THE FOLLOWING TERMS:

    Alternatively, commercial and supported versions of the program - also known as
    Enterprise Distributions - must be used in accordance with the terms and conditions 
    contained in a separate written agreement between you and Jahia Solutions Group SA.

    If you are unsure which license is appropriate for your use,
    please contact the sales department at sales@jahia.com.