Page MenuHomeDevCentral

Health check and reporting library
Open, NormalPublic

Description

Sites like Zed could benefit of some assistance to help to configure it.

I'm preparing there a SiteHealth engine with two kind of classes:

  • Checks:
  • Reporting: a way to organize information into sections and entries
    • Report: the main report, a container with title, metadata and sections
    • ReportSection: a collection of entries, and a title
    • ReportEntry: a title and a text

The reporting part can clearly be defined into rKOT, as a part of collections.
A new reporting library would be welcome if we plan to offer extra capabilities,
but if we only want 3 classes ton contain data, what's the point? Perhaps to offer
capabilities like output in Markdown (for CLI use) and HTML.

For the health check, code can live in Zed or in a specialized library
providing everything excepted the checks themselves.

Event Timeline

dereckson triaged this task as Normal priority.Feb 6 2022, 19:57
dereckson created this task.

Some notes about the CLI tool.

We can provide a bin/health command with 3 solutions to find HealthReport instance:

A. health <class name>: good luck to know what autoloader to use as we need the implementor application one.

B. A health.xml/json/yml configuration file with class name + loader

C. Idem with a method responsible to construct the report instance.