backupchecks/docs/reporting-proposal.md

137 lines
2.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Proposal Advanced Reporting & Visualization
## Goal
Make reports more flexible through column selection and more insightful by adding graphical visualizations.
All reports are displayed online first, with a clear path towards future PDF export.
---
## 1. Column Selection When Creating Reports
### 1.1 Report Configuration
Add an extra step **“Report Content”** when creating a report:
- Checkbox list of available columns
- Drag & drop to define column order
- Option to **save as template** for reuse
### 1.2 Column Groups
Columns are grouped for clarity:
**Job Information**
- Job name
- Job type
- Repository / Target
**Status**
- Last run status
- Result (Success / Warning / Failed)
- Exit code
**Time & Performance**
- Start time
- Duration
- Average duration
**Data**
- Data processed
- Data size
- Change rate
**Reliability**
- Consecutive failures
- Last successful run
---
## 2. Graphical Reports (Online Dashboard)
### 2.1 Summary View
Always shown at the top of a report:
**KPI Cards**
- Total jobs
- Successful jobs
- Failed jobs
- Warning jobs
- Success rate (%)
---
### 2.2 Chart Proposals
**Status Distribution**
- Donut / pie chart: Success vs Warning vs Failed
**Trends Over Time**
- Line chart: success rate per day
- Line chart: number of failures per day
**Performance**
- Bar chart: average runtime per job
- Bar chart: largest data volumes per job
**Reliability**
- Heatmap: failures per job per day
- Bar chart: top N jobs with most failures
---
### 2.3 Interaction
- Hover tooltips with detailed values
- Clicking a chart filters the table view
- Time range selector:
- Last 24 hours
- Last 7 days
- Last 30 days
- Custom range
---
## 3. Raw Data vs Graphical View
### 3.1 Tabs per Report
- **Overview** KPIs and charts only
- **Details** table with selected columns
- **History** long-term trends
### 3.2 Filtering & Sorting
- Filter by status
- Filter by job
- Sort by duration, date, or failures
---
## 4. Preparation for PDF Export (Future)
### 4.1 Layout Guidelines
- Fixed A4-friendly layout
- Maximum two charts per row
- Dark text on light background
- Non-interactive chart rendering in PDF mode
### 4.2 PDF-Ready Structure
1. Title and period
2. Executive summary (KPIs)
3. Status overview
4. Trend analysis
5. Optional detail tables
---
## 5. Technical Principles (High-Level)
- Store report definitions as JSON:
- Selected columns
- Chart types
- Filters
- Client-side chart rendering
- Same report definition reusable for PDF rendering later
---
## Result
- Flexible, audience-focused reports
- Faster insight through visual summaries
- Clean transition to professional PDF reports without redesign