Skip to content
Merged
Show file tree
Hide file tree
Changes from 64 commits
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
fd6c3e0
extract not-ready server HTML logic into a reusable component
guidomodarelli Aug 26, 2025
b6c45d8
refactor healthcheck component and externalize styles
guidomodarelli Aug 26, 2025
e2b6d7b
remove unused stylesheet link from healthcheck component
guidomodarelli Aug 26, 2025
acf2a60
refactor server readiness component for reusability
guidomodarelli Aug 26, 2025
537de0f
add serverBasePath prop and refactor types
guidomodarelli Aug 26, 2025
2c01a7f
move troubleshooting link to route handler
guidomodarelli Aug 26, 2025
6032371
add health check client script and server route integration
guidomodarelli Aug 26, 2025
4f3f8ca
refactor healthcheck dashboard assets and routes
guidomodarelli Aug 26, 2025
fcd2318
introduce HttpService for cleaner API interactions
guidomodarelli Aug 26, 2025
6678975
refactor health check client to improve task handling
guidomodarelli Aug 26, 2025
33d9d92
refactor health check client to improve task handling
guidomodarelli Aug 26, 2025
f993123
refactor health check service and use cases
guidomodarelli Aug 26, 2025
25a5012
rename method to clarify its purpose in health check execution
guidomodarelli Aug 26, 2025
321e2f7
rename methods for clarity and consistency
guidomodarelli Aug 26, 2025
05befd9
refactor task filtering logic for critical and non-critical tasks
guidomodarelli Aug 27, 2025
2fccd0b
refactor health check content rendering logic
guidomodarelli Aug 27, 2025
2664a2d
refactor health check rendering logic
guidomodarelli Aug 27, 2025
5b6b2b8
rename utility functions for consistency
guidomodarelli Aug 27, 2025
d4d31ec
introduce «HealthCheckDocument» to centralize DOM element access
guidomodarelli Aug 27, 2025
66bfac1
refine export logic and update button styles
guidomodarelli Aug 27, 2025
fb115e9
update health check root element and layout
guidomodarelli Aug 27, 2025
906a2ed
add UTF-8 charset meta tag and fix script tag syntax
guidomodarelli Aug 27, 2025
0b022db
refactor health check API endpoint handling
guidomodarelli Aug 27, 2025
55c51db
rename function «configureNotReadyRoutes» to «configureDashboardServe…
guidomodarelli Aug 27, 2025
87c0aa7
improve health check UI and integrate reset styles
guidomodarelli Aug 27, 2025
5592c88
improve health check UI and refactor components
guidomodarelli Aug 27, 2025
2d0bc58
add responsive styles for smaller screen widths
guidomodarelli Aug 27, 2025
b5c062e
add «wrench» icon and integrate it into critical error message
guidomodarelli Aug 27, 2025
50acae4
improve health check UI and standardize color variables
guidomodarelli Aug 27, 2025
1e6b171
add «isCritical» property to task definition
guidomodarelli Aug 27, 2025
c8781ee
add rendering for critical and non-critical health check items
guidomodarelli Aug 27, 2025
9abac29
update font-weight handling and improve consistency in styles
guidomodarelli Aug 27, 2025
9c38ede
enhance styling for critical and non-critical task display
guidomodarelli Aug 27, 2025
dbabca6
update styles and improve table structure for consistency
guidomodarelli Aug 27, 2025
3887cc3
update function «buildHealthCheckReport» to conditionally render non-…
guidomodarelli Aug 27, 2025
446baf6
replace React components with static HTML and streamline health check UI
guidomodarelli Aug 27, 2025
ba1951c
refactor task filtering and enhance type safety
guidomodarelli Aug 28, 2025
5b02ad4
update logic for «filterEnabledFinishedFailedTasks» to handle single …
guidomodarelli Aug 28, 2025
5dc501c
refactor enums and typedefs for clarity and encapsulation
guidomodarelli Aug 28, 2025
5c485a3
add detailed definitions and rules for health check statuses
guidomodarelli Aug 28, 2025
e34aa54
replace «<span>» with «<code>» for semantic accuracy
guidomodarelli Aug 28, 2025
ac12200
add support for custom monospace font and code block styling
guidomodarelli Aug 28, 2025
cf3a1d8
add running state management and improve UI feedback for health checks
guidomodarelli Aug 28, 2025
2eca071
enhance styling for improved readability and consistency
guidomodarelli Aug 28, 2025
8a80a3c
add hover effect for table rows
guidomodarelli Aug 28, 2025
1831c3f
align icons with adjacent text in health check UI
guidomodarelli Aug 28, 2025
6e44b33
remove unused CSS property «gap» from «.title»
guidomodarelli Aug 28, 2025
bddfbcb
update export functionality for health checks
guidomodarelli Aug 29, 2025
219c35c
update «BTN_EXPORT_ID» and related styles to «btn-download»
guidomodarelli Aug 29, 2025
d62674e
add animations for smoother UI interactions
guidomodarelli Aug 29, 2025
517fc94
add reusable shadow variables and improve box-shadow consistency
guidomodarelli Aug 29, 2025
af49260
update card animation delays for smoother staggered effect
guidomodarelli Aug 29, 2025
e5d7e98
add formatting utilities and improve critical item display
guidomodarelli Aug 29, 2025
3d476b9
add warning icon and redesign non-critical items list
guidomodarelli Aug 29, 2025
e03ac7f
add hover and active state styles for «critical-item» and «noncritica…
guidomodarelli Aug 29, 2025
0a79884
add new SVG icon and integrate it into critical items
guidomodarelli Aug 29, 2025
23541c7
add padding to improve layout spacing
guidomodarelli Aug 29, 2025
0d702ad
improve CSS for responsive layout and text wrapping
guidomodarelli Aug 29, 2025
0b33d79
reformat CSS for improved readability
guidomodarelli Aug 29, 2025
5ffcffe
update icon labels and refactor related variable names
guidomodarelli Aug 29, 2025
dce3837
add unit tests for dashboard server not ready routes and renderer
guidomodarelli Sep 2, 2025
4e3bd3e
add unit tests for client-side health check script
guidomodarelli Sep 2, 2025
eb45fad
add test for feedback and success notice after critical errors resolve
guidomodarelli Sep 2, 2025
56b4854
Merge branch 'enhancement/7610-rework-healthcheck' into enhacement/76…
guidomodarelli Sep 5, 2025
ef3fbfc
add license headers to healthcheck dashboard server files
guidomodarelli Sep 5, 2025
61c377e
simplify font imports for improved maintainability
guidomodarelli Sep 5, 2025
7f9a92b
update success message after critical errors are resolved
guidomodarelli Sep 5, 2025
f1dd587
update changelog to reference additional pull request
guidomodarelli Sep 5, 2025
3446b66
refactor server not ready route registration logic
guidomodarelli Sep 9, 2025
31f290f
embed local fonts for server not ready dashboard
guidomodarelli Sep 9, 2025
ffcc804
support non-critical failures with yellow result
guidomodarelli Sep 9, 2025
fbce626
remove support for yellow warning state in task results
guidomodarelli Sep 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions src/core/server/healthcheck/healthcheck/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,55 @@ The backend service registers routes to manage the related data:

