report

type Breakpoint struct {
	// Found is false when every level passed.
	Found bool `json:"found"`
	// LastPass is the highest planned load that met every target.
	LastPass float64 `json:"lastPass"`
	// FirstFail is the lowest planned load that missed a target.
	FirstFail float64  `json:"firstFail,omitempty"`
	Unit      string   `json:"unit"`
	FailedOn  []string `json:"failedOn,omitempty"`
	// Refined lists the confirmation holds that narrowed LastPass and
	// FirstFail after the first failing step; the breakpoint lies
	// between the two.
	Refined []RefineStep `json:"refined,omitempty"`
}

type BrowserStat struct {
	TTFB *PhaseStat `json:"ttfb,omitempty"`
	FCP  *PhaseStat `json:"fcp,omitempty"`
	LCP  *PhaseStat `json:"lcp,omitempty"`
	CLS  *PhaseStat `json:"cls,omitempty"`
	INP  *PhaseStat `json:"inp,omitempty"`
	Load *PhaseStat `json:"load,omitempty"`
}

type Check struct {
	Source   string  `json:"source"`
	Scope    string  `json:"scope"`
	Metric   string  `json:"metric"`
	Op       string  `json:"op"`
	Target   float64 `json:"target"`
	Observed float64 `json:"observed"`
	Pass     bool    `json:"pass"`
	// Display strings in the metric's unit.
	TargetText   string `json:"targetText"`
	ObservedText string `json:"observedText"`
}

type Claim struct {
	Text  string   `json:"text"`
	Label string   `json:"label"` // measured or suspected
	Refs  []string `json:"refs"`  // fact ids, see Facts
}

type Comparison struct {
	A          Side          `json:"a"`
	B          Side          `json:"b"`
	Comparable bool          `json:"comparable"`
	Problems   []string      `json:"problems,omitempty"`
	Metrics    []MetricDelta `json:"metrics"`
	// Steps compares each request step's p95 and error rate. They are
	// informational: with many steps some differ by chance, so they do
	// not change the verdict.
	Steps      []StepDelta `json:"steps,omitempty"`
	Verdict    string      `json:"verdict"` // regression, improvement, no-change, inconclusive
	Confidence float64     `json:"confidence"`
}

type CurvePoint struct {
	// Offered is the planned load: users, or iterations per second.
	Offered float64 `json:"offered"`
	// Throughput is completed iterations per second.
	Throughput float64 `json:"throughput"`
	RPS        float64 `json:"rps"`
	P50        float64 `json:"p50"`
	P95        float64 `json:"p95"`
	P99        float64 `json:"p99"`
	ErrorRate  float64 `json:"errorRate"`
	Seconds    int     `json:"seconds"`
}

type ErrorRow struct {
	Journey string `json:"journey"`
	Step    string `json:"step"`
	Error   string `json:"error"`
	Count   uint64 `json:"count"`
	// Examples are up to three of these failures, with what was sent and
	// received (credentials and secrets redacted).
	Examples []metrics.ErrorExample `json:"examples,omitempty"`
}

type Fact struct {
	ID    string `json:"id"`
	Text  string `json:"text"`
	Where string `json:"where"` // the report section that shows it
}

type FaultEvent struct {
	Label  string  `json:"label"`
	Kind   string  `json:"kind"` // proxy, container or deployment
	Target string  `json:"target"`
	Start  float64 `json:"start"`
	End    float64 `json:"end"`
	// Error says why the fault could not be applied or reverted.
	Error string `json:"error,omitempty"`
}

type FirstEventStat struct {
	Mean float64 `json:"mean"`
	P50  float64 `json:"p50"`
	P95  float64 `json:"p95"`
	P99  float64 `json:"p99"`
}

type Input struct {
	RunID      string
	Program    *scenario.Program
	Plan       *scenario.Plan
	Target     string
	Started    time.Time
	Ended      time.Time
	StopReason string
	PeakVUs    int
	Workers    int
	Interval   time.Duration
	Snapshots  []*metrics.Snapshot // already merged per interval, any order
	Phases     map[int]*[metrics.NumPhases]*metrics.Histogram
	Breakpoint *Breakpoint
}

type Journey struct {
	Name  string `json:"name"`
	Stats Stats  `json:"stats"`
	Steps []Step `json:"steps"`
}

type Knee struct {
	Found bool `json:"found"`
	// At is the last level that still scaled; Next is the first that did not.
	At     CurvePoint  `json:"at"`
	Next   *CurvePoint `json:"next,omitempty"`
	Unit   string      `json:"unit"`
	Reason string      `json:"reason,omitempty"`
}

