Joomla! Issue Tracker | Joomla! CMS #47947 - [6.2] Initial implementation of a Health Check system and dashboard

Feature Language Change PR-6.2-dev

Pending
Medium
Build: 6.2-dev
# 47947
Diff
obuisard:healthcheck

Pending

User tests: Successful: Unsuccessful:

obuisard
12 Jun 2026

Pull Request resolves # .

I read the Generative AI policy and my contribution is either not created with the help of AI or is compatible with the policy and GNU/GPL 2 or later.

Summary of Changes

This PR aims at adding Health Check functionality to Joomla, in a dedicated dashboard.
It lays out the underlying initial implementation and its purpose is to give instructions to developers to create specific Health Check plugins.

Note: the Health Check menu item will only appear if there is at least one instance of the Health Check module available for the cpanel-healthcheck position.

Testing Instructions

Go to the download section of the PR (bottom section, you may have to expand and scroll to find the link).

Download and install the full package. The full package gives you a 6.2 alpha 3 dev instance of Joomla with the Health Check functionality. The update package will update your site to a version 6.2 alpha 3 dev.
Download and install the plugin plg_healthcheck_showcase.zip. This plugin is meant to show all layout options plugin developers have at their disposal to create plugins for the Health Check.

plg_healthcheck_showcase.zip

Go to Content -> Administrator Modules and filter by the position cpanel-healthcheck. Open the 'Health Check' module. Check the context (or group). It should be set to 'general'. Publish, Save and Close. This will enable the Health Check dashboard. You should now see a 'heart' icon on the left menu, below 'System'.

Note: if just updated your system, you will need to create an instance of the Health Check module with context (or group) 'general' and a position of cpanel-healthcheck.

Create another instance of the Health Check module. Add a title 'Showcase'. Give the module context 'testing' (Health Check Group parameter).

When plugins and modules share the same context (or group), information generated by the plugins show in their respective module instance.

Go to System -> Plugins and filter by healthcheck type. Make sure both plugins are enabled. The User Maintenance plugin has settings you can modify.
While testing, if you give the same context (or group) to both plugins, they will 'blend' together. Gauges first, then icons, then lists, then tables.

Health Check Plugin Developer Guide

This guide explains how to build a healthcheck plugin for Joomla's Health Check module, using the existing usermaintenance plugin as the baseline example.

Relevant core code in this workspace:

Module data collection: administrator/modules/mod_healthcheck/src/Helper/HealthCheckHelper.php
Module rendering entry point: administrator/modules/mod_healthcheck/tmpl/default.php
Layout rendering helper: libraries/src/HTML/Helpers/HealthChecks.php
Layout templates:
- layouts/joomla/healthchecks/icon.php
- layouts/joomla/healthchecks/gauge.php
- layouts/joomla/healthchecks/list.php
- layouts/joomla/healthchecks/table.php
Example plugin (icons only): plugins/healthcheck/usermaintenance

1) How the Health Check plugin system works

The module imports the healthcheck plugin group and dispatches events like onHealthcheckGetIcons, onHealthcheckGetGauges, onHealthcheckGetLists, and onHealthcheckGetTables.
Each enabled plugin can subscribe to one or more events and append data into the event result argument.
The module validates required fields and applies defaults (HealthCheckHelper methods getButtons(), getGauges(), getLists(), getTables()).
The HTMLHelper::_('healthchecks.*', ...) helper renders each item through the matching layout file.

The module passes a context value to events. Your plugin should usually ignore events for other contexts.

2) Minimal plugin structure

Use the same structure as plugins/healthcheck/usermaintenance:

plugins/healthcheck/yourplugin/
  yourplugin.xml
  services/provider.php
  src/Extension/YourPlugin.php
  language/en-GB/plg_healthcheck_yourplugin.ini
  language/en-GB/plg_healthcheck_yourplugin.sys.ini

`yourplugin.xml` essentials

group="healthcheck"
plugin namespace
files and language declarations
optional plugin params (including a context text field)

The usermaintenance example defines:

<extension type="plugin" group="healthcheck" method="upgrade">

`services/provider.php` essentials

Register your plugin as PluginInterface with lazy loading, like plugins/healthcheck/usermaintenance/services/provider.php.

`src/Extension/YourPlugin.php` essentials

extend CMSPlugin
implement SubscriberInterface
return event subscriptions in getSubscribedEvents()

3) Event subscriptions and payload contracts

Event names

