advisor

type CacheTelemetry struct {
	Hits   uint64 `json:"hits"`
	Misses uint64 `json:"misses"`
	// Evictions counts entries removed before their TTL expired
	// (capacity pressure), e.g. memcached evictions / redis evicted_keys.
	Evictions uint64 `json:"evictions"`
}

type Check struct {
	ID             string     `json:"id"`
	Title          string     `json:"title"`
	Status         Status     `json:"status"`
	Detail         string     `json:"detail,omitempty"`
	Recommendation string     `json:"recommendation,omitempty"`
	Provenance     Provenance `json:"provenance"`
}

type Evidence string

type Options struct {
	DriverName string
	DSN        string
	// DB is an open raw (unproxied) connection for MySQL variable checks.
	// The caller owns closing it.
	DB *sql.DB
	// NginxConf is the concatenated nginx configuration content.
	NginxConf []byte
	// FS is the root filesystem ("/" in production, a fixture in tests).
	FS fs.FS
	// GOMAXPROCS is runtime.GOMAXPROCS(0); 0 skips the check.
	GOMAXPROCS int
	// Protocol supplies HTTP/3/QUIC readiness evidence. Configuration content
	// is inspected locally; off-host network and edge facts must be explicit.
	Protocol ProtocolOptions
	// Cache supplies application-side cache telemetry (memcached/redis
	// stats); nil skips the check. CacheError records why it could not be
	// read.
	Cache      *CacheTelemetry
	CacheError string
}

type PlanFreshness string

type ProtocolOptions struct {
	ProxyKind       string
	ProxyConfig     []byte
	UDP443Reachable Evidence
	EdgeName        string
	EdgeHTTP3       Evidence
	QUIC            *QUICTelemetry
	QUICError       string
}

type ProtocolSample struct {
	Protocol string
	Count    int64
	Errors   int64
	P95      time.Duration
}

type Provenance struct {
	RuleVersion string `json:"rule_version"`
	Category    string `json:"category"`
	Source      string `json:"source"`
	Freshness   string `json:"freshness"`
	Scope       string `json:"scope"`
	Formula     string `json:"formula"`
	Actual      string `json:"actual"`
	Unit        string `json:"unit"`
	Limitation  string `json:"limitation"`
	Docs        string `json:"docs"`
}

type QUICTelemetry struct {
	PacketsSent          uint64 `json:"packets_sent"`
	PacketsRetransmitted uint64 `json:"packets_retransmitted"`
	UDPDatagramsDropped  uint64 `json:"udp_datagrams_dropped"`
}

type QueryPlan struct {
	// TargetID names the database target, so a multi-host run can tell two
	// identical plans apart. Empty for a single-target run.
	TargetID string `json:"target_id,omitempty"`
	Digest   string `json:"digest"`
	// Query is the normalized statement text (plan 04's DIGEST_TEXT).
	Query string `json:"query,omitempty"`
	// Freshness decides whether this plan is judged at all.
	Freshness PlanFreshness `json:"freshness"`
	// FreshReason is plan 09's closed FreshReason enum ("in_interval",
	// "before_interval", "after_interval", "db_clock_anomaly",
	// "db_clock_missing", "run_partial", "interval_too_short"). Unrecognized
	// values are never echoed.
	FreshReason string `json:"fresh_reason,omitempty"`
	// Rows is the EXPLAIN output; empty when the capture failed.
	Rows []QueryPlanRow `json:"rows,omitempty"`
	// ErrClass is plan 09's closed PlanErrorClass ("timeout",
	// "budget_exhausted", "permission_denied", "syntax_or_truncated",
	// "object_missing", "sample_unavailable", "sample_possibly_truncated",
	// "connection_error", "other"). Unrecognized values are never echoed.
	ErrClass string `json:"err_class,omitempty"`
}

type QueryPlanRow struct {
	SelectType   *string `json:"select_type,omitempty"`
	Table        *string `json:"table,omitempty"`
	Type         *string `json:"type,omitempty"`
	Key          *string `json:"key,omitempty"`
	PossibleKeys *string `json:"possible_keys,omitempty"`
	Rows         *int64  `json:"rows,omitempty"`
	Extra        *string `json:"extra,omitempty"`
}

type Status string