- `POST /api/healthcheck/internal`: allow to run info of the checks. This allows to use the `name` query parameter to get specific checks.

## Definitions and rules

* **Task / individual check**

* status (only `not_started`, `in_progress`, or `finished`)
* result (only `green`, `red`, or `gray`)

* `green`: OK
* `red`: failed
* `gray`: unknown / not executed (typically because `status != "finished"`)
* **Failed** ⟶ when `result == "red"` (and `status` is `finished`).
* `isCritical` is **independent** of `result`: it indicates whether the check is critical or not, **not** whether it failed.

* A check can be `red` and **critical** or `red` and **non-critical**.
* `true` = **critical**; `false` or absent = **non-critical**.
* When a task is considered “failed”

* `failed` ⇢ `isEnabled == true` and `status == "finished"` and `result == "red"`.
* Criticality does **not** affect whether it is failed; it only affects the **summary**.

* **Check summary (aggregate of the set of tasks)**

* `result` can be: `red`, `yellow`, `green` or `gray`.
* **Red** in the summary when there is **at least one critical task with `result == "red"`**.
* **Yellow** appears **only in the summary** when there are **no critical failures** and there is **some non-critical task** with `result == "red"`.
* **Green** in the summary when all tasks are **finished** and the critical ones are `green`.
* **Gray** in any other case (e.g., all `gray` or no tasks enabled).
* The summary does **not** have `isCritical` (because it is already inferred from the tasks).

### Answers to the doubts

1. **“For a task to be considered *failed*, must it be different from `green` and `gray`; that is `red` or `yellow`?”**
**No.** In an **individual task**, *failed* is **only** `red`. `Yellow` does **not** exist at the task level, only in the **summary**.

2. **“If `result` is `red`, doesn’t that already imply it’s critical and `isCritical` is redundant?”**
**No.** `red` indicates **failure**; `isCritical` indicates **criticality**. Both are needed: the summary uses that combination to decide whether to show **`red`** (critical failure) or **`yellow`** (non-critical failure).

### Quick table

| Level | Possible `result` values | `yellow`? | When is it *failed*? |
| ------------- | -------------------------------- | --------- | -------------------------- |
| Task / Check | `red`, `green`, `gray` | No | Only if `result == red` |
| Check Summary | `red`, `yellow`, `green`, `gray` | Yes | N/A (aggregate state only) |

### Conclusion:
- The `yellow` result is **only used in the summary**, never for individual tasks.
- The `isCritical` property is **not redundant** with `result`; both are required to determine the overall status.


# Notes

- The list of enabled checks are listed in a `info` log in the app logs. This can be used to know the check task names to create a regular expression to filter the enabled checks.
Expand Down
Loading
Loading