Icons: onHealthcheckGetIcons
Gauges: onHealthcheckGetGauges
Lists: onHealthcheckGetLists
Tables: onHealthcheckGetTables

Expected return pattern

Each event method should:

Read current result: $result = $event->getArgument('result', []);
Append one array of items: $result[] = $items;
Write back: $event->setArgument('result', $result);

This matches the pattern in usermaintenance (onHealthcheckGetIcons).

Context guard pattern

Use the same guard style as usermaintenance:

$context = $event->getContext();

if ($context !== $this->params->get('context', 'general')) {
    return;
}

4) Icon items (button layout)

Icons are dispatched through onHealthcheckGetIcons and rendered by layouts/joomla/healthchecks/icon.php.

Required fields

From HealthCheckHelper::getButtons():

link (required)
one of text or name (required)

Common fields

icon (for icon class, used by layout)
image (optional image URL)
amount (numeric/string badge amount)
status (success, warning, error, etc.; affects color/filter)
id, class, target, title, onclick
onclick — name of a handler registered via Joomla.registerHealthCheckAction(name, fn) (rendered as data-onclick; no inline JS)
group (defaults to general)
access (boolean or ACL pair array)

Example (based on `usermaintenance`)

public function onHealthcheckGetIcons(HealthChecksEvent $event): void
{
    if ($event->getContext() !== $this->params->get('context', 'usermanagement')) {
        return;
    }

    $checks = [];

    $checks[] = [
        'link'   => 'index.php?option=com_users&view=users&filter[state]=1',
        'icon'   => 'fas fa-users-gear',
        'amount' => 12,
        'text'   => 'Inactive users',
        'id'     => 'plg_healthcheck_example_inactive',
        'status' => 'warning',
    ];

    $checks[] = [
        'link'   => 'index.php?option=com_users&view=users&filter[mfa]=0',
        'icon'   => 'fas fa-shield-halved',
        'amount' => 0,
        'text'   => 'Users without MFA',
        'status' => 'success',
    ];

    $result   = $event->getArgument('result', []);
    $result[] = $checks;
    $event->setArgument('result', $result);
}

5) Gauge items

Gauges are dispatched through onHealthcheckGetGauges and rendered by layouts/joomla/healthchecks/gauge.php.

Required fields

From HealthCheckHelper::getGauges():

score
unit

Useful optional fields

label, sublabel, note
score_min, score_max
score_threshold_warning, score_threshold_success
link
linktitle (used by layout)
group, access, class, id

Example

public function onHealthcheckGetGauges(HealthChecksEvent $event): void
{
    if ($event->getContext() !== $this->params->get('context', 'performance')) {
        return;
    }

    $gauges = [[
        'id'                      => 'plg_healthcheck_example_php_memory',
        'label'                   => 'PHP memory usage',
        'sublabel'                => 'Current process',
        'note'                    => 'Values over 80% should be reviewed.',
        'score'                   => 72,
        'unit'                    => '%',
        'score_min'               => 0,
        'score_max'               => 100,
        'score_threshold_warning' => 70,
        'score_threshold_success' => 90,
        'link'                    => 'index.php?option=com_config',
        'linktitle'               => 'Open Global Configuration',
        'status'                  => 'warning',
    ]];

    $result   = $event->getArgument('result', []);
    $result[] = $gauges;
    $event->setArgument('result', $result);
}

6) List items

Lists are dispatched through onHealthcheckGetLists and rendered by layouts/joomla/healthchecks/list.php.

Required fields

From HealthCheckHelper::getLists():

items (array)

Useful optional fields

type (ul, ol, or div)
class, id, itemClass
group, access

Example

public function onHealthcheckGetLists(HealthChecksEvent $event): void
{
    if ($event->getContext() !== $this->params->get('context', 'security')) {
        return;
    }

    $lists = [[
        'id'       => 'plg_healthcheck_example_security_tips',
        'class'    => 'list-group list-group-flush',
        'itemClass'=> 'list-group-item',
        'type'     => 'ul',
        'items'    => [
            'Enable MFA for all administrators',
            'Review inactive accounts monthly',
            'Remove users not assigned to any group',
        ],
    ]];

    $result   = $event->getArgument('result', []);
    $result[] = $lists;
    $event->setArgument('result', $result);
}

7) Table items

Tables are dispatched through onHealthcheckGetTables and rendered by layouts/joomla/healthchecks/table.php.

Required fields

From HealthCheckHelper::getTables():

columns (array)
data (array)

Column definition basics

Each column typically uses:

key (data key)
title (header)
optional type (text, badge, link, date, boolean, progress, icon, custom)
optional display keys (align, width, scope, cellClass, etc.)

type rendering is handled by HealthCheckHelper::renderTableCellContent().

Example

public function onHealthcheckGetTables(HealthChecksEvent $event): void
{
    if ($event->getContext() !== $this->params->get('context', 'usermanagement')) {
        return;
    }

    $tables = [[
        'id'      => 'plg_healthcheck_example_user_risk',
        'caption' => 'Users requiring attention',
        'class'   => 'table-sm',
        'columns' => [
            ['key' => 'name', 'title' => 'User'],
            ['key' => 'lastvisitDate', 'title' => 'Last login', 'type' => 'date'],
            ['key' => 'mfa', 'title' => 'MFA', 'type' => 'boolean'],
            ['key' => 'risk', 'title' => 'Risk', 'type' => 'badge', 'badgeClass' => static function ($value) {
                return $value === 'high' ? 'danger' : ($value === 'medium' ? 'warning' : 'success');
            }],
        ],
        'data' => [
            ['name' => 'Alice Admin', 'lastvisitDate' => '2026-05-14 09:05:00', 'mfa' => 1, 'risk' => 'low'],
            ['name' => 'Bob Manager', 'lastvisitDate' => '2026-01-07 11:21:00', 'mfa' => 0, 'risk' => 'high'],
        ],
    ]];

    $result   = $event->getArgument('result', []);
    $result[] = $tables;
    $event->setArgument('result', $result);
}

8) Full subscriber example

public static function getSubscribedEvents(): array
{
    return [
        'onHealthcheckGetIcons'  => 'onHealthcheckGetIcons',
        'onHealthcheckGetGauges' => 'onHealthcheckGetGauges',
        'onHealthcheckGetLists'  => 'onHealthcheckGetLists',
        'onHealthcheckGetTables' => 'onHealthcheckGetTables',
    ];
}

You can implement only the events you need.

9) Grouping and access control

group: defaults to general; use it to classify data by module context strategy.
access:
- true/false for quick allow/deny
- or ACL checks as pairs, e.g. ['core.manage', 'com_users', 'core.admin', 'com_users']

Access is evaluated in libraries/src/HTML/Helpers/HealthChecks.php (canAccess()).

10) Testing checklist

Install/enable your plugin in group healthcheck.
Ensure the module mod_healthcheck is enabled in Administrator.
Set module context to match your plugin context parameter.
Confirm each subscribed event returns at least one valid item with required fields.
Verify rendering in the module UI:
- icons appear in the icon section
- gauges render SVG meters
- lists render item collections
- tables render with expected cell types

11) Practical notes from current implementation

The usermaintenance plugin currently demonstrates the icon event only.
Gauge layout reads linktitle for link title text.
The helper default includes link_title for gauges; if you need guaranteed title output in the current layout, set linktitle in your payload.
Any missing required field causes that item to be filtered out before rendering.

12) How `healthcheck-filters` works

The filter bar is part of the module template (administrator/modules/mod_healthcheck/tmpl/default.php), not the plugin itself.

What filters are available

The module renders four filter buttons:

all
healthy
warning
critical

Selecting a button shows only matching health-check items in the module.

What plugin authors should set

To make your items filter correctly, provide status on each item payload.

Use these values:

success for healthy items
warning for warning items
error for critical items

If status is omitted, items default to the healthy group.

Where filtering applies

Filtering currently applies to items rendered by these layouts:

layouts/joomla/healthchecks/icon.php
layouts/joomla/healthchecks/gauge.php
layouts/joomla/healthchecks/list.php
layouts/joomla/healthchecks/table.php

All filterable items are tagged with data-healthcheck-status, and the module script (media_source/mod_healthcheck/js/healthcheck-filter.js) uses that value to show/hide items.

Status aliases accepted by the module filter

The filter normalization accepts these aliases:

success, ok, info -> healthy
warning, warn, alert -> warning
error, danger -> critical

Quick usage example

$checks[] = [
    'link'   => 'index.php?option=com_users&view=users&filter[mfa]=0',
    'icon'   => 'fas fa-shield-halved',
    'amount' => 3,
    'text'   => 'Users without MFA',
    'status' => 'warning', // appears when the Warning filter is selected
];

Testing filter behavior

Enable your healthcheck plugin and mod_healthcheck.
Return items with a mix of success, warning, and error statuses.
In Administrator, switch between All, Healthy, Warning, and Critical.
Confirm only matching items remain visible for each filter.

