mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 20:01:31 +00:00
43836aca7c
Sprint 6 closure of the audit's HIGH-severity COMP-001-HASH finding.
Pre-fix posture: migration 000018 installs a WORM trigger on
audit_events that blocks UPDATE / DELETE for the application role.
But the trigger header itself documents a compliance-superuser
bypass (backup restore, retention purges, breach recovery). Without
a hash chain, that role can rewrite any row's actor / action /
details / timestamp / event_category with no on-disk trace.
HIPAA §164.312(b), FedRAMP AU-9, NIST 800-53 AU-10 want tamper-
EVIDENCE, not just tamper-prevention. This commit ships the
evidence layer.
Wire shape:
migrations/000047_audit_events_hash_chain.up.sql
+ pgcrypto extension (digest function)
+ audit_chain_head: single-row sentinel table holding the most
recent row_hash; FOR UPDATE row-lock serialises chain writes
under concurrent INSERTs so two parallel writers can't read
the same prev_hash and produce a forked chain
+ audit_events: prev_hash + row_hash columns
+ audit_events_canonical_payload(): centralised hash input
builder. UTC + microsecond ISO-8601 keeps the hash session-
timezone-independent. All columns separated by '|' so a
concatenation-ambiguity exploit can't fabricate a collision
+ audit_events_compute_hash_chain(): BEFORE-INSERT trigger
function. Reads sentinel FOR UPDATE → computes
sha256(prev_hash || id || actor || actor_type || action ||
resource_type || resource_id || details::text ||
timestamp_utc_iso || event_category) → writes both columns +
advances the sentinel
+ backfill loop walks every existing row in (timestamp ASC, id
ASC) order; WORM trigger temporarily DISABLEd inside this
migration's transaction so backfill UPDATEs land cleanly,
ENABLEd before COMMIT
+ audit_events_verify_chain(): STABLE plpgsql verifier. Walks
the chain end-to-end and returns the first break:
(first_break_id TEXT, first_break_pos INT, row_count INT)
internal/repository/postgres/audit.go
+ AuditRepository.VerifyHashChain — calls the SQL function and
maps the OUT parameters to Go return values
internal/repository/interfaces.go
+ AuditRepository.VerifyHashChain in the contract; every
in-memory mock + stub picks up the no-op implementation
internal/scheduler/scheduler.go
+ AuditChainVerifier + AuditChainBreakRecorder interfaces
+ auditChainVerifyInterval (default 6h)
+ auditChainVerifyLoop: runs once on start + every tick;
atomic.Bool guard + 5-min per-tick context timeout match every
other GC loop's pattern
internal/service/audit_chain_metric.go
+ AuditChainCounter type with atomic counters. Sticky-first-
detection on (BrokenAtID, BrokenAtPos) so the actionable
alarm doesn't drift across walks. Snapshot() returns the
full state for the metrics handler
internal/api/handler/metrics.go
+ AuditChainCounterSnapshotter interface + Prometheus
exposition for four series:
certctl_audit_chain_break_detected_total counter (the alarm)
certctl_audit_chain_verify_total counter (walks done)
certctl_audit_chain_rows gauge (last walk size)
certctl_audit_chain_last_verified_at gauge (unix seconds)
internal/config/config.go
+ AuditChainConfig{ VerifyInterval } + CERTCTL_AUDIT_CHAIN_VERIFY_INTERVAL
cmd/server/main.go
+ wires AuditChainCounter into both the scheduler (recorder) +
metrics handler (snapshotter) — single instance shared so the
writer + reader are guaranteed to converge
internal/repository/postgres/audit_chain_test.go (NEW)
+ TestAuditEventsHashChain_FreshTable: empty walk → clean
+ TestAuditEventsHashChain_AppendLinksRows: three INSERTs
produce a strictly-linked chain; prev_hash on row 0 is NULL;
verifier walks clean over the 3 rows
+ TestAuditEventsHashChain_VerifierDetectsTampering: simulate
the compliance-superuser threat model (DISABLE WORM, UPDATE
a middle row, ENABLE WORM); verifier returns the tampered
row's id at position 1
docs/operator/audit-chain.md (NEW)
+ Layered-defenses explainer (WORM + hash chain). Verifier
function reference. Recommended Prometheus alert rule.
Performance scaling table (10k to 10M rows). Step-by-step
runbook for what to do when a break is detected. Operator
configuration table.
Test-stub additions for AuditRepository.VerifyHashChain:
internal/service/testutil_test.go — mockAuditRepo
internal/service/acme_test.go — fakeAuditRepo
internal/integration/lifecycle_test.go — mockAuditRepository
internal/api/handler/scep_intune_e2e_test.go — intuneE2EAuditRepo
Verified locally:
go vet ./... (clean)
gofmt -l internal/ cmd/ (clean)
go test -short -count=1 ./internal/scheduler/... ./internal/config/...
./internal/service/... ./internal/api/handler/... ./internal/repository/...
(all green)
Verified with testcontainers + postgres:16-alpine + the migration
runner (not gated under -short — requires docker):
go test -count=1 -run TestAuditEventsHashChain ./internal/repository/postgres/...
Closes COMP-001-HASH leg of Sprint 6. COMP-002-RETENTION lands in
the next commit (separate concern: federated-user PII retention).
606 lines
28 KiB
Go
606 lines
28 KiB
Go
// Copyright 2026 certctl LLC. All rights reserved.
|
||
// SPDX-License-Identifier: BUSL-1.1
|
||
|
||
package handler
|
||
|
||
import (
|
||
"context"
|
||
"encoding/json"
|
||
"fmt"
|
||
"net/http"
|
||
"sort"
|
||
"strconv"
|
||
"time"
|
||
|
||
"github.com/certctl-io/certctl/internal/api/middleware"
|
||
"github.com/certctl-io/certctl/internal/service"
|
||
)
|
||
|
||
// MetricsService defines the service interface for metrics collection.
|
||
type MetricsService interface {
|
||
GetDashboardSummary(ctx context.Context) (interface{}, error)
|
||
}
|
||
|
||
// CounterSnapshotter is the minimum surface MetricsHandler consumes
|
||
// from a counter table for the Prometheus exposer. The OCSPCounters
|
||
// type in internal/service satisfies this; future per-area counter
|
||
// tabs (CRL, cert-export, EST, SCEP, Intune) plug in the same way.
|
||
//
|
||
// Production hardening II Phase 8.
|
||
type CounterSnapshotter interface {
|
||
Snapshot() map[string]uint64
|
||
}
|
||
|
||
// DeploySnapshotEntry is the per-target-type tuple emitted by the
|
||
// deploy package's counter table. Avoids importing the service
|
||
// package's DeploySnapshot directly so the handler stays
|
||
// dependency-light (the interface uses primitives only).
|
||
//
|
||
// Phase 10 of the deploy-hardening I master bundle.
|
||
type DeploySnapshotEntry struct {
|
||
TargetType string
|
||
AttemptsSuccess uint64
|
||
AttemptsFailure uint64
|
||
ValidateFailures uint64
|
||
ReloadFailures uint64
|
||
PostVerifyFails uint64
|
||
RollbackRestored uint64
|
||
RollbackAlsoFail uint64
|
||
IdempotentSkips uint64
|
||
}
|
||
|
||
// DeployCounterSnapshotter is the surface MetricsHandler consumes
|
||
// for the per-target-type deploy counters. The DeployCounters type
|
||
// in internal/service satisfies this via an adapter.
|
||
type DeployCounterSnapshotter interface {
|
||
Snapshot() []DeploySnapshotEntry
|
||
}
|
||
|
||
// IssuanceCounterEntry / IssuanceFailureEntry / IssuanceDurationEntry
|
||
// and the IssuanceMetricsSnapshotter interface live in
|
||
// internal/service (issuance_metrics.go). Handler can't define them
|
||
// locally because internal/api/handler is imported by service — the
|
||
// reverse import would create a cycle. The exposer below takes the
|
||
// types via the interface defined in service.
|
||
|
||
// VaultRenewalSnapshotter is the surface MetricsHandler consumes
|
||
// to emit the certctl_vault_token_renewals_total{result=...}
|
||
// counter. *service.VaultRenewalMetrics satisfies this; cmd/server
|
||
// passes the same instance into IssuerRegistry.SetVaultRenewalMetrics
|
||
// (so Vault connectors record results) AND into
|
||
// MetricsHandler.SetVaultRenewals (so the Prometheus exposer reads
|
||
// the counters).
|
||
//
|
||
// Returns three counter values directly (rather than a shared struct
|
||
// type) so service can satisfy this without an import cycle —
|
||
// handler already imports service for IssuanceMetricsSnapshotter,
|
||
// but service does not import handler. A method that returns
|
||
// (uint64, uint64, uint64) needs no shared type.
|
||
//
|
||
// Top-10 fix #5 of the 2026-05-03 issuer-coverage audit.
|
||
type VaultRenewalSnapshotter interface {
|
||
// SnapshotVaultRenewals returns success, failure, and
|
||
// not_renewable counters as point-in-time reads. Order is fixed
|
||
// for the exposer — matches the Prometheus label order.
|
||
SnapshotVaultRenewals() (success, failure, notRenewable uint64)
|
||
}
|
||
|
||
// ExpiryAlertSnapshotter is the surface MetricsHandler consumes to
|
||
// emit certctl_expiry_alerts_total{channel, threshold, result}.
|
||
// *service.ExpiryAlertMetrics satisfies this. Same wiring shape as
|
||
// VaultRenewalSnapshotter — one instance shared between recording
|
||
// (via NotificationService.SetExpiryAlertMetrics) and exposing
|
||
// (here).
|
||
//
|
||
// Rank 4 of the 2026-05-03 Infisical deep-research deliverable
|
||
// (the project's deep-research deliverable, Part 5).
|
||
type ExpiryAlertSnapshotter interface {
|
||
// SnapshotExpiryAlerts returns one entry per non-zero counter,
|
||
// pre-sorted by (channel, threshold, result) so the Prometheus
|
||
// exposition is byte-stable across requests. The handler does
|
||
// not re-sort.
|
||
SnapshotExpiryAlerts() []service.ExpiryAlertSnapshotEntry
|
||
}
|
||
|
||
// AuditChainCounterSnapshotter is the surface MetricsHandler consumes
|
||
// to emit the Sprint 6 COMP-001-HASH tamper-evidence counters:
|
||
//
|
||
// certctl_audit_chain_break_detected_total counter
|
||
// certctl_audit_chain_verify_total counter
|
||
// certctl_audit_chain_rows gauge
|
||
// certctl_audit_chain_last_verified_at gauge (unix seconds)
|
||
//
|
||
// *service.AuditChainCounter satisfies this. nil disables emission;
|
||
// cmd/server/main.go wires the instance at startup.
|
||
type AuditChainCounterSnapshotter interface {
|
||
Snapshot() service.AuditChainSnapshot
|
||
}
|
||
|
||
// MetricsHandler handles HTTP requests for metrics.
|
||
// Supports both JSON format (GET /api/v1/metrics) and Prometheus exposition format
|
||
// (GET /api/v1/metrics/prometheus) for integration with Prometheus, Grafana, Datadog, etc.
|
||
type MetricsHandler struct {
|
||
svc MetricsService
|
||
serverStarted time.Time
|
||
// Production hardening II Phase 8 — per-area counter snapshotters.
|
||
// nil values omit the corresponding metric block; cmd/server/main.go
|
||
// wires the instances at startup. The naming convention is
|
||
// certctl_<area>_<label>_total per frozen decision 0.10.
|
||
ocspCounters CounterSnapshotter
|
||
// Phase 10 (deploy-hardening I) — per-target-type deploy counters.
|
||
deployCounters DeployCounterSnapshotter
|
||
// Per-issuer-type issuance metrics (audit fix #4). nil disables
|
||
// the new metric block; main.go wires the instance at startup.
|
||
// The interface lives in service to avoid an import cycle (handler
|
||
// imports service for admin_est.go etc., so service can't import
|
||
// handler back).
|
||
issuanceCounters service.IssuanceMetricsSnapshotter
|
||
// Vault PKI token-renewal counters. Top-10 fix #5 of the
|
||
// 2026-05-03 issuer-coverage audit. nil disables emission of
|
||
// certctl_vault_token_renewals_total{result=...}.
|
||
vaultRenewals VaultRenewalSnapshotter
|
||
// Per-policy multi-channel expiry alert counters. Rank 4 of the
|
||
// 2026-05-03 Infisical deep-research deliverable. nil disables
|
||
// emission of certctl_expiry_alerts_total{channel,threshold,result}.
|
||
expiryAlerts ExpiryAlertSnapshotter
|
||
// Sprint 6 COMP-001-HASH tamper-evidence counters. nil disables
|
||
// emission of certctl_audit_chain_* metrics. *service.AuditChainCounter
|
||
// is the production wiring; cmd/server/main.go sets this at startup.
|
||
auditChainCounter AuditChainCounterSnapshotter
|
||
}
|
||
|
||
// NewMetricsHandler creates a new MetricsHandler with a service dependency.
|
||
// serverStarted is used to calculate uptime_seconds.
|
||
func NewMetricsHandler(svc MetricsService, serverStarted time.Time) MetricsHandler {
|
||
return MetricsHandler{
|
||
svc: svc,
|
||
serverStarted: serverStarted,
|
||
}
|
||
}
|
||
|
||
// SetOCSPCounters wires the OCSP counter table for the per-area
|
||
// metric block in the Prometheus exposition. nil disables the block.
|
||
// Production hardening II Phase 8.
|
||
func (h *MetricsHandler) SetOCSPCounters(c CounterSnapshotter) {
|
||
h.ocspCounters = c
|
||
}
|
||
|
||
// SetDeployCounters wires the per-target-type deploy counter table
|
||
// for the Prometheus exposition. nil disables the block. Phase 10
|
||
// of the deploy-hardening I master bundle.
|
||
func (h *MetricsHandler) SetDeployCounters(c DeployCounterSnapshotter) {
|
||
h.deployCounters = c
|
||
}
|
||
|
||
// SetIssuanceCounters wires the per-issuer-type issuance metrics for
|
||
// the Prometheus exposition. nil disables the block. Closes the #4
|
||
// acquisition-readiness blocker from the 2026-05-01 issuer coverage
|
||
// audit (per-issuer-type metrics).
|
||
func (h *MetricsHandler) SetIssuanceCounters(c service.IssuanceMetricsSnapshotter) {
|
||
h.issuanceCounters = c
|
||
}
|
||
|
||
// SetVaultRenewals wires the Vault PKI token-renewal counter table
|
||
// for the Prometheus exposition. nil disables the block. Closes
|
||
// Top-10 fix #5 of the 2026-05-03 issuer-coverage audit.
|
||
func (h *MetricsHandler) SetVaultRenewals(c VaultRenewalSnapshotter) {
|
||
h.vaultRenewals = c
|
||
}
|
||
|
||
// SetExpiryAlerts wires the per-policy multi-channel expiry-alert
|
||
// counter table for the Prometheus exposition. nil disables the
|
||
// block. Closes Rank 4 of the 2026-05-03 Infisical deep-research
|
||
// deliverable.
|
||
func (h *MetricsHandler) SetExpiryAlerts(c ExpiryAlertSnapshotter) {
|
||
h.expiryAlerts = c
|
||
}
|
||
|
||
// SetAuditChainCounter wires the Sprint 6 COMP-001-HASH tamper-evidence
|
||
// counters for the Prometheus exposition. nil disables the block.
|
||
// The counter is also passed to scheduler.SetAuditChainBreakRecorder so
|
||
// the verify loop writes to the same instance the handler reads.
|
||
func (h *MetricsHandler) SetAuditChainCounter(c AuditChainCounterSnapshotter) {
|
||
h.auditChainCounter = c
|
||
}
|
||
|
||
// MetricsResponse represents the JSON metrics response for V2.
|
||
type MetricsResponse struct {
|
||
Gauge MetricsGauge `json:"gauge"`
|
||
Counter MetricsCounter `json:"counter"`
|
||
Uptime UptimeMetric `json:"uptime"`
|
||
}
|
||
|
||
// MetricsGauge represents gauge metrics (point-in-time values).
|
||
type MetricsGauge struct {
|
||
CertificateTotal int64 `json:"certificate_total"`
|
||
CertificateActive int64 `json:"certificate_active"`
|
||
CertificateExpiringSoon int64 `json:"certificate_expiring_soon"` // Within 30d
|
||
CertificateExpired int64 `json:"certificate_expired"`
|
||
CertificateRevoked int64 `json:"certificate_revoked"`
|
||
AgentTotal int64 `json:"agent_total"`
|
||
AgentOnline int64 `json:"agent_online"`
|
||
JobPending int64 `json:"job_pending"`
|
||
}
|
||
|
||
// MetricsCounter represents counter metrics (cumulative values).
|
||
type MetricsCounter struct {
|
||
JobCompletedTotal int64 `json:"job_completed_total"`
|
||
JobFailedTotal int64 `json:"job_failed_total"`
|
||
// NotificationsDeadTotal is a point-in-time count of notifications in the
|
||
// dead-letter queue (status="dead"), exposed here with the _total suffix
|
||
// to match Prometheus DB-snapshot counter convention (same semantics as
|
||
// JobFailedTotal and JobCompletedTotal — see metrics.md). I-005 DLQ
|
||
// observability gate.
|
||
NotificationsDeadTotal int64 `json:"notifications_dead_total"`
|
||
}
|
||
|
||
// UptimeMetric represents server uptime information.
|
||
type UptimeMetric struct {
|
||
UptimeSeconds int64 `json:"uptime_seconds"`
|
||
ServerStarted time.Time `json:"server_started"`
|
||
MeasuredAt time.Time `json:"measured_at"`
|
||
}
|
||
|
||
// GetMetrics returns JSON metrics (aggregated from dashboard summary).
|
||
// GET /api/v1/metrics
|
||
func (h MetricsHandler) GetMetrics(w http.ResponseWriter, r *http.Request) {
|
||
if r.Method != http.MethodGet {
|
||
Error(w, http.StatusMethodNotAllowed, "Method not allowed")
|
||
return
|
||
}
|
||
|
||
requestID := middleware.GetRequestID(r.Context())
|
||
|
||
summary, err := h.svc.GetDashboardSummary(r.Context())
|
||
if err != nil {
|
||
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to collect metrics", requestID)
|
||
return
|
||
}
|
||
|
||
// Extract fields from summary via JSON round-trip (avoids cross-package type assertion)
|
||
jsonBytes, err := json.Marshal(summary)
|
||
if err != nil {
|
||
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to marshal metrics data", requestID)
|
||
return
|
||
}
|
||
var dashboardSummary DashboardSummary
|
||
if err := json.Unmarshal(jsonBytes, &dashboardSummary); err != nil {
|
||
ErrorWithRequestID(w, http.StatusInternalServerError, "Invalid metrics data", requestID)
|
||
return
|
||
}
|
||
|
||
// Build metrics response
|
||
metricsResp := MetricsResponse{
|
||
Gauge: MetricsGauge{
|
||
CertificateTotal: dashboardSummary.TotalCertificates,
|
||
CertificateActive: dashboardSummary.TotalCertificates - dashboardSummary.ExpiringCertificates - dashboardSummary.ExpiredCertificates - dashboardSummary.RevokedCertificates,
|
||
CertificateExpiringSoon: dashboardSummary.ExpiringCertificates,
|
||
CertificateExpired: dashboardSummary.ExpiredCertificates,
|
||
CertificateRevoked: dashboardSummary.RevokedCertificates,
|
||
AgentTotal: dashboardSummary.TotalAgents,
|
||
AgentOnline: dashboardSummary.ActiveAgents,
|
||
JobPending: dashboardSummary.PendingJobs,
|
||
},
|
||
Counter: MetricsCounter{
|
||
JobCompletedTotal: dashboardSummary.CompleteJobs,
|
||
JobFailedTotal: dashboardSummary.FailedJobs,
|
||
NotificationsDeadTotal: dashboardSummary.NotificationsDead,
|
||
},
|
||
Uptime: UptimeMetric{
|
||
UptimeSeconds: int64(time.Since(h.serverStarted).Seconds()),
|
||
ServerStarted: h.serverStarted,
|
||
MeasuredAt: time.Now(),
|
||
},
|
||
}
|
||
|
||
JSON(w, http.StatusOK, metricsResp)
|
||
}
|
||
|
||
// GetPrometheusMetrics returns metrics in Prometheus exposition format (text/plain).
|
||
// GET /api/v1/metrics/prometheus
|
||
// Compatible with Prometheus, Grafana Agent, Datadog Agent, Victoria Metrics, and any
|
||
// OpenMetrics-compatible scraper. Metric names follow Prometheus naming conventions
|
||
// (lowercase, snake_case, prefixed with certctl_).
|
||
func (h MetricsHandler) GetPrometheusMetrics(w http.ResponseWriter, r *http.Request) {
|
||
if r.Method != http.MethodGet {
|
||
Error(w, http.StatusMethodNotAllowed, "Method not allowed")
|
||
return
|
||
}
|
||
|
||
requestID := middleware.GetRequestID(r.Context())
|
||
|
||
summary, err := h.svc.GetDashboardSummary(r.Context())
|
||
if err != nil {
|
||
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to collect metrics", requestID)
|
||
return
|
||
}
|
||
|
||
// Extract fields from summary via JSON round-trip (avoids cross-package type assertion)
|
||
jsonBytes, err := json.Marshal(summary)
|
||
if err != nil {
|
||
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to marshal metrics data", requestID)
|
||
return
|
||
}
|
||
var dashboardSummary DashboardSummary
|
||
if err := json.Unmarshal(jsonBytes, &dashboardSummary); err != nil {
|
||
ErrorWithRequestID(w, http.StatusInternalServerError, "Invalid metrics data", requestID)
|
||
return
|
||
}
|
||
|
||
// Compute derived values
|
||
active := dashboardSummary.TotalCertificates - dashboardSummary.ExpiringCertificates - dashboardSummary.ExpiredCertificates - dashboardSummary.RevokedCertificates
|
||
uptimeSeconds := int64(time.Since(h.serverStarted).Seconds())
|
||
|
||
// Build Prometheus exposition format
|
||
// See: https://prometheus.io/docs/instrumenting/exposition_formats/
|
||
w.Header().Set("Content-Type", "text/plain; version=0.0.4; charset=utf-8")
|
||
w.WriteHeader(http.StatusOK)
|
||
|
||
// Gauges — point-in-time values
|
||
fmt.Fprintf(w, "# HELP certctl_certificate_total Total number of managed certificates.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_certificate_total gauge\n")
|
||
fmt.Fprintf(w, "certctl_certificate_total %d\n\n", dashboardSummary.TotalCertificates)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_certificate_active Number of active (non-expiring, non-expired, non-revoked) certificates.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_certificate_active gauge\n")
|
||
fmt.Fprintf(w, "certctl_certificate_active %d\n\n", active)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_certificate_expiring_soon Number of certificates expiring within 30 days.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_certificate_expiring_soon gauge\n")
|
||
fmt.Fprintf(w, "certctl_certificate_expiring_soon %d\n\n", dashboardSummary.ExpiringCertificates)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_certificate_expired Number of expired certificates.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_certificate_expired gauge\n")
|
||
fmt.Fprintf(w, "certctl_certificate_expired %d\n\n", dashboardSummary.ExpiredCertificates)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_certificate_revoked Number of revoked certificates.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_certificate_revoked gauge\n")
|
||
fmt.Fprintf(w, "certctl_certificate_revoked %d\n\n", dashboardSummary.RevokedCertificates)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_agent_total Total number of registered agents.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_agent_total gauge\n")
|
||
fmt.Fprintf(w, "certctl_agent_total %d\n\n", dashboardSummary.TotalAgents)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_agent_online Number of agents currently online.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_agent_online gauge\n")
|
||
fmt.Fprintf(w, "certctl_agent_online %d\n\n", dashboardSummary.ActiveAgents)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_job_pending Number of jobs currently pending.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_job_pending gauge\n")
|
||
fmt.Fprintf(w, "certctl_job_pending %d\n\n", dashboardSummary.PendingJobs)
|
||
|
||
// Counters — cumulative values
|
||
fmt.Fprintf(w, "# HELP certctl_job_completed_total Total number of completed jobs.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_job_completed_total counter\n")
|
||
fmt.Fprintf(w, "certctl_job_completed_total %d\n\n", dashboardSummary.CompleteJobs)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_job_failed_total Total number of failed jobs.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_job_failed_total counter\n")
|
||
fmt.Fprintf(w, "certctl_job_failed_total %d\n\n", dashboardSummary.FailedJobs)
|
||
|
||
// I-005: notification dead-letter queue depth. Emitted with the _total
|
||
// suffix to match the existing certctl_job_completed_total /
|
||
// certctl_job_failed_total convention for DB-snapshot counters — the
|
||
// value is a point-in-time COUNT(*) of notification_events rows where
|
||
// status='dead', not a monotonically increasing process-lifetime counter.
|
||
// Operators alert on this as "dead-letter depth" (thresholds in the
|
||
// I-005 spec: > 0 → warning, > 10 → critical).
|
||
fmt.Fprintf(w, "# HELP certctl_notification_dead_total Number of notifications in the dead-letter queue.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_notification_dead_total counter\n")
|
||
fmt.Fprintf(w, "certctl_notification_dead_total %d\n\n", dashboardSummary.NotificationsDead)
|
||
|
||
// Info — server uptime
|
||
fmt.Fprintf(w, "# HELP certctl_uptime_seconds Server uptime in seconds.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_uptime_seconds gauge\n")
|
||
fmt.Fprintf(w, "certctl_uptime_seconds %d\n", uptimeSeconds)
|
||
|
||
// Production hardening II Phase 8 — per-area counters. Each block
|
||
// is nil-guarded so a deploy without the wire still produces clean
|
||
// output (just the legacy dashboard metrics above). Naming
|
||
// convention: certctl_<area>_<label>_total per frozen decision
|
||
// 0.10.
|
||
if h.ocspCounters != nil {
|
||
fmt.Fprintf(w, "\n# HELP certctl_ocsp_counter_total OCSP responder per-event counters (production hardening II Phase 8).\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_ocsp_counter_total counter\n")
|
||
snap := h.ocspCounters.Snapshot()
|
||
// Emit in a deterministic order so the output diff is stable
|
||
// across requests (helps operators spot drift in dashboard
|
||
// snapshots).
|
||
labels := []string{
|
||
"request_get", "request_post", "request_success", "request_invalid",
|
||
"issuer_not_found", "cert_not_found", "signing_failed",
|
||
"nonce_echoed", "nonce_malformed", "rate_limited",
|
||
}
|
||
for _, lbl := range labels {
|
||
fmt.Fprintf(w, "certctl_ocsp_counter_total{label=%q} %d\n", lbl, snap[lbl])
|
||
}
|
||
}
|
||
|
||
// Phase 10 (deploy-hardening I) — per-target-type deploy
|
||
// counters. The exposer enumerates the (target_type, sub-label)
|
||
// tuples to defend against drift; adding a new sub-counter to
|
||
// DeployCounters without also adding it here would surface as
|
||
// silent missing-metric in operator dashboards.
|
||
if h.deployCounters != nil {
|
||
fmt.Fprintf(w, "\n# HELP certctl_deploy_attempts_total Per-target-type deploy attempts (deploy-hardening I Phase 10).\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_deploy_attempts_total counter\n")
|
||
snap := h.deployCounters.Snapshot()
|
||
// Sort by target_type for stable output.
|
||
sort.Slice(snap, func(i, j int) bool { return snap[i].TargetType < snap[j].TargetType })
|
||
for _, s := range snap {
|
||
fmt.Fprintf(w, "certctl_deploy_attempts_total{target_type=%q,result=%q} %d\n", s.TargetType, "success", s.AttemptsSuccess)
|
||
fmt.Fprintf(w, "certctl_deploy_attempts_total{target_type=%q,result=%q} %d\n", s.TargetType, "failure", s.AttemptsFailure)
|
||
}
|
||
fmt.Fprintf(w, "\n# HELP certctl_deploy_validate_failures_total Per-target-type validate-step failures.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_deploy_validate_failures_total counter\n")
|
||
for _, s := range snap {
|
||
fmt.Fprintf(w, "certctl_deploy_validate_failures_total{target_type=%q} %d\n", s.TargetType, s.ValidateFailures)
|
||
}
|
||
fmt.Fprintf(w, "\n# HELP certctl_deploy_reload_failures_total Per-target-type reload-step failures (rollback was attempted).\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_deploy_reload_failures_total counter\n")
|
||
for _, s := range snap {
|
||
fmt.Fprintf(w, "certctl_deploy_reload_failures_total{target_type=%q} %d\n", s.TargetType, s.ReloadFailures)
|
||
}
|
||
fmt.Fprintf(w, "\n# HELP certctl_deploy_post_verify_failures_total Per-target-type post-deploy TLS verify failures.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_deploy_post_verify_failures_total counter\n")
|
||
for _, s := range snap {
|
||
fmt.Fprintf(w, "certctl_deploy_post_verify_failures_total{target_type=%q} %d\n", s.TargetType, s.PostVerifyFails)
|
||
}
|
||
fmt.Fprintf(w, "\n# HELP certctl_deploy_rollback_total Per-target-type rollbacks.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_deploy_rollback_total counter\n")
|
||
for _, s := range snap {
|
||
fmt.Fprintf(w, "certctl_deploy_rollback_total{target_type=%q,outcome=%q} %d\n", s.TargetType, "restored", s.RollbackRestored)
|
||
fmt.Fprintf(w, "certctl_deploy_rollback_total{target_type=%q,outcome=%q} %d\n", s.TargetType, "also_failed", s.RollbackAlsoFail)
|
||
}
|
||
fmt.Fprintf(w, "\n# HELP certctl_deploy_idempotent_skip_total Per-target-type SHA-256 idempotent skips (defends against retry storms).\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_deploy_idempotent_skip_total counter\n")
|
||
for _, s := range snap {
|
||
fmt.Fprintf(w, "certctl_deploy_idempotent_skip_total{target_type=%q} %d\n", s.TargetType, s.IdempotentSkips)
|
||
}
|
||
}
|
||
|
||
// Per-issuer-type issuance metrics (audit fix #4). Three series:
|
||
// certctl_issuance_total{issuer_type, outcome} counter
|
||
// certctl_issuance_duration_seconds{issuer_type} histogram
|
||
// certctl_issuance_failures_total{issuer_type, error_class} counter
|
||
//
|
||
// Cardinality: 12 issuer_types × 2 outcomes (24) +
|
||
// 12 × 11 buckets+sum+count (~156) +
|
||
// 12 × 8 error_classes (96) = ~276 series. Comfortable
|
||
// for any Prometheus instance.
|
||
if h.issuanceCounters != nil {
|
||
// certctl_issuance_total
|
||
fmt.Fprintf(w, "\n# HELP certctl_issuance_total Total certificate issuance attempts, labelled by issuer type and outcome.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_issuance_total counter\n")
|
||
counters := h.issuanceCounters.SnapshotCounters()
|
||
sort.Slice(counters, func(i, j int) bool {
|
||
if counters[i].IssuerType != counters[j].IssuerType {
|
||
return counters[i].IssuerType < counters[j].IssuerType
|
||
}
|
||
return counters[i].Outcome < counters[j].Outcome
|
||
})
|
||
for _, c := range counters {
|
||
fmt.Fprintf(w, "certctl_issuance_total{issuer_type=%q,outcome=%q} %d\n", c.IssuerType, c.Outcome, c.Count)
|
||
}
|
||
|
||
// certctl_issuance_duration_seconds histogram
|
||
fmt.Fprintf(w, "\n# HELP certctl_issuance_duration_seconds Certificate issuance duration in seconds, labelled by issuer type. Cumulative histogram with +Inf.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_issuance_duration_seconds histogram\n")
|
||
durations := h.issuanceCounters.SnapshotDurations()
|
||
boundaries := h.issuanceCounters.BucketBoundaries()
|
||
sort.Slice(durations, func(i, j int) bool { return durations[i].IssuerType < durations[j].IssuerType })
|
||
for _, d := range durations {
|
||
for i, le := range boundaries {
|
||
if i < len(d.Buckets) {
|
||
fmt.Fprintf(w, "certctl_issuance_duration_seconds_bucket{issuer_type=%q,le=%q} %d\n",
|
||
d.IssuerType, formatLE(le), d.Buckets[i])
|
||
}
|
||
}
|
||
fmt.Fprintf(w, "certctl_issuance_duration_seconds_bucket{issuer_type=%q,le=\"+Inf\"} %d\n", d.IssuerType, d.Count)
|
||
fmt.Fprintf(w, "certctl_issuance_duration_seconds_sum{issuer_type=%q} %g\n", d.IssuerType, d.Sum)
|
||
fmt.Fprintf(w, "certctl_issuance_duration_seconds_count{issuer_type=%q} %d\n", d.IssuerType, d.Count)
|
||
}
|
||
|
||
// certctl_issuance_failures_total
|
||
fmt.Fprintf(w, "\n# HELP certctl_issuance_failures_total Issuance failures by issuer type and error class. error_class is a closed enum (timeout, auth, rate_limited, validation, upstream_5xx, upstream_4xx, network, other).\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_issuance_failures_total counter\n")
|
||
failures := h.issuanceCounters.SnapshotFailures()
|
||
sort.Slice(failures, func(i, j int) bool {
|
||
if failures[i].IssuerType != failures[j].IssuerType {
|
||
return failures[i].IssuerType < failures[j].IssuerType
|
||
}
|
||
return failures[i].ErrorClass < failures[j].ErrorClass
|
||
})
|
||
for _, f := range failures {
|
||
fmt.Fprintf(w, "certctl_issuance_failures_total{issuer_type=%q,error_class=%q} %d\n", f.IssuerType, f.ErrorClass, f.Count)
|
||
}
|
||
}
|
||
|
||
// Vault PKI token-renewal counters. Top-10 fix #5 of the
|
||
// 2026-05-03 issuer-coverage audit. Operators alert on
|
||
// certctl_vault_token_renewals_total{result="failure"} > 0 or
|
||
// {result="not_renewable"} > 0 to catch token expiry before
|
||
// issuance breaks. Closed enum: 3 series.
|
||
if h.vaultRenewals != nil {
|
||
success, failure, notRenewable := h.vaultRenewals.SnapshotVaultRenewals()
|
||
fmt.Fprintf(w, "\n# HELP certctl_vault_token_renewals_total Vault PKI token renew-self results. result is a closed enum: success, failure, not_renewable.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_vault_token_renewals_total counter\n")
|
||
fmt.Fprintf(w, "certctl_vault_token_renewals_total{result=%q} %d\n", "success", success)
|
||
fmt.Fprintf(w, "certctl_vault_token_renewals_total{result=%q} %d\n", "failure", failure)
|
||
fmt.Fprintf(w, "certctl_vault_token_renewals_total{result=%q} %d\n", "not_renewable", notRenewable)
|
||
}
|
||
|
||
// Per-policy multi-channel expiry-alert counters. Rank 4 of the
|
||
// 2026-05-03 Infisical deep-research deliverable. Operators alert
|
||
// on certctl_expiry_alerts_total{result="failure"} > 0 to catch
|
||
// when a notifier connector (PagerDuty / Slack / etc.) is
|
||
// rejecting our sends. Cardinality: 6 channels × N thresholds × 3
|
||
// results — production deploys with the standard 4 thresholds top
|
||
// out at 72 series. Snapshot is pre-sorted by the recorder so the
|
||
// emission order is byte-stable across requests.
|
||
if h.expiryAlerts != nil {
|
||
entries := h.expiryAlerts.SnapshotExpiryAlerts()
|
||
if len(entries) > 0 {
|
||
fmt.Fprintf(w, "\n# HELP certctl_expiry_alerts_total Certificate-expiry alerts dispatched per (channel, threshold, result). result is a closed enum: success, failure, deduped.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_expiry_alerts_total counter\n")
|
||
for _, e := range entries {
|
||
fmt.Fprintf(w, "certctl_expiry_alerts_total{channel=%q,threshold=%q,result=%q} %d\n",
|
||
e.Channel, strconv.Itoa(e.Threshold), e.Result, e.Count)
|
||
}
|
||
}
|
||
}
|
||
|
||
// Sprint 6 COMP-001-HASH tamper-evidence counters. Emitted as four
|
||
// adjacent series so an alert rule can fire on any non-zero
|
||
// certctl_audit_chain_break_detected_total (the operator-actionable
|
||
// signal — see docs/operator/audit-chain.md).
|
||
if h.auditChainCounter != nil {
|
||
snap := h.auditChainCounter.Snapshot()
|
||
fmt.Fprintf(w, "\n# HELP certctl_audit_chain_break_detected_total Number of audit_events hash-chain breaks detected (Sprint 6 COMP-001-HASH).\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_audit_chain_break_detected_total counter\n")
|
||
fmt.Fprintf(w, "certctl_audit_chain_break_detected_total %d\n", snap.BreaksDetected)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_audit_chain_verify_total Number of audit_events_verify_chain() walks completed by the scheduler.\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_audit_chain_verify_total counter\n")
|
||
fmt.Fprintf(w, "certctl_audit_chain_verify_total %d\n", snap.WalksCompleted)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_audit_chain_rows Most recent walk's row count (gauge — last-write-wins).\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_audit_chain_rows gauge\n")
|
||
fmt.Fprintf(w, "certctl_audit_chain_rows %d\n", snap.LastRowCount)
|
||
|
||
fmt.Fprintf(w, "# HELP certctl_audit_chain_last_verified_at Unix seconds of most recent walk (0 = never).\n")
|
||
fmt.Fprintf(w, "# TYPE certctl_audit_chain_last_verified_at gauge\n")
|
||
fmt.Fprintf(w, "certctl_audit_chain_last_verified_at %d\n", snap.LastVerifiedAtUnix)
|
||
}
|
||
}
|
||
|
||
// formatLE formats a histogram bucket boundary the way Prometheus
|
||
// expects: no trailing zeros, no scientific notation for typical
|
||
// sub-second / sub-minute values. Used for the `le` label in the
|
||
// issuance-duration histogram exposer.
|
||
func formatLE(v float64) string {
|
||
return strconv.FormatFloat(v, 'f', -1, 64)
|
||
}
|
||
|
||
// DashboardSummary mirrors the service.DashboardSummary for JSON unmarshaling.
|
||
// JSON tags must match the service-layer struct exactly.
|
||
type DashboardSummary struct {
|
||
TotalCertificates int64 `json:"total_certificates"`
|
||
ExpiringCertificates int64 `json:"expiring_certificates"`
|
||
ExpiredCertificates int64 `json:"expired_certificates"`
|
||
RevokedCertificates int64 `json:"revoked_certificates"`
|
||
ActiveAgents int64 `json:"active_agents"`
|
||
OfflineAgents int64 `json:"offline_agents"`
|
||
TotalAgents int64 `json:"total_agents"`
|
||
PendingJobs int64 `json:"pending_jobs"`
|
||
FailedJobs int64 `json:"failed_jobs"`
|
||
CompleteJobs int64 `json:"complete_jobs"`
|
||
// NotificationsDead mirrors service.DashboardSummary.NotificationsDead.
|
||
// JSON tag "notifications_dead" must match the service-layer struct
|
||
// exactly — this cross-package mirror avoids a direct import cycle and
|
||
// is driven by the I-005 Prometheus counter emission path. See
|
||
// GetPrometheusMetrics and MetricsCounter.NotificationsDeadTotal.
|
||
NotificationsDead int64 `json:"notifications_dead"`
|
||
CompletedAt time.Time `json:"completed_at"`
|
||
}
|