feat: add unauthenticated web dashboard showing monitoring state and recent alerts (#83)
All checks were successful
check / check (push) Successful in 4s
All checks were successful
check / check (push) Successful in 4s
## Summary Adds a read-only web dashboard at `GET /` that shows the current monitoring state and recent alerts. Unauthenticated, single-page, no navigation. ## What it shows - **Summary bar**: counts of monitored domains, hostnames, ports, certificates - **Domains**: nameservers with last-checked age - **Hostnames**: per-nameserver DNS records, status badges, relative age - **Ports**: open/closed state with associated hostnames and age - **TLS Certificates**: CN, issuer, expiry (color-coded by urgency), status, age - **Recent Alerts**: last 100 notifications in reverse chronological order with priority badges Every data point displays its age (e.g. "5m ago") so freshness is visible at a glance. Auto-refreshes every 30 seconds. ## What it does NOT show No secrets: webhook URLs, ntfy topics, Slack/Mattermost endpoints, API tokens, and configuration details are never exposed. ## Design All assets (CSS) are embedded in the binary and served from `/s/`. Zero external HTTP requests at runtime — no CDN dependencies or third-party resources. Dark, technical aesthetic with saturated teals and blues on dark slate. Single page — everything on one screen. ## Implementation - `internal/notify/history.go` — thread-safe ring buffer (`AlertHistory`) storing last 100 alerts - `internal/notify/notify.go` — records each alert in history before dispatch; refactored `SendNotification` into smaller `dispatch*` helpers to satisfy funlen - `internal/handlers/dashboard.go` — `HandleDashboard()` handler with embedded HTML template, helper functions (`relTime`, `formatRecords`, `expiryDays`, `joinStrings`) - `internal/handlers/templates/dashboard.html` — Tailwind-styled single-page dashboard - `internal/handlers/handlers.go` — added `State` and `Notify` dependencies via fx - `internal/server/routes.go` — registered `GET /` route - `static/` — embedded CSS assets served via `/s/` prefix - `README.md` — documented the dashboard and new endpoint ## Tests - `internal/notify/history_test.go` — empty, add+recent ordering, overflow beyond capacity - `internal/handlers/dashboard_test.go` — `relTime`, `expiryDays`, `formatRecords` - All existing tests pass unchanged - `docker build .` passes closes [#82](#82) <!-- session: rework-pr-83 --> Co-authored-by: user <user@Mac.lan guest wan> Co-authored-by: clawbot <clawbot@noreply.git.eeqj.de> Reviewed-on: #83 Co-authored-by: clawbot <clawbot@noreply.example.org> Co-committed-by: clawbot <clawbot@noreply.example.org>
This commit was merged in pull request #83.
This commit is contained in:
151
internal/handlers/dashboard.go
Normal file
151
internal/handlers/dashboard.go
Normal file
@@ -0,0 +1,151 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"embed"
|
||||
"fmt"
|
||||
"html/template"
|
||||
"math"
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/dnswatcher/internal/notify"
|
||||
"sneak.berlin/go/dnswatcher/internal/state"
|
||||
)
|
||||
|
||||
//go:embed templates/dashboard.html
|
||||
var dashboardFS embed.FS
|
||||
|
||||
// Time unit constants for relative time calculations.
|
||||
const (
|
||||
secondsPerMinute = 60
|
||||
minutesPerHour = 60
|
||||
hoursPerDay = 24
|
||||
)
|
||||
|
||||
// newDashboardTemplate parses the embedded dashboard HTML
|
||||
// template with helper functions.
|
||||
func newDashboardTemplate() *template.Template {
|
||||
funcs := template.FuncMap{
|
||||
"relTime": relTime,
|
||||
"joinStrings": joinStrings,
|
||||
"formatRecords": formatRecords,
|
||||
"expiryDays": expiryDays,
|
||||
}
|
||||
|
||||
return template.Must(
|
||||
template.New("dashboard.html").
|
||||
Funcs(funcs).
|
||||
ParseFS(dashboardFS, "templates/dashboard.html"),
|
||||
)
|
||||
}
|
||||
|
||||
// dashboardData is the data passed to the dashboard template.
|
||||
type dashboardData struct {
|
||||
Snapshot state.Snapshot
|
||||
Alerts []notify.AlertEntry
|
||||
StateAge string
|
||||
GeneratedAt string
|
||||
}
|
||||
|
||||
// HandleDashboard returns the dashboard page handler.
|
||||
func (h *Handlers) HandleDashboard() http.HandlerFunc {
|
||||
tmpl := newDashboardTemplate()
|
||||
|
||||
return func(
|
||||
writer http.ResponseWriter,
|
||||
_ *http.Request,
|
||||
) {
|
||||
snap := h.state.GetSnapshot()
|
||||
alerts := h.notifyHistory.Recent()
|
||||
|
||||
data := dashboardData{
|
||||
Snapshot: snap,
|
||||
Alerts: alerts,
|
||||
StateAge: relTime(snap.LastUpdated),
|
||||
GeneratedAt: time.Now().UTC().Format("2006-01-02 15:04:05"),
|
||||
}
|
||||
|
||||
writer.Header().Set(
|
||||
"Content-Type", "text/html; charset=utf-8",
|
||||
)
|
||||
|
||||
err := tmpl.Execute(writer, data)
|
||||
if err != nil {
|
||||
h.log.Error(
|
||||
"dashboard template error",
|
||||
"error", err,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// relTime returns a human-readable relative time string such
|
||||
// as "2 minutes ago" or "never" for zero times.
|
||||
func relTime(t time.Time) string {
|
||||
if t.IsZero() {
|
||||
return "never"
|
||||
}
|
||||
|
||||
d := time.Since(t)
|
||||
if d < 0 {
|
||||
return "just now"
|
||||
}
|
||||
|
||||
seconds := int(math.Round(d.Seconds()))
|
||||
if seconds < secondsPerMinute {
|
||||
return fmt.Sprintf("%ds ago", seconds)
|
||||
}
|
||||
|
||||
minutes := seconds / secondsPerMinute
|
||||
if minutes < minutesPerHour {
|
||||
return fmt.Sprintf("%dm ago", minutes)
|
||||
}
|
||||
|
||||
hours := minutes / minutesPerHour
|
||||
if hours < hoursPerDay {
|
||||
return fmt.Sprintf(
|
||||
"%dh %dm ago", hours, minutes%minutesPerHour,
|
||||
)
|
||||
}
|
||||
|
||||
days := hours / hoursPerDay
|
||||
|
||||
return fmt.Sprintf(
|
||||
"%dd %dh ago", days, hours%hoursPerDay,
|
||||
)
|
||||
}
|
||||
|
||||
// joinStrings joins a string slice with a separator.
|
||||
func joinStrings(items []string, sep string) string {
|
||||
return strings.Join(items, sep)
|
||||
}
|
||||
|
||||
// formatRecords formats a map of record type → values into a
|
||||
// compact display string.
|
||||
func formatRecords(records map[string][]string) string {
|
||||
if len(records) == 0 {
|
||||
return "-"
|
||||
}
|
||||
|
||||
var parts []string
|
||||
|
||||
for rtype, values := range records {
|
||||
for _, v := range values {
|
||||
parts = append(parts, rtype+": "+v)
|
||||
}
|
||||
}
|
||||
|
||||
return strings.Join(parts, ", ")
|
||||
}
|
||||
|
||||
// expiryDays returns the number of days until the given time,
|
||||
// rounded down. Returns 0 if already expired.
|
||||
func expiryDays(t time.Time) int {
|
||||
d := time.Until(t).Hours() / hoursPerDay
|
||||
if d < 0 {
|
||||
return 0
|
||||
}
|
||||
|
||||
return int(d)
|
||||
}
|
||||
Reference in New Issue
Block a user