Skip to main content
Jahia Store
EN

Healthcheck

legacy
Download 2.3.1

Information

Module ID
healthcheck
Group ID
org.jahia.modules
Status
legacy
Category
Admin Features
Author
julian.maurel@jahia.com
Developer website
http://www.jahia.com
Requires Jahia
8.0.0.0
Updated
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:

Screenshots

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
Requires Jahia 8.0.0.0Updated 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)

Requires Jahia 8.0.0.0Updated 2021-01-28
2.2.1draftDownload
  • 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)

Requires Jahia 8.0.0.0Updated 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

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

 - Decreased log verbosity
- Added debug loggers 

Requires Jahia 8.0.0.0Updated 2020-05-26

 - Compatibility with Jahia 8

Requires Jahia 8.0.0.0Updated 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
Requires Jahia 7.2.0.0Updated 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)

Requires Jahia 7.2.0.0Updated 2021-01-28
1.1.1draftDownload
  • 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)

Requires Jahia 7.2.0.0Updated 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

Requires Jahia 7.2.0.0Updated 2020-12-08
1.0.11Download

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

Requires Jahia 7.2.0.0Updated 2020-04-28
1.0.10Download
Requires Jahia 7.2.0.0Updated 2019-10-02

Added token management (panel + token auth) 

Requires Jahia 7.2.0.0Updated 2019-04-22

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

Requires Jahia 7.2.0.0Updated 2019-03-25

Supports any combination of hostname and site language

Requires Jahia 7.2.0.0Updated 2018-11-28

Close the DB connection once the test is done.

Requires Jahia 7.2.0.0Updated 2018-11-23
Requires Jahia 7.2.0.0Updated 2018-06-14
Requires Jahia 7.2.1.1Updated 2018-06-14
1.0draftDownload
Requires Jahia 7.2.1.1Updated 2018-06-14