Aller au contenu principal
Jahia Store
FR

Healthcheck

legacy
Télécharger 2.3.1

Informations

Identifiant du module
healthcheck
Identifiant de groupe
org.jahia.modules
Statut
legacy
Catégorie
Admin Features
Auteur
jmaurel
Site web du développeur
http://www.jahia.com
Nécessite Jahia
8.0.0.0
Mis à jour
2026-07-09
Source
scm:git:git@github.com:Jahia/healthcheck.git

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:

Captures d'écran

Versions

  • 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
Nécessite Jahia 8.0.0.0Mis à jour 2021-02-16
  • Add probe severity levels and allows to only query probes of a specific severity levels
  • Fix the Healthcheck "Impossible to read the JSON" random error

Note about the backward compatibility with previous Healthcheck versions: only critical probes are now returned by the /healthcheck servlet. A severity needs to be added as a GET parameter to get more probes. (see Readme)

Nécessite Jahia 8.0.0.0Mis à jour 2021-01-28
  • The healthcheck module can now be configured using Karaf while the service is running
  • Allows to configure the HTTP code of the healthcheck when it returns RED (default: 500)
  • Allows to configure the YELLOW/RED thresholds associated with the Session and Request loads
  • Allows to configure the authentication token via Karaf

More information about the configuration can be found here: https://github.com/Jahia/healthcheck#configuration

Nécessite Jahia 8.0.0.0Mis à jour 2020-12-08
  • Allows an additional module to expose multiple healthcheck probes per module (as opposed to one at max until now)
Nécessite Jahia 8.0.0.0Mis à jour 2020-10-27
  • Improved the protection of the Actions against CSRF attacks
Nécessite Jahia 8.0.0.0Mis à jour 2020-09-04
Nécessite Jahia 8.0.0.0Mis à jour 2020-06-10

 - Decreased log verbosity
- Added debug loggers 

Nécessite Jahia 8.0.0.0Mis à jour 2020-05-26

 - Compatibility with Jahia 8

Nécessite Jahia 8.0.0.0Mis à jour 2020-05-18
  • 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
Nécessite Jahia 7.2.0.0Mis à jour 2021-02-16
  • Add probe severity levels and allows to only query probes of a specific severity levels
  • Fix the Healthcheck "Impossible to read the JSON" random error

Note about the backward compatibility with previous Healthcheck versions: only critical probes are now returned by the /healthcheck servlet. A severity needs to be added as a GET parameter to get more probes. (see Readme)

Nécessite Jahia 7.2.0.0Mis à jour 2021-01-28
  • The healthcheck module can now be configured using Karaf while the service is running
  • Allows to configure the HTTP code of the healthcheck when it returns RED (default: 500)
  • Allows to configure the YELLOW/RED thresholds associated with the Session and Request loads
  • Allows to configure the authentication token via Karaf
  • Decreased log verbosity by switching loggers to debug

More information about the configuration can be found here: https://github.com/Jahia/healthcheck#configuration

Nécessite Jahia 7.2.0.0Mis à jour 2020-12-08

 - Removed logs generating unecessarily big log files when the healthcheck probe is called often.

Nécessite Jahia 7.2.0.0Mis à jour 2020-04-28
Nécessite Jahia 7.2.0.0Mis à jour 2019-10-02

Added token management (panel + token auth) 

Nécessite Jahia 7.2.0.0Mis à jour 2019-04-22

Implemented a probe that tests the availibility of the datastore, if on the filesystem

Nécessite Jahia 7.2.0.0Mis à jour 2019-03-25

Supports any combination of hostname and site language

Nécessite Jahia 7.2.0.0Mis à jour 2018-11-28

Close the DB connection once the test is done.

Nécessite Jahia 7.2.0.0Mis à jour 2018-11-23
Nécessite Jahia 7.2.0.0Mis à jour 2018-06-14
Nécessite Jahia 7.2.1.1Mis à jour 2018-06-14