13) CSP-safe onclick handlers

Icon buttons support a click handler via the onclick field. To stay Content Security Policy (CSP) compliant, the layout renders it as a data-onclick attribute — never as an inline onclick="...". The module script healthcheck-onclick.js listens for clicks and dispatches to a named handler you register in JavaScript.

Registering a handler

In your plugin's JavaScript asset, call Joomla.registerHealthCheckAction before any click can occur:

Joomla.registerHealthCheckAction('myHandlerName', function (event) {
    // `this` is the clicked <a> element
    const link = this;
    console.log('Clicked icon:', link);
});

The handler is called with the clicked element as this and the native MouseEvent as the first argument. event.preventDefault() is called automatically by the dispatcher, so the icon's href is not followed.

Setting `onclick` in your PHP payload

Pass the registered handler name as the onclick value:

$checks[] = [
    'link'    => '#',
    'icon'    => 'fas fa-rotate',
    'text'    => 'Run manual check',
    'onclick' => 'myHandlerName', // must match the name passed to registerHealthCheckAction
    'status'  => 'info',
];

Loading your JS asset

$wa = $app->getDocument()->getWebAssetManager();
$wa->registerAndUseScript(
    'plg_healthcheck_yourplugin.script',
    'plg_healthcheck/yourplugin/yourplugin.js',
    ['dependencies' => ['mod_healthcheck.onclick']],
    ['defer' => true]
);

Complete example

plugins/healthcheck/yourplugin/src/Extension/YourPlugin.php

$checks[] = [
    'link'    => '#',
    'icon'    => 'fas fa-rotate',
    'text'    => 'Refresh cache',
    'onclick' => 'plgHealthcheckYourpluginRefresh',
    'status'  => 'warning',
];

plugins/healthcheck/yourplugin/media/js/yourplugin.js

Joomla.registerHealthCheckAction('plgHealthcheckYourpluginRefresh', function (event) {
    fetch('index.php?option=com_ajax&plugin=yourplugin&group=healthcheck&format=json', {
        method: 'POST',
        credentials: 'same-origin',
        headers: { 'X-Requested-With': 'XMLHttpRequest' },
    }).then(() => window.location.reload());
});

Note: Use a unique, namespaced handler name (e.g. prefixed with your plugin name) to avoid collisions with other plugins.

Link to documentations

Please select:

Documentation link for guide.joomla.org:
No documentation changes for guide.joomla.org needed
Pull Request link for manual.joomla.org:
No documentation changes for manual.joomla.org needed

c15ecf8 12 Jun 2026

Initial implementation of a Health Check system and dashboard

obuisard - open - 12 Jun 2026

obuisard - change - 12 Jun 2026

Status

New

⇒

Pending

joomla-cms-bot - change - 12 Jun 2026

Category

⇒

Administration com_cpanel com_menus Language & Strings Modules Layout Libraries JavaScript Front End Plugins

6bc5a20 12 Jun 2026

Use span instead of i for better icon semantic

obuisard - change - 12 Jun 2026

Labels

Added: Language Change PR-6.2-dev

b370bd3 12 Jun 2026

Update media_source/mod_healthcheck/css/healthcheck-filter.css

894e3ab 12 Jun 2026

Update media_source/mod_healthcheck/css/healthcheck-filter.css

e50bb03 12 Jun 2026

REmoe commented code and indent code

7b7108a 12 Jun 2026

Merge remote-tracking branch 'origin/healthcheck' into healthcheck

5a84819 12 Jun 2026

Update layouts/joomla/healthchecks/gauge.php

4780623 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

3ab0039 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

258e522 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

88b8d43 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

24bddb5 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

636a115 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

4427f2a 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

3e34b5a 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

912a027 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

89657c3 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

3c010b1 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

b276744 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

1632c96 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

840b795 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

13f0199 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

c39d67f 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

e98930f 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

3fcaf31 12 Jun 2026

Update administrator/language/en-GB/plg_healthcheck_usermaintenance.ini

b0488b2 12 Jun 2026

Use database null dates, not 0000-00-00 00:00:00

brianteeman - comment - 12 Jun 2026

You need to decide on the terminology and be consistent with its use

Health Check
HealthCheck
Healthcheck

19d8039 12 Jun 2026

Health Check casing changes

4a946d7 12 Jun 2026

Merge branch '6.2-dev' into healthcheck

obuisard - comment - 12 Jun 2026

Healthcheck