type LoadInfo struct {
	Shape    string  `json:"shape,omitempty"`
	Mode     string  `json:"mode"`
	Executor string  `json:"executor"`
	Peak     float64 `json:"peak"`
	PeakVUs  int     `json:"peakVUs"`
	Workers  int     `json:"workers"`
}

type MetricDelta struct {
	Name string `json:"name"`
	// HigherIsBetter is true for throughput-like metrics.
	HigherIsBetter bool      `json:"higherIsBetter"`
	A              []float64 `json:"a"`
	B              []float64 `json:"b"`
	MeanA          float64   `json:"meanA"`
	MeanB          float64   `json:"meanB"`
	// Change is (meanB - meanA) / meanA.
	Change float64 `json:"change"`
	// CILow and CIHigh bound the relative change.
	CILow  float64 `json:"ciLow"`
	CIHigh float64 `json:"ciHigh"`
	// NoiseFloor is the relative spread between repeats of one version.
	NoiseFloor float64 `json:"noiseFloor"`
	Verdict    string  `json:"verdict"`
}

type MetricPoint struct {
	// T is seconds since the run started, like Point.T.
	T     float64 `json:"t"`
	Value float64 `json:"value"`
}

type Narrative struct {
	Summary string  `json:"summary"`
	Claims  []Claim `json:"claims"`
	// Model is the model that wrote it, for the record.
	Model string `json:"model,omitempty"`
	// Facts are the report figures the claims cite.
	Facts []Fact `json:"facts,omitempty"`
}

type PhaseStat struct {
	Mean float64 `json:"mean"`
	P95  float64 `json:"p95"`
}

type Point struct {
	T          float64 `json:"t"` // seconds since start
	RPS        float64 `json:"rps"`
	ErrorRate  float64 `json:"errorRate"`
	P50        float64 `json:"p50"`
	P95        float64 `json:"p95"`
	P99        float64 `json:"p99"`
	VUs        int     `json:"vus"`
	Planned    float64 `json:"planned"`
	Dropped    uint64  `json:"dropped"`
	Iterations uint64  `json:"iterations"`
	SchedLag99 float64 `json:"schedLagP99"`
}

type Recovery struct {
	// Recovered is false when the run ended before the target was back.
	Recovered bool `json:"recovered"`
	// Seconds from load returning to normal to the target holding its
	// baseline again.
	Seconds float64 `json:"seconds,omitempty"`
	// NormalAt is when load returned to normal, in seconds since start.
	NormalAt float64 `json:"normalAt"`
	// Baseline is the target before the overload: median p95 (seconds)
	// and error rate over the normal-load hold.
	BaselineP95       float64 `json:"baselineP95"`
	BaselineErrorRate float64 `json:"baselineErrorRate"`
}

type RefineStep struct {
	Level    float64  `json:"level"`
	Pass     bool     `json:"pass"`
	FailedOn []string `json:"failedOn,omitempty"`
}

type Report struct {
	FormatVersion int       `json:"formatVersion"`
	Stampede      string    `json:"stampede"`
	RunID         string    `json:"runId,omitempty"`
	Scenario      string    `json:"scenario"`
	Target        string    `json:"target"`
	Started       time.Time `json:"started"`
	Ended         time.Time `json:"ended"`
	// Duration is the measured load phase in seconds.
	Duration   float64     `json:"duration"`
	StopReason string      `json:"stopReason"`
	Load       LoadInfo    `json:"load"`
	Verdict    string      `json:"verdict"`
	Thresholds []Check     `json:"thresholds"`
	Overall    Stats       `json:"overall"`
	Journeys   []Journey   `json:"journeys"`
	Errors     []ErrorRow  `json:"errors"`
	Timeline   []Point     `json:"timeline"`
	Breakpoint *Breakpoint `json:"breakpoint,omitempty"`
	// Curve and Knee are set for runs whose load changed over time.
	Curve []CurvePoint `json:"curve,omitempty"`
	Knee  *Knee        `json:"knee,omitempty"`
	// Recovery is set for spike and recovery shapes.
	Recovery *Recovery `json:"recovery,omitempty"`
	Notes    []string  `json:"notes,omitempty"`
	// Workers describes each worker of a distributed run; an in-process
	// run lists its machine only when it was saturated.
	Workers []WorkerRow `json:"workers,omitempty"`
	// Faults are the faults a stampede agent injected during the run.
	Faults []FaultEvent `json:"faults,omitempty"`
	// Narrative is an optional AI-written summary that cites the figures.
	Narrative *Narrative `json:"narrative,omitempty"`
	// TargetMetrics are the target's own metrics over the run, queried
	// from Prometheus after it ended (observe.prometheus).
	TargetMetrics []TargetMetric `json:"targetMetrics,omitempty"`
}

