Reports & Health Score

beginner concepts

Reports & Health Score

EDP emits three report formats, computes a per-module Health Score.

Formats

Format	Use it for
JSON	Programmatic post-processing, custom dashboards, attaching to PRs. Schema documented in `docs/report-schema.md`; `schema` field at the root for forward compatibility.
CSV	Spreadsheet review and quick pivots. Flat one-row-per-finding format, RFC 4180 quoting, UTF-8.
HTML	Standalone styled page, ready to share with the team or attach to a ticket. No external dependencies, opens in any browser.

Exporting

From the Doctor toolbar after a scan completes, click JSON, CSV or HTML. Pick a destination on disk via the standard save panel. The JSON is the canonical format - CSV and HTML are derived from it.

From the CLI, use --report file.json for JSON, --csv-report file.csv for CSV, --html-report file.html for HTML. Multiple flags can be combined to emit all three in one run.

Health Score

The Health Score is a 0-100 integer per module plus a project-wide aggregate. Each finding penalises its module's score by a configurable weight (default: Critical 20, Error 5, Warn 1, Info 0). The per-module score is max(0, 100 - sum(penalty)); the project aggregate is the average across modules.

The score appears as a ring gauge on the Doctor's Overview tab and as a single number in the JSON / HTML reports. Tune the penalties under Settings > Health Score.

JSON schema

Top-level keys: schema, tool, project, scan, summary, issues[], suppressedIssues[]. Each issue carries id, checkId, module, severity, title, description, location, fixable, fixDescription, optional rootCause, suppressed and tags[]. The full schema lives in docs/report-schema.md in the EDP repo.

Tip: Pin the JSON schema version in your CI pipeline (check the schema field on every report) so when EDP bumps the schema you fail loud rather than silently miss new fields.

Was this page helpful? |

Reports & Health Score