I sorted it out a bit:
Health Check: the name
Health Check: the module
health check: the noun
HealthCheck: the plugin group

602633a 12 Jun 2026

Removed unused health reports section

ce0ab31 12 Jun 2026

Added database queries to install module and plugin

joomla-cms-bot - change - 12 Jun 2026

Category

Administration com_cpanel com_menus Language & Strings Modules Layout Libraries JavaScript Front End Plugins

⇒

Administration com_cpanel com_menus Language & Strings Modules SQL Installation Postgresql Layout Libraries JavaScript Front End Plugins

brianteeman - comment - 12 Jun 2026

dont forget the sql for updates

brianteeman - comment - 12 Jun 2026

Nothing happens when I click on the buttons

brianteeman - comment - 12 Jun 2026

Nothing happens when I click on the filter buttons

brianteeman - comment - 12 Jun 2026

Inactive Users

the count says 0 but I have multiple users that are not activated

when you click on the button it takes you to a filter list of disabled users. thats not the same thing as non activated users

brianteeman - comment - 12 Jun 2026

Please follow the style guide for labels. They should be Capitalised

brianteeman - comment - 12 Jun 2026

The reason that the filters dont work as reported #47947 (comment) is that neither the js not the css files are being created in the media folder.

With the new build system you have to explicitly tell the build scripts to create the js and css for the module. With the old build system you could just create the media source folder but now you have to be explicit. (dont ask me why)

So you need to add mod_healthcheck here

joomla-cms/build/build-modules-js/builders-registry.mjs

Line 56 in 0da36ce

'mod_sampledata',

brianteeman - comment - 12 Jun 2026

When you hover over a button it is moved -1px with css.

.healthcheck-filters .btn:hover {
  transform: translateY(-1px);
  box-shadow: 0 2px 4px #0000001a;
}

I am assuming that this is to give a pseudo real button effect when you click on it. No where else in the admin ui do we do this - but maybe one of the css gurus will correct me - personally I woujld just remove it as its ugly when you hover across the buttons as shown below.

chrome_HFXJ6CPDrz.mp4

brianteeman - comment - 12 Jun 2026

The usermaintenance plugin currently demonstrates the icon event only.

Makes it very hard to test the other functionality

obuisard - comment - 12 Jun 2026

Nothing happens when I click on the filter buttons

Yes, I tested it and realised the media files are not loaded or even present under /media. I don't understand why.

obuisard - comment - 12 Jun 2026

Nothing happens when I click on the filter buttons

Yes, I tested it and realised the media files are not loaded or even present under /media. I don't understand why.
Oh, I understand, you explained in another comment :-)

obuisard - comment - 12 Jun 2026

Nothing happens when I click on the filter buttons

Yes, I tested it and realised the media files are not loaded or even present under /media. I don't understand why.
Oh, I understand now, you explained in another comment :-)

obuisard - comment - 12 Jun 2026

Nothing happens when I click on the filter buttons

Yes, I tested it and realised the media files are not loaded or even present under /media. I don't understand why.
Oh, I understand now, you explained in another comment :-)
I was missing that piece of the puzzle...

joomla-cms-bot - change - 12 Jun 2026

Category

Administration com_cpanel com_menus Language & Strings Modules Layout Libraries JavaScript Front End Plugins SQL Installation Postgresql

⇒

Administration com_cpanel com_menus Language & Strings Modules JavaScript Repository SQL Installation Postgresql Layout Libraries

obuisard - comment - 12 Jun 2026

The usermaintenance plugin currently demonstrates the icon event only.

Makes it very hard to test the other functionality

We have other plugins in the work that show more of the layouts that are available.
We still wanted to have a basic implementation with this PR.

obuisard - comment - 12 Jun 2026

When you hover over a button it is moved -1px with css.
.healthcheck-filters .btn:hover {
  transform: translateY(-1px);
  box-shadow: 0 2px 4px #0000001a;
}
I am assuming that this is to give a pseudo real button effect when you click on it. No where else in the admin ui do we do this - but maybe one of the css gurus will correct me - personally I woujld just remove it as its ugly when you hover across the buttons as shown below.

Right on, I removed it, it is indeed not consistent with other buttons.

brianteeman - comment - 13 Jun 2026

The usermaintenance plugin currently demonstrates the icon event only.

Makes it very hard to test the other functionality

We have other plugins in the work that show more of the layouts that are available. We still wanted to have a basic implementation with this PR.

without those plugins (or something even just for testing purposes) its not possible to report a successful test of that part of the pr

obuisard - comment - 13 Jun 2026

without those plugins (or something even just for testing purposes) its not possible to report a successful test of that part of the pr

In that case, I would suggest we complement the Users Maintenance plugin to use all layouts.
Add an optional gauge showing the amount of inactive users compared to the total number of users, for instance, data in a table layout and in a list layout.

obuisard - comment - 13 Jun 2026

without those plugins (or something even just for testing purposes) its not possible to report a successful test of that part of the pr

Better, I think I will create an additional plugin that highlights all cases, that will not be included in the core.

joomla-cms-bot - change - 13 Jun 2026

Category

Administration com_cpanel com_menus Language & Strings Modules Layout Libraries JavaScript SQL Installation Postgresql Repository

⇒

SQL Administration com_admin Postgresql com_cpanel com_menus Language & Strings Modules JavaScript Repository Installation Layout Libraries

brianteeman - comment - 15 Jun 2026

Better, I think I will create an additional plugin that highlights all cases, that will not be included in the core.

Please do so that this PR can be really tested - otherwise its not possible for someone to test the entirety of the PR

chmst - comment - 15 Jun 2026

The color contrast for review not sufficient. It is a long existing error, but not visible on other places. (Except during update/migration checks)

chmst - comment - 15 Jun 2026

The color contrast for review is not sufficient. This color (warning) It is a long existing error in atum, but not visible on other places. (Except during update/migration checks)

obuisard - comment - 18 Jun 2026

The color contrast for review is not sufficient. This color (warning) It is a long existing error in atum, but not visible on other places. (Except during update/migration checks)

It looks like we should open a PR for a template fix.

brianteeman - comment - 19 Jun 2026

inconsistency in the language strings

Score: 68 % out of 100 %. This represents 68.0% of the range from 0 to 100. Status: Good performance with room for improvement.

here we can see that there is a space between the value and the % which should not be there
the first instance is to 0 decimal places and the second is to one devimal place
as its a % it doesnt even need to say "out of 100%" as it cant be anything else
as its a % then the entire "This represents 68.0% of the range from 0 to 100" is redundant

brianteeman - comment - 19 Jun 2026

using link text and title and aria-label is not a good idea. It is generally bad of accessibility espec with screen readers. what are you trying to achieve by doing this

brianteeman - comment - 19 Jun 2026

Thanks for getting the ai to find the issue with the language strings

brianteeman - comment - 19 Jun 2026

This makes extensive use of (often invisible) links with both title and aria-labels to explain the purpose of the link with different levels of information. This can be tricky as screen readers will use one or both which is overkill.

Titles are also invisible to keyboard users and mobile users. On the gauges it's not even obvious that they have a link behind them.

Ideally every link should have anchor text which describe the link and an aria-labels only used where the anchor text is insufficient.

Additional reading https://www.deque.com/blog/text-links-practices-screen-readers/

brianteeman - comment - 19 Jun 2026

Please follow the style guide - labels should be capitalised

obuisard - comment - 22 Jun 2026

Please follow the style guide - labels should be capitalised

This has been fixed last week after your initial comment.

obuisard - comment - 22 Jun 2026

Please follow the style guide - labels should be capitalised

Thanks Brian. This has been fixed last week after your initial comment.

obuisard - change - 24 Jun 2026

The description was changed

obuisard - edited - 24 Jun 2026

obuisard - change - 24 Jun 2026

The description was changed

obuisard - edited - 24 Jun 2026

obuisard - change - 24 Jun 2026

The description was changed

obuisard - edited - 24 Jun 2026

HLeithner - comment - 27 Jun 2026

Thanks for all the work, my first thing would be, please remove it from the "main" menu and move it to the "system" screen.

laoneo - comment - 11 Jul 2026

When I think about use cases for my extensions, then I think it would be good to have the check done in an ajax request and not within the page load. Especially when there are many checks done it can take some time to finish.

laoneo - comment - 11 Jul 2026

When I think about use cases for my extensions, then it would be good to have the check done in an ajax request and not within the page load. Especially when there are many checks done it can take some time to finish.

MacJoom - change - 15 Jul 2026

Title

…

Initial implementation of a Health Check system and dashboard

[6.2] Initial implementation of a Health Check system and dashboard

MacJoom - edited - 15 Jul 2026

MacJoom - comment - 15 Jul 2026

When I think about use cases for my extensions, then it would be good to have the check done in an ajax request and not within the page load. Especially when there are many checks done it can take some time to finish.

Async capabilites were added here: 6ac5695

obuisard - comment - 22 Jul 2026

Here is a summary of the unresolved items to take care of this week:

administrator/language/en-GB/mod_healthcheck.ini:28
Reviewer brianteeman: not convinced %% is correct / not testable.
Link: #47947 (comment)
Action: confirm rendered output path for this string (or add clarifying comment/test evidence) and reply with proof.

plugins/healthcheck/usermaintenance/src/Extension/UserMaintenance.php:65
Reviewer heelc29: logic “doesn't make sense if there is more than one active module”.
Link: #47947 (comment)
Action: review module selection/lookup logic for multi-module setups and patch or explain intended behavior.

administrator/language/en-GB/plg_healthcheck_usermaintenance.ini:36
Reviewer brianteeman: description is redundant/useless vs label.
Link: #47947 (comment)
Action: remove or rewrite the description to add distinct value.

layouts/joomla/healthchecks/gauge.php:112
Reviewer brianteeman: tabindex="-1" makes it unreachable for screen readers.
Link: #47947 (comment)
Action: revisit accessibility approach (focusability + ARIA semantics) and adjust markup.

administrator/language/en-GB/plg_healthcheck_usermaintenance.ini:9
Reviewer brianteeman: suggested text change to “disabled users” in error string.
Link: #47947 (comment)
Action: accept/edit suggestion or justify current wording.

administrator/language/en-GB/plg_healthcheck_usermaintenance.ini:23
Reviewer brianteeman: suggested label Disabled Users.
Link: #47947 (comment)
Action: align label with actual metric or explain distinction if label remains Inactive.

administrator/language/en-GB/plg_healthcheck_usermaintenance.ini:22
Long unresolved thread (brianteeman + obuisard) around inactive vs disabled/unactivated wording and incorrect links.
Latest note asks whether to keep “Inactive” and rename “Unactivated” to “Unactivated/Disabled”.
Link: #47947 (comment)
Action: finalize terminology + fix link behavior consistently, then resolve the entire wording/UX thread.

Brian @brianteeman, can you confirm? Thank you!

brianteeman - comment - 22 Jul 2026

maybe you had these as I might have misunderstood your notes

Follow the style guide for UI strings #47947 (comment)

Check the usage of title/aria-label #47947 (comment)

Guage strings with % values #47947 (comment)

obuisard - comment - 22 Jul 2026

maybe you had these as I might have misunderstood your notes

Follow the style guide for UI strings #47947 (comment)

Check the usage of title/aria-label #47947 (comment)

Guage strings with % values #47947 (comment)

Yes, that was in my notes, I used copilot to make sure I had all covered :-)

brianteeman - comment - 22 Jul 2026

one more which I dont think there was an open issue for but was mentioned in the meeting

Don't show the HealthCheck menu item in the sidebar if there are no healthchecks published on that dashboard

brianteeman - comment - 24 Jul 2026

I was looking at the heart icon to see if there were some alternatives to consider

current

heart-pulse

house-medical

suitcase-medical

laptop-medical

joomla-cms-bot - change - 26 Jul 2026

Category

Administration com_cpanel com_menus Language & Strings Modules Layout Libraries JavaScript SQL Installation Postgresql Repository com_admin

⇒

SQL Administration com_admin Postgresql com_cpanel com_menus com_users Language & Strings Modules JavaScript Repository Installation Layout Libraries

joomla-cms-bot - change - 26 Jul 2026

Category

Administration com_cpanel com_menus Language & Strings Modules Layout Libraries JavaScript SQL Installation Postgresql Repository com_admin com_users

⇒

SQL Administration com_admin Postgresql com_cpanel com_menus com_users Language & Strings Modules JavaScript Repository Installation Layout

obuisard - change - 27 Jul 2026

The description was changed

obuisard - edited - 27 Jul 2026

obuisard - change - 27 Jul 2026

The description was changed

obuisard - edited - 27 Jul 2026

obuisard - change - 27 Jul 2026

The description was changed

obuisard - edited - 27 Jul 2026

obuisard - comment - 27 Jul 2026

The color contrast for review is not sufficient. This color (warning) It is a long existing error in atum, but not visible on other places. (Except during update/migration checks)

I changed the color for proper color contrast.

coolcat-creations - comment - 11 Aug 2026

Thank you @obuisard
Would it be possible to implement this idea into this PR? #48232

obuisard - comment - 11 Aug 2026

Thank you @obuisard Would it be possible to implement this idea into this PR? #48232

Hi Elisa @coolcat-creations this is definitely in line with what we are trying to do with Health-Check.
The health indicator you mentioned could be a quickicon that seats in the main dashboard of the Joomla console, gives a health degree and links to the Health Check dashboard.

In this initial implementation, we do not want to put Health Check forward to the users, we want to put everything in place so that developers can start implementing plugins for it.

I see your idea part of 'phase 2' (planned for 6.3) where many plugins are in place or available to download and where the Health Check dashboard gives users meaningful information and tools to improve their sites.

obuisard - change - 12 Aug 2026

The description was changed

obuisard - edited - 12 Aug 2026

obuisard - change - 12 Aug 2026

The description was changed

obuisard - edited - 12 Aug 2026

obuisard - change - 12 Aug 2026

The description was changed

obuisard - edited - 12 Aug 2026

obuisard - change - 12 Aug 2026

The description was changed

obuisard - edited - 12 Aug 2026

obuisard - change - 12 Aug 2026

The description was changed

obuisard - edited - 12 Aug 2026

obuisard - change - 12 Aug 2026

The description was changed

obuisard - edited - 12 Aug 2026

brianteeman - comment - 12 Aug 2026

is this ready for new tests or do you still have more work planned?

obuisard - comment - 12 Aug 2026

is this ready for new tests or do you still have more work planned?

Hi Brian @brianteeman this is ready for testing. Thank you for your help.

brianteeman - comment - 14 Aug 2026

The code has a comment

But this is what I have after applying the PR - so its not working as intended?

brianteeman - comment - 14 Aug 2026

The code has a comment

	<!-- Health Check: only show this entry when at least one mod_healthcheck instance
	     is published in the cpanel-healthcheck position. If no such module exists
	     (e.g. not yet installed or unpublished) the menu item is suppressed entirely. -->

But this is what I have after applying the PR - so its not working as intended?

brianteeman - comment - 14 Aug 2026

The code has a comment

	<!-- Health Check: only show this entry when at least one mod_healthcheck instance
	     is published in the cpanel-healthcheck position. If no such module exists
	     (e.g. not yet installed or unpublished) the menu item is suppressed entirely. -->

But this is what I have after applying the PR - so its not working as intended?

Checking further and the problem is not with the check mantioned above. There is a module - its just not displayed

sdwjoomla - test_item - 17 Aug 2026 - Tested successfully

obuisard - change - 23 Aug 2026

Labels

Added: Feature

obuisard - comment - 23 Aug 2026

The code has a comment
	
But this is what I have after applying the PR - so its not working as intended?

Checking further and the problem is not with the check mantioned above. There is a module - its just not displayed

I noticed it works fine if the module is saved but NOT if the module is just published/unpublished from the modules list.

obuisard - comment - 23 Aug 2026

The code has a comment
	
But this is what I have after applying the PR - so its not working as intended?

Checking further and the problem is not with the check mantioned above. There is a module - its just not displayed

I noticed it works fine if the module is saved but NOT if the module is just published/unpublished from the modules list.
Not sure why.

Add a Comment

Older
Newer

[#47947] - [6.2] Initial implementation of a Health Check system and dashboard

Summary of Changes

Testing Instructions

Health Check Plugin Developer Guide

1) How the Health Check plugin system works

2) Minimal plugin structure

yourplugin.xml essentials

services/provider.php essentials

src/Extension/YourPlugin.php essentials

3) Event subscriptions and payload contracts

Event names

Expected return pattern

Context guard pattern

4) Icon items (button layout)

Required fields

Common fields

Example (based on usermaintenance)

5) Gauge items

Required fields

Useful optional fields

Example

6) List items

Required fields

Useful optional fields

Example

7) Table items

Required fields

Column definition basics

Example

8) Full subscriber example

9) Grouping and access control

10) Testing checklist

11) Practical notes from current implementation

12) How healthcheck-filters works

What filters are available

What plugin authors should set

Where filtering applies

Status aliases accepted by the module filter

Quick usage example

Testing filter behavior

13) CSP-safe onclick handlers

Registering a handler

Setting onclick in your PHP payload

Loading your JS asset

Complete example

Link to documentations

Inactive Users

current

heart-pulse

house-medical

suitcase-medical

laptop-medical

Add a Comment

`yourplugin.xml` essentials

`services/provider.php` essentials

`src/Extension/YourPlugin.php` essentials

Example (based on `usermaintenance`)

12) How `healthcheck-filters` works

Setting `onclick` in your PHP payload