type Side struct {
	Label string   `json:"label"`
	Runs  []string `json:"runs"`
}

type SlowRequest struct {
	// Latency is in seconds, measured from the intended send time.
	Latency float64 `json:"latency"`
	// At is when the request was sent; T is the same in seconds since
	// the run started.
	At time.Time `json:"at"`
	T  float64   `json:"t"`
	// TraceID is the W3C trace ID the request carried in traceparent.
	TraceID string `json:"traceId,omitempty"`
	// TraceURL links to the trace when a trace link template is set.
	TraceURL string `json:"traceUrl,omitempty"`
	Status   int    `json:"status,omitempty"`
	Error    string `json:"error,omitempty"`
}

type SlowRow struct {
	Journey string
	Step    string
	SlowRequest
}

type Span struct {
	From float64 `json:"from"`
	To   float64 `json:"to"`
}

type Stats struct {
	Requests     uint64              `json:"requests"`
	Failed       uint64              `json:"failed"`
	ErrorRate    float64             `json:"errorRate"`
	RPS          float64             `json:"rps"`
	Latency      metrics.Percentiles `json:"latency"`
	Service      metrics.Percentiles `json:"service"`
	BytesIn      uint64              `json:"bytesIn"`
	BytesOut     uint64              `json:"bytesOut"`
	ChecksPassed uint64              `json:"checksPassed"`
	ChecksFailed uint64              `json:"checksFailed"`
	Status       map[int]uint64      `json:"status,omitempty"`
	// Iteration-level figures (overall and per journey).
	Iterations       uint64              `json:"iterations,omitempty"`
	IterationsFailed uint64              `json:"iterationsFailed,omitempty"`
	IterationTime    metrics.Percentiles `json:"iterationTime,omitzero"`
	Dropped          uint64              `json:"dropped,omitempty"`
}

type Step struct {
	ID    int    `json:"id"`
	Name  string `json:"name"`
	Stats Stats  `json:"stats"`
	// Phases holds mean and p95 seconds for dns, connect, tls, wait and download.
	Phases map[string]PhaseStat `json:"phases"`
	// Protocols counts requests by negotiated protocol (HTTP/1.1, HTTP/2.0).
	Protocols map[string]uint64 `json:"protocols,omitempty"`
	// Stream is set for streaming steps (server-sent events, gRPC server
	// streaming).
	Stream *StreamStat `json:"stream,omitempty"`
	// Slowest lists the step's slowest requests, slowest first.
	Slowest []SlowRequest `json:"slowest,omitempty"`
	// Browser is set for browser page loads and interactions.
	Browser *BrowserStat `json:"browser,omitempty"`
}

type StepDelta struct {
	Journey string        `json:"journey"`
	Step    string        `json:"step"`
	Metrics []MetricDelta `json:"metrics"`
}

type StreamStat struct {
	// Streams counts steps that received at least one event.
	Streams uint64 `json:"streams"`
	Events  uint64 `json:"events"`
	// EventsPerSec is the rate of the events after the first, measured
	// from each stream's first event to its end.
	EventsPerSec float64 `json:"eventsPerSec"`
	// FirstEvent is the time from the start of the step to its first
	// event, in seconds.
	FirstEvent FirstEventStat `json:"firstEvent"`
}

type TargetMetric struct {
	Name   string        `json:"name"`
	Query  string        `json:"query"`
	Points []MetricPoint `json:"points"`
	// Error explains why points are missing or incomplete.
	Error string `json:"error,omitempty"`
}

type WorkerRow struct {
	ID         string  `json:"id"`
	Name       string  `json:"name"`
	Region     string  `json:"region,omitempty"`
	ShareLo    float64 `json:"shareLo"`
	ShareHi    float64 `json:"shareHi"`
	State      string  `json:"state"`
	StopReason string  `json:"stopReason,omitempty"`
	Error      string  `json:"error,omitempty"`
	PeakVUs    int     `json:"peakVUs"`
	Requests   uint64  `json:"requests"`
	// Saturated lists the windows in which the worker reported itself
	// saturated (CPU, scheduling lag, GC pauses, file descriptors or
	// dropped iterations); latency measured there may reflect the
	// generator rather than the target.
	Saturated         []Span   `json:"saturated,omitempty"`
	SaturationReasons []string `json:"saturationReasons,omitempty"`
	// Lost is the window from the worker's loss to the end of the run, or
	// until another worker took over its share: its share of the load was
	// not generated in that window.
	Lost *Span `json:"lost,omitempty"`
	// Replaces names the lost worker whose share this one took over.
	Replaces string `json:"replaces,omitempty"`
	// ClockOffset is the worker's measured clock offset in seconds.
	ClockOffset float64 `json:"clockOffset"`
}