report

Documentation

Index

• func Histogram(values []float64, buckets []float64) string
• func WriteJSON(w io.Writer, r Report) error
• func WriteText(w io.Writer, r Report)
• type Finding
  • func TopFindings(findings []Finding, n int) []Finding
• type Report
  • func (r Report) WorstSeverity() Severity
• type Section
• type Severity

Functions

func Histogram

func Histogram(values []float64, buckets []float64) string

Histogram produces a simple text histogram of value distribution.

func WriteJSON

func WriteJSON(w io.Writer, r Report) error

WriteJSON writes a machine-readable JSON report.

func WriteText

func WriteText(w io.Writer, r Report)

WriteText writes a human-readable text report.

Types

type Finding

type Finding struct {
	File     string   `json:"file"`
	Line     int      `json:"line,omitempty"`
	Function string   `json:"function,omitempty"`
	Message  string   `json:"message"`
	Value    float64  `json:"value"`
	Limit    float64  `json:"limit,omitempty"`
	Severity Severity `json:"severity"`
}

Finding represents a single metric violation or observation.

func TopFindings

func TopFindings(findings []Finding, n int) []Finding

TopFindings returns the top N findings sorted by value descending.

type Report

type Report struct {
	Sections []Section `json:"sections"`
}

Report is the top-level output.

func (Report) WorstSeverity

func (r Report) WorstSeverity() Severity

WorstSeverity returns the worst severity across all sections.

type Section

type Section struct {
	Name     string    `json:"name"`
	Summary  string    `json:"summary"`
	Severity Severity  `json:"severity"`
	Findings []Finding `json:"findings,omitempty"`
	Stats    any       `json:"stats,omitempty"`
}

Section represents one metric category in the report.

type Severity

type Severity string

Severity indicates the level of a finding.

const (
	SeverityPass Severity = "PASS"
	SeverityWarn Severity = "WARN"
	SeverityFail Severity = "FAIL"
)