Exporting Reports

Health Checker lets you export your check results in multiple formats for sharing with your team, hosting provider, or for record-keeping. The dedicated Export page gives you full control over what gets included.

Available Export Formats

HTML Export

Human-readable formatted report perfect for:

• Sharing with clients or team members
• Sending to your hosting provider
• Archiving for compliance
• Printing for offline review

JSON Export

Structured data format ideal for:

• Programmatic analysis
• Integration with monitoring systems
• Version control tracking
• Automated processing

Markdown Export

Plain text format suited for:

• Pasting into support tickets
• Client messages and chat apps
• Documentation and wikis
• Quick sharing without formatting overhead

How to Export

Using the Export Page

1. Run a health check to generate results
2. Click the Export button in the toolbar
3. On the Export page, configure your options:
   • Format: Choose HTML, JSON, or Markdown
   • Status filter: Export all checks or only issues (warning and critical)
   • Categories: Select which categories to include
   • Individual checks: Toggle specific checks on or off
4. Click Download Report

The export runs all checks fresh and applies your selected filters before generating the file.

File Naming

Exported files are automatically named with the date:

• health-report-2026-01-12.html
• health-report-2026-01-12.json
• health-report-2026-01-12.md

Export Filters

Status Filter

Choose between two modes:

Option	What's Included
Full Report	All checks regardless of result (default)
Issues Only	Only checks with Warning or Critical status

"Issues Only" is useful when you want a focused report highlighting problems without the noise of passing checks.

Category Filter

Select which categories to include in the export. All categories are included by default. Deselecting a category removes all its checks from the export.

Individual Check Filter

For fine-grained control, expand any category to toggle individual checks on or off. This lets you build a custom report with exactly the checks that matter for your audience.

JSON Export Format

Structure

{
  "lastRun": "2026-01-12T15:30:00+00:00",
  "summary": {
    "critical": 2,
    "warning": 15,
    "good": 116,
    "total": 133
  },
  "categories": [...],
  "providers": [...],
  "results": [
    {
      "slug": "core.php_version",
      "title": "PHP Version Check",
      "category": "system",
      "provider": "core",
      "status": "good",
      "description": "PHP 8.2.14 meets Joomla 5 requirements"
    }
  ]
}

Use Cases

Tracking Changes Over Time

# Save weekly snapshots
cp health-report-2026-01-12.json reports/week-02.json

# Compare with previous week
diff reports/week-01.json reports/week-02.json

Automated Monitoring

# Check for critical issues
jq '.summary.critical' health-report.json

# Extract only critical checks
jq '.results[] | select(.status=="critical")' report.json

Integration with CI/CD

# Fail build if critical issues found
CRITICAL=$(jq '.summary.critical' report.json)
if [ "$CRITICAL" -gt 0 ]; then
  echo "Critical health issues found!"
  exit 1
fi

HTML Export Format

Features

The HTML export includes:

• Styled report: Clean design with status badges and summary cards
• Complete results: All checks with full descriptions
• Summary statistics: Count of critical/warning/good results
• Metadata: Site name, Joomla version, generation date
• Printable: Print-optimized CSS
• Self-contained: No external dependencies — one file, no CDN links

Opening HTML Reports

The HTML file can be:

• Opened directly in any web browser
• Shared via email (it's just one file)
• Printed to PDF for archiving
• Hosted on a web server for team access

Markdown Export Format

Features

The Markdown export produces a plain text .md file with:

• Summary statistics table
• Results organized by category in tables
• Status emoji indicators (🔴 🟡 🟢)
• Links to documentation for each check
• Provider attribution for third-party checks

Use Cases

• Paste directly into GitHub issues, Slack, or Teams
• Include in client communications
• Add to project documentation or wikis

Per-Check Export Visibility

Export visibility lets you exclude specific checks from exports without disabling them. The check still runs and appears in the admin UI — it just won't appear in exported reports.

This is useful when sharing reports with clients or external parties and you want to omit checks that aren't relevant to them (such as server-level configuration checks) or checks that always pass and add noise.

Configuring Export Visibility

1. Go to Extensions → Plugins
2. Open the plugin that provides the check (e.g., "Health Checker - Core Checks")
3. Find the check in the configuration list
4. Set the Export Visibility dropdown next to the check

Visibility Modes

Option	Behaviour
Always Export	Included in every export regardless of result (default)
Issues Only	Included only when the result is Warning or Critical
Never Export	Never included in exports

Common Use Cases

• Client reports: Set server-environment checks (PHP version, MySQL config) to "Never Export" so clients only see application-level issues that need their attention
• Noise reduction: Set checks that consistently pass (e.g., a check you've already resolved) to "Issues Only" to keep reports focused
• Example/demo checks: Set any placeholder checks to "Never Export" so they don't appear in production reports

How It Affects Exports

The export summary counts only the checks included in the export. A check set to "Never Export" does not affect the critical/warning/good totals shown in the report header.

Export Visibility vs Export Page Filters

Export Visibility is a per-check plugin setting that applies globally to all exports. The Export page filters are per-export choices that let you further narrow results for a specific download. Both are applied — a check must pass both to appear in the output.

Export Tips

When to Export

Export reports:

• Before major updates or changes
• After fixing critical issues (to document resolution)
• Monthly for compliance/archiving
• When requesting support from hosting provider
• After site migrations

Storage Recommendations

For Version Control

# Add to git (JSON format recommended)
git add reports/health-report-$(date +%Y-%m-%d).json
git commit -m "Health check: $(date +%Y-%m-%d)"

For Long-Term Archives

# Compress old reports
gzip reports/health-report-2025-*.{json,html,md}

# Organize by year/month
reports/
├── 2025/
│   ├── 01/
│   ├── 02/
│   └── ...
└── 2026/
    └── 01/

Privacy Considerations

Health check reports may contain:

• Site URLs and paths
• PHP configuration details
• Database information (not passwords)
• Extension names and versions
• User account counts

Before sharing externally:

• Review the report for sensitive information
• Remove or redact anything confidential
• Share only with trusted parties
• Use secure channels (encrypted email, secure file sharing)

Automated Export Workflows

While Health Checker doesn't include scheduling in the free version, you can create manual workflows:

Weekly Review Process

1. Monday Morning: Run health check
2. Export JSON: Save to dated file
3. Compare: Check for new issues vs. last week
4. Address: Fix any new warnings/critical items
5. Document: Commit report to version control

Pre-Deployment Checklist

1. Run health check on staging site
2. Export HTML report
3. Review and fix all critical issues
4. Re-run and export clean report
5. Deploy to production
6. Run health check on production
7. Compare staging vs. production reports

Next Steps

• Dashboard Widget - Monitor health at a glance
• Understanding Checks - Learn what each check does
• Checks Reference - Detailed check documentation