feat: Add base HTML template and implement dashboard, logs, and service views

- Created a base HTML template for consistent layout across pages.
- Developed a dashboard page to display backup service metrics and statuses.
- Implemented a log viewer for detailed log file inspection.
- Added error handling page for better user experience during failures.
- Introduced service detail page to show specific service metrics and actions.
- Enhanced log filtering and viewing capabilities.
- Integrated auto-refresh functionality for real-time updates on metrics.
- Created integration and unit test scripts for backup metrics functionality.
This commit is contained in:
Peter Wood
2025-06-18 08:06:08 -04:00
parent d066f32b10
commit 6d726cb015
34 changed files with 6006 additions and 26 deletions

85
templates/base.html Normal file
View File

@@ -0,0 +1,85 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{% block title %}Backup Monitor{% endblock %}</title>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet">
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/all.min.css" rel="stylesheet">
<link href="{{ url_for('static', filename='css/custom.css') }}" rel="stylesheet">
</head>
<body>
<!-- Navigation -->
<nav class="navbar navbar-expand-lg navbar-dark bg-dark">
<div class="container">
<a class="navbar-brand" href="{{ url_for('index') }}">
<i class="fas fa-database me-2"></i>Backup Monitor
</a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarNav">
<ul class="navbar-nav me-auto">
<li class="nav-item">
<a class="nav-link" href="{{ url_for('index') }}">
<i class="fas fa-home me-1"></i>Dashboard
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="{{ url_for('logs_view') }}">
<i class="fas fa-file-alt me-1"></i>Logs
</a>
</li>
</ul>
<ul class="navbar-nav">
<li class="nav-item">
<button class="btn btn-outline-light btn-sm" onclick="refreshMetrics()">
<i class="fas fa-sync-alt me-1"></i>Refresh
</button>
</li>
<li class="nav-item ms-2">
<span class="navbar-text">
<small id="last-updated">Loading...</small>
</span>
</li>
</ul>
</div>
</div>
</nav>
<!-- Main Content -->
<main class="container-fluid mt-4">
{% with messages = get_flashed_messages() %}
{% if messages %}
{% for message in messages %}
<div class="alert alert-info alert-dismissible fade show" role="alert">
{{ message }}
<button type="button" class="btn-close" data-bs-dismiss="alert"></button>
</div>
{% endfor %}
{% endif %}
{% endwith %}
{% block content %}{% endblock %}
</main>
<!-- Footer -->
<footer class="bg-light mt-5 py-3">
<div class="container text-center">
<small class="text-muted">
Backup Monitor v1.0 |
<a href="/health" target="_blank">System Health</a> |
<span id="status-indicator" class="text-success">
<i class="fas fa-circle me-1"></i>Online
</span>
</small>
</div>
</footer>
<!-- Scripts -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js"></script>
<script src="{{ url_for('static', filename='js/app.js') }}"></script>
{% block scripts %}{% endblock %}
</body>
</html>

197
templates/dashboard.html Normal file
View File

@@ -0,0 +1,197 @@
{% extends "base.html" %}
{% block title %}Dashboard - Backup Monitor{% endblock %}
{% block content %}
<div class="container mt-4">
<!-- Header -->
<div class="row mb-4">
<div class="col-12">
<h1 class="display-4">
<i class="fas fa-tachometer-alt text-primary me-3"></i>
Backup Dashboard
</h1>
<p class="lead text-muted">Monitor and manage your backup services</p>
</div>
</div>
<!-- Status Overview -->
<div class="row mb-4">
<div class="col-md-3">
<div class="card bg-success text-white">
<div class="card-body">
<div class="d-flex justify-content-between">
<div>
<h4>{{ data.summary.successful }}</h4>
<p class="mb-0">Successful</p>
</div>
<div class="align-self-center">
<i class="fas fa-check-circle fa-2x"></i>
</div>
</div>
</div>
</div>
</div>
<div class="col-md-3">
<div class="card bg-warning text-white">
<div class="card-body">
<div class="d-flex justify-content-between">
<div>
<h4>{{ data.summary.partial }}</h4>
<p class="mb-0">Partial</p>
</div>
<div class="align-self-center">
<i class="fas fa-exclamation-triangle fa-2x"></i>
</div>
</div>
</div>
</div>
</div>
<div class="col-md-3">
<div class="card bg-danger text-white">
<div class="card-body">
<div class="d-flex justify-content-between">
<div>
<h4>{{ data.summary.failed }}</h4>
<p class="mb-0">Failed</p>
</div>
<div class="align-self-center">
<i class="fas fa-times-circle fa-2x"></i>
</div>
</div>
</div>
</div>
</div>
<div class="col-md-3">
<div class="card bg-info text-white">
<div class="card-body">
<div class="d-flex justify-content-between">
<div>
<h4>{{ data.summary.total }}</h4>
<p class="mb-0">Total Services</p>
</div>
<div class="align-self-center">
<i class="fas fa-server fa-2x"></i>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- Service Cards -->
<div class="row">
{% for service in data.services %}
<div class="col-lg-4 col-md-6 mb-4">
<div class="card h-100 service-card" data-service="{{ service.service }}">
<div class="card-header d-flex justify-content-between align-items-center">
<h5 class="mb-0">
<i class="fas fa-{{ service.icon | default('database') }} me-2"></i>
{{ service.service | title }}
</h5>
<span class="badge bg-{{ 'success' if service.status == 'success' else 'warning' if service.status == 'partial' else 'danger' if service.status == 'failed' else 'secondary' }}">
{{ service.status | title }}
</span>
</div>
<div class="card-body">
<p class="card-text text-muted">{{ service.description }}</p>
{% if service.start_time %}
<div class="mb-2">
<small class="text-muted">
<i class="fas fa-clock me-1"></i>
Last Run: {{ service.start_time | default('Never') }}
</small>
</div>
{% endif %}
{% if service.duration_seconds %}
<div class="mb-2">
<small class="text-muted">
<i class="fas fa-stopwatch me-1"></i>
Duration: {{ (service.duration_seconds / 60) | round(1) }} minutes
</small>
</div>
{% endif %}
{% if service.files_processed %}
<div class="mb-2">
<small class="text-muted">
<i class="fas fa-file me-1"></i>
Files: {{ service.files_processed }}
</small>
</div>
{% endif %}
{% if service.total_size_bytes %}
<div class="mb-2">
<small class="text-muted">
<i class="fas fa-hdd me-1"></i>
Size: {{ (service.total_size_bytes / 1024 / 1024 / 1024) | round(2) }}GB
</small>
</div>
{% endif %}
{% if service.current_operation %}
<div class="mb-2">
<small class="text-muted">
<i class="fas fa-info-circle me-1"></i>
{{ service.current_operation }}
</small>
</div>
{% endif %}
{% if service.message and service.status != 'success' %}
<div class="alert alert-{{ 'warning' if service.status == 'partial' else 'danger' }} py-1 px-2 mt-2">
<small>{{ service.message }}</small>
</div>
{% endif %}
</div>
<div class="card-footer">
<div class="d-flex justify-content-between">
<a href="{{ url_for('service_detail', service_name=service.service) }}" class="btn btn-outline-primary btn-sm">
<i class="fas fa-eye me-1"></i>Details
</a>
{% if service.backup_path %}
<small class="text-muted">
<i class="fas fa-folder me-1"></i>Backup Path: <code>{{ service.backup_path }}</code>
</small>
{% endif %}
</div>
</div>
</div>
</div>
{% endfor %}
</div>
<!-- Empty State -->
{% if not data.services %}
<div class="row">
<div class="col-12">
<div class="text-center py-5">
<i class="fas fa-database fa-4x text-muted mb-3"></i>
<h3 class="text-muted">No backup services found</h3>
<p class="text-muted">No backup metrics are available at this time.</p>
<button class="btn btn-primary" onclick="refreshMetrics()">
<i class="fas fa-sync-alt me-1"></i>Refresh
</button>
</div>
</div>
</div>
{% endif %}
</div>
<script>
function refreshMetrics() {
location.reload();
}
// Auto-refresh every 30 seconds
setInterval(refreshMetrics, 30000);
// Update last updated time
document.addEventListener('DOMContentLoaded', function() {
document.getElementById('last-updated').textContent = 'Last updated: ' + new Date().toLocaleTimeString();
});
</script>
{% endblock %}

33
templates/error.html Normal file
View File

@@ -0,0 +1,33 @@
{% extends "base.html" %}
{% block title %}Error{% endblock %}
{% block content %}
<div class="container mt-5">
<div class="row justify-content-center">
<div class="col-md-6">
<div class="text-center">
<i class="fas fa-exclamation-triangle fa-5x text-warning mb-4"></i>
<h1 class="display-4">{{ error_code | default('Error') }}</h1>
<p class="lead">{{ error_message | default('An unexpected error occurred.') }}</p>
{% if error_details %}
<div class="alert alert-danger text-start mt-4">
<h6 class="alert-heading">Error Details:</h6>
<pre class="mb-0">{{ error_details }}</pre>
</div>
{% endif %}
<div class="mt-4">
<a href="{{ url_for('index') }}" class="btn btn-primary me-2">
<i class="fas fa-home me-1"></i>Go to Dashboard
</a>
<button onclick="history.back()" class="btn btn-outline-secondary">
<i class="fas fa-arrow-left me-1"></i>Go Back
</button>
</div>
</div>
</div>
</div>
</div>
{% endblock %}

138
templates/log_viewer.html Normal file
View File

@@ -0,0 +1,138 @@
{% extends "base.html" %}
{% block title %}Log: {{ filename }} - Backup Monitor{% endblock %}
{% block content %}
<div class="container-fluid mt-4">
<!-- Header -->
<div class="row mb-4">
<div class="col-12">
<nav aria-label="breadcrumb">
<ol class="breadcrumb">
<li class="breadcrumb-item"><a href="{{ url_for('index') }}">Dashboard</a></li>
<li class="breadcrumb-item"><a href="{{ url_for('logs_view') }}">Logs</a></li>
<li class="breadcrumb-item active">{{ filename }}</li>
</ol>
</nav>
<div class="d-flex justify-content-between align-items-center">
<h1 class="display-6">
<i class="fas fa-file-alt text-primary me-3"></i>
{{ filename }}
</h1>
<div class="btn-group">
<button class="btn btn-outline-primary" onclick="refreshLog()">
<i class="fas fa-sync-alt me-1"></i>Refresh
</button>
<a href="/api/logs/download/{{ filename }}" class="btn btn-outline-secondary">
<i class="fas fa-download me-1"></i>Download
</a>
<a href="{{ url_for('logs_view') }}" class="btn btn-outline-dark">
<i class="fas fa-arrow-left me-1"></i>Back to Logs
</a>
</div>
</div>
</div>
</div>
<!-- Log Info -->
<div class="row mb-3">
<div class="col-12">
<div class="card">
<div class="card-body py-2">
<div class="row text-center">
<div class="col-md-3">
<small class="text-muted">File Size:</small>
<strong class="d-block">{{ file_size }}</strong>
</div>
<div class="col-md-3">
<small class="text-muted">Last Modified:</small>
<strong class="d-block">{{ last_modified }}</strong>
</div>
<div class="col-md-3">
<small class="text-muted">Lines:</small>
<strong class="d-block">{{ total_lines }}</strong>
</div>
<div class="col-md-3">
<small class="text-muted">Showing:</small>
<strong class="d-block">Last {{ lines_shown }} lines</strong>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- Log Content -->
<div class="row">
<div class="col-12">
<div class="card">
<div class="card-header d-flex justify-content-between align-items-center">
<h5 class="mb-0">Log Content</h5>
<div class="form-check form-switch">
<input class="form-check-input" type="checkbox" id="autoRefresh" checked>
<label class="form-check-label" for="autoRefresh">
Auto-refresh
</label>
</div>
</div>
<div class="card-body p-0">
{% if content %}
<pre class="mb-0 p-3" style="background-color: #f8f9fa; max-height: 70vh; overflow-y: auto; font-family: 'Courier New', monospace; font-size: 0.85rem; line-height: 1.4;">{{ content }}</pre>
{% else %}
<div class="text-center p-5 text-muted">
<i class="fas fa-file-alt fa-3x mb-3"></i>
<p>Log file is empty or could not be read.</p>
</div>
{% endif %}
</div>
{% if content %}
<div class="card-footer text-muted">
<small>
<i class="fas fa-info-circle me-1"></i>
Log content is automatically refreshed every 5 seconds when auto-refresh is enabled.
Scroll to see older entries.
</small>
</div>
{% endif %}
</div>
</div>
</div>
</div>
<script>
let autoRefreshInterval;
function refreshLog() {
location.reload();
}
function setupAutoRefresh() {
const autoRefreshCheckbox = document.getElementById('autoRefresh');
if (autoRefreshCheckbox.checked) {
autoRefreshInterval = setInterval(refreshLog, 5000);
} else {
if (autoRefreshInterval) {
clearInterval(autoRefreshInterval);
}
}
}
document.addEventListener('DOMContentLoaded', function() {
const autoRefreshCheckbox = document.getElementById('autoRefresh');
// Set up auto-refresh initially
setupAutoRefresh();
// Handle checkbox changes
autoRefreshCheckbox.addEventListener('change', setupAutoRefresh);
});
// Clean up interval when page is unloaded
window.addEventListener('beforeunload', function() {
if (autoRefreshInterval) {
clearInterval(autoRefreshInterval);
}
});
</script>
{% endblock %}

114
templates/logs.html Normal file
View File

@@ -0,0 +1,114 @@
{% extends "base.html" %}
{% block title %}Logs - Backup Monitor{% endblock %}
{% block content %}
<div class="container mt-4">
<!-- Header -->
<div class="row mb-4">
<div class="col-12">
<h1 class="display-5">
<i class="fas fa-file-alt text-primary me-3"></i>
Backup Logs
</h1>
<p class="lead text-muted">View and monitor backup operation logs</p>
</div>
</div>
<!-- Filter -->
<div class="row mb-4">
<div class="col-12">
<div class="card">
<div class="card-body">
<form method="GET" class="d-flex align-items-center">
<label class="form-label me-2 mb-0">Filter by service:</label>
<select name="service" class="form-select me-2" style="width: auto;">
<option value="">All Services</option>
<option value="plex" {{ 'selected' if filter_service == 'plex' }}>Plex</option>
<option value="immich" {{ 'selected' if filter_service == 'immich' }}>Immich</option>
<option value="docker" {{ 'selected' if filter_service == 'docker' }}>Docker</option>
<option value="env-files" {{ 'selected' if filter_service == 'env-files' }}>Environment Files</option>
</select>
<button type="submit" class="btn btn-outline-primary">
<i class="fas fa-filter me-1"></i>Filter
</button>
</form>
</div>
</div>
</div>
</div>
<!-- Log Files -->
<div class="row">
<div class="col-12">
{% if logs %}
<div class="card">
<div class="card-header">
<h5 class="mb-0">Available Log Files</h5>
</div>
<div class="card-body p-0">
<div class="table-responsive">
<table class="table table-hover mb-0">
<thead class="table-light">
<tr>
<th>Service</th>
<th>Log File</th>
<th>Size</th>
<th>Modified</th>
<th>Actions</th>
</tr>
</thead>
<tbody>
{% for log in logs %}
<tr>
<td>
<span class="badge bg-primary">{{ log.service | title }}</span>
</td>
<td>
<code>{{ log.name }}</code>
</td>
<td>{{ log.size_formatted }}</td>
<td>{{ log.modified_time }}</td>
<td>
<div class="btn-group btn-group-sm">
<a href="{{ url_for('view_log', filename=log.name) }}"
class="btn btn-outline-primary">
<i class="fas fa-eye me-1"></i>View
</a>
</div>
<div class="mt-1">
<small class="text-muted">
<i class="fas fa-folder me-1"></i>
<code>{{ log.path }}</code>
</small>
</div>
</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
</div>
</div>
{% else %}
<div class="text-center py-5">
<i class="fas fa-file-alt fa-4x text-muted mb-3"></i>
<h3 class="text-muted">No log files found</h3>
<p class="text-muted">
{% if filter_service %}
No log files found for service: <strong>{{ filter_service }}</strong>
{% else %}
No backup log files are available at this time.
{% endif %}
</p>
{% if filter_service %}
<a href="{{ url_for('logs_view') }}" class="btn btn-outline-primary">
<i class="fas fa-times me-1"></i>Clear Filter
</a>
{% endif %}
</div>
{% endif %}
</div>
</div>
</div>
{% endblock %}

228
templates/service.html Normal file
View File

@@ -0,0 +1,228 @@
{% extends "base.html" %}
{% block title %}Service: {{ service.service | title }} - Backup Monitor{% endblock %}
{% block content %}
<div class="container mt-4">
<!-- Header -->
<div class="row mb-4">
<div class="col-12">
<nav aria-label="breadcrumb">
<ol class="breadcrumb">
<li class="breadcrumb-item"><a href="{{ url_for('index') }}">Dashboard</a></li>
<li class="breadcrumb-item active">{{ service.service | title }}</li>
</ol>
</nav>
<h1 class="display-5">
<i class="fas fa-{{ service.icon | default('database') }} text-primary me-3"></i>
{{ service.service | title }} Service
</h1>
<p class="lead text-muted">{{ service.description }}</p>
</div>
</div>
<!-- Service Status Card -->
<div class="row mb-4">
<div class="col-12">
<div class="card">
<div class="card-header d-flex justify-content-between align-items-center">
<h5 class="mb-0">Current Status</h5>
<span class="badge bg-{{ 'success' if service.status == 'success' else 'warning' if service.status == 'partial' else 'danger' if service.status == 'failed' else 'secondary' }} fs-6">
{{ service.status | title }}
</span>
</div>
<div class="card-body">
<div class="row">
<div class="col-md-6">
<h6>Backup Information</h6>
<table class="table table-sm">
<tr>
<td><strong>Service:</strong></td>
<td>{{ service.service }}</td>
</tr>
<tr>
<td><strong>Status:</strong></td>
<td>
<span class="badge bg-{{ 'success' if service.status == 'success' else 'warning' if service.status == 'partial' else 'danger' if service.status == 'failed' else 'secondary' }}">
{{ service.status | title }}
</span>
</td>
</tr>
<tr>
<td><strong>Current Operation:</strong></td>
<td>{{ service.current_operation | default('N/A') }}</td>
</tr>
<tr>
<td><strong>Backup Path:</strong></td>
<td><code>{{ service.backup_path | default('N/A') }}</code></td>
</tr>
{% if service.hostname %}
<tr>
<td><strong>Hostname:</strong></td>
<td>{{ service.hostname }}</td>
</tr>
{% endif %}
</table>
</div>
<div class="col-md-6">
<h6>Timing Information</h6>
<table class="table table-sm">
<tr>
<td><strong>Start Time:</strong></td>
<td>{{ service.start_time | default('N/A') }}</td>
</tr>
<tr>
<td><strong>End Time:</strong></td>
<td>{{ service.end_time | default('In Progress') }}</td>
</tr>
{% if service.duration_seconds %}
<tr>
<td><strong>Duration:</strong></td>
<td>{{ (service.duration_seconds / 60) | round(1) }} minutes</td>
</tr>
{% endif %}
<tr>
<td><strong>Last Updated:</strong></td>
<td>{{ service.last_updated | default('N/A') }}</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- Statistics -->
<div class="row mb-4">
<div class="col-md-4">
<div class="card text-center">
<div class="card-body">
<h2 class="text-primary">{{ service.files_processed | default(0) }}</h2>
<p class="text-muted mb-0">Files Processed</p>
</div>
</div>
</div>
<div class="col-md-4">
<div class="card text-center">
<div class="card-body">
<h2 class="text-info">
{% if service.total_size_bytes %}
{{ (service.total_size_bytes / 1024 / 1024 / 1024) | round(2) }}GB
{% else %}
0GB
{% endif %}
</h2>
<p class="text-muted mb-0">Total Size</p>
</div>
</div>
</div>
<div class="col-md-4">
<div class="card text-center">
<div class="card-body">
<h2 class="text-success">
{% if service.duration_seconds %}
{{ (service.duration_seconds / 60) | round(1) }}m
{% else %}
0m
{% endif %}
</h2>
<p class="text-muted mb-0">Duration</p>
</div>
</div>
</div>
</div>
<!-- Backup Files Information -->
{% if service.backup_path %}
<div class="row mb-4">
<div class="col-12">
<div class="card">
<div class="card-header">
<h5 class="mb-0">
<i class="fas fa-folder me-2"></i>Backup Location
</h5>
</div>
<div class="card-body">
<div class="row">
<div class="col-12">
<label class="form-label fw-bold">Backup Directory:</label>
<div class="p-2 bg-light rounded">
<code>{{ service.backup_path }}</code>
</div>
</div>
</div>
{% if service.latest_backup %}
<div class="row mt-3">
<div class="col-12">
<label class="form-label fw-bold">Latest Backup:</label>
<div class="p-2 bg-light rounded">
<code>{{ service.latest_backup }}</code>
</div>
</div>
</div>
{% endif %}
</div>
</div>
</div>
</div>
{% endif %}
<!-- Message/Error Information -->
{% if service.message %}
<div class="row mb-4">
<div class="col-12">
<div class="alert alert-{{ 'success' if service.status == 'success' else 'warning' if service.status == 'partial' else 'danger' if service.status == 'failed' else 'info' }}">
<h6 class="alert-heading">
{% if service.status == 'success' %}
<i class="fas fa-check-circle me-2"></i>Success
{% elif service.status == 'partial' %}
<i class="fas fa-exclamation-triangle me-2"></i>Warning
{% elif service.status == 'failed' %}
<i class="fas fa-times-circle me-2"></i>Error
{% else %}
<i class="fas fa-info-circle me-2"></i>Information
{% endif %}
</h6>
{{ service.message }}
</div>
</div>
</div>
{% endif %}
<!-- Actions -->
<div class="row">
<div class="col-12">
<div class="card">
<div class="card-header">
<h5 class="mb-0">Actions</h5>
</div>
<div class="card-body">
<div class="btn-group" role="group">
<button class="btn btn-primary" onclick="refreshService()">
<i class="fas fa-sync-alt me-1"></i>Refresh Status
</button>
<a href="{{ url_for('logs_view', service=service.service) }}" class="btn btn-outline-info">
<i class="fas fa-file-alt me-1"></i>View Logs
</a>
<a href="{{ url_for('index') }}" class="btn btn-outline-dark">
<i class="fas fa-arrow-left me-1"></i>Back to Dashboard
</a>
</div>
</div>
</div>
</div>
</div>
</div>
<script>
function refreshService() {
location.reload();
}
// Auto-refresh every 10 seconds for individual service view
setInterval(function() {
location.reload();
}, 10000);
</script>
{% endblock %}