auditlog

package module

Go to main page

Versions in this module

v0

v0.6.0

Jul 6, 2026

v0.5.1

Jul 2, 2026

Changes in this version

+ var ErrFileExists = fmt.Errorf("%w: file already exists", ErrExportWriteFailed)

+ func CheckNoClobber(path string) error

+ func HasPointerAddress(name string) bool

type StepInfo

+ func (s StepInfo) Type() string

type WorkflowReport

+ func (r WorkflowReport) NameCollisions() []string

v0.5.0

Jun 22, 2026

Changes in this version

+ var ErrExportWriteFailed = errors.New("export write failed")

+ var ErrRenderFailed = errors.New("render failed")

+ var ErrReportLoadFailed = errors.New("report load failed")

+ func ErrorClassifications() map[error]errorfamily.Family

+ func RegisterClassifications(reg *errorfamily.Registry)

v0.4.0

Jun 22, 2026

v0.3.0

Jun 22, 2026

Changes in this version

type Auditor

+ func (a *Auditor) ExportHTML(path string) error

+ func (a *Auditor) WriteHTML(writer io.Writer) error

+ func (a *Auditor) WriteHTMLString() (string, error)

+ type EventMeta struct

+ Color string

+ Label string

+ type StatusMeta struct

+ Icon string

+ Label string

+ type TypeMetadata struct

+ Events map[string]EventMeta

+ Statuses map[string]StatusMeta

+ func BuildTypeMetadata() TypeMetadata

type WorkflowReport

+ func (r WorkflowReport) ExportHTML(path string) error

+ func (r WorkflowReport) WriteHTML(writer io.Writer) error

+ func (r WorkflowReport) WriteHTMLString() (string, error)

v0.2.1

Jun 21, 2026

Changes in this version

type EventType

+ func (e EventType) IsKnown() bool

type Phase

+ func (p Phase) IsKnown() bool

type StepStatus

+ func (s StepStatus) IsKnown() bool

v0.2.0

Jun 21, 2026

Changes in this version

+ var ErrCountMismatch = errors.New("status count does not match steps")

type Auditor

+ func (a *Auditor) ExportD2(path string) error

+ func (a *Auditor) ExportHTMLTree(path string) error

+ func (a *Auditor) ExportJSON(path string) error

+ func (a *Auditor) ExportNDJSON(path string) error

+ func (a *Auditor) ExportTable(path string, format output.Format, opts output.RenderOptions) error

+ func (a *Auditor) ExportTree(path string) error

+ func (a *Auditor) WriteD2(writer io.Writer) error

+ func (a *Auditor) WriteD2String() (string, error)

+ func (a *Auditor) WriteGraphvizString() (string, error)

+ func (a *Auditor) WriteHTMLTree(writer io.Writer) error

+ func (a *Auditor) WriteHTMLTreeString() (string, error)

+ func (a *Auditor) WriteJSON(writer io.Writer) error

+ func (a *Auditor) WriteMermaidString() (string, error)

+ func (a *Auditor) WriteNDJSON(writer io.Writer) error

+ func (a *Auditor) WritePlantUMLString() (string, error)

+ func (a *Auditor) WriteTable(writer io.Writer, format output.Format, opts output.RenderOptions) error

+ func (a *Auditor) WriteTableString(format output.Format, opts output.RenderOptions) (string, error)

+ func (a *Auditor) WriteTree(writer io.Writer) error

+ func (a *Auditor) WriteTreeString() (string, error)

+ type RunID string

+ func (r RunID) IsEmpty() bool

+ func (r RunID) String() string

type StepStatus

+ func (s StepStatus) Color() (string, string)

type WorkflowReport

+ CriticalPathDurationMs float64

+ FailureReason string

+ PeakConcurrency int

+ PendingCount int

+ RunningCount int

+ WallClockDurationMs float64

+ func (r WorkflowReport) ExportD2(path string) error

+ func (r WorkflowReport) ExportGraphviz(path string) error

+ func (r WorkflowReport) ExportHTMLTree(path string) error

+ func (r WorkflowReport) ExportJSON(path string) error

+ func (r WorkflowReport) ExportMermaid(path string) error

+ func (r WorkflowReport) ExportNDJSON(path string) error

+ func (r WorkflowReport) ExportPlantUML(path string) error

+ func (r WorkflowReport) ExportTable(path string, format output.Format, opts output.RenderOptions) error

+ func (r WorkflowReport) ExportTree(path string) error

+ func (r WorkflowReport) WriteD2(writer io.Writer) error

+ func (r WorkflowReport) WriteD2String() (string, error)

+ func (r WorkflowReport) WriteHTMLTree(writer io.Writer) error

+ func (r WorkflowReport) WriteHTMLTreeString() (string, error)

+ func (r WorkflowReport) WriteTable(writer io.Writer, format output.Format, opts output.RenderOptions) error

+ func (r WorkflowReport) WriteTableString(format output.Format, opts output.RenderOptions) (string, error)

+ func (r WorkflowReport) WriteTree(writer io.Writer) error

+ func (r WorkflowReport) WriteTreeString() (string, error)

v0.1.1

Jun 20, 2026

v0.1.0

Jun 18, 2026

Changes in this version

+ const EnvKeyEnabled

+ const SchemaVersion

+ var ErrEmpty = errors.New("ndjson input is empty")

+ var ErrEventCountMismatch = errors.New("event_count does not match len(events)")

+ var ErrNoEvents = errors.New("ndjson input contains no events")

+ var ErrOversizedLine = errors.New("ndjson line exceeds maximum size")

+ var ErrReplayNoEvents = errors.New("no events to replay")

+ var ErrStatusDrift = errors.New("step status does not match derived status")

+ var ErrStepCountMismatch = errors.New("step_count does not match len(steps)")

+ var ErrWorkflowIDPathSep = errors.New("config.WorkflowID must not contain path separators")

+ type Auditor struct

+ func New(config Config) (*Auditor, error)

+ func (a *Auditor) Attach(w *flow.Workflow) *flow.Workflow

+ func (a *Auditor) DroppedEventCount() int64

+ func (a *Auditor) Events() []Event

+ func (a *Auditor) EventsCount() int

+ func (a *Auditor) ExportEventsToNDJSON(path string) error

+ func (a *Auditor) ExportGraphviz(path string) error

+ func (a *Auditor) ExportMermaid(path string) error

+ func (a *Auditor) ExportPlantUML(path string) error

+ func (a *Auditor) ExportToFile(path string) error

+ func (a *Auditor) Report() WorkflowReport

+ func (a *Auditor) ReportFiltered(opts ...ReportOption) WorkflowReport

+ func (a *Auditor) RunID() string

+ func (a *Auditor) Snapshot(w *flow.Workflow)

+ func (a *Auditor) WriteEventsNDJSON(writer io.Writer) error

+ func (a *Auditor) WriteGraphviz(writer io.Writer) error

+ func (a *Auditor) WriteMermaid(writer io.Writer) error

+ func (a *Auditor) WritePlantUML(writer io.Writer) error

+ func (a *Auditor) WriteReportJSON(writer io.Writer) error

+ type Config struct

+ Enabled bool

+ InitialEventCapacity int

+ MaxEvents int

+ OnEvent func(Event)

+ RunID string

+ WorkflowID string

+ func (c Config) Validate() error

+ type DiffResult struct

+ AddedSteps []StepDiff

+ DurationDelta float64

+ RemovedSteps []StepDiff

+ StatusChanged []StepDiff

+ func (d DiffResult) HasChanges() bool

+ type Event struct

+ Attempt int

+ DurationMs *float64

+ Error *string

+ EventType EventType

+ Phase Phase

+ RunID string

+ Sequence int

+ Status StepStatus

+ Timestamp time.Time

+ func ReadEvents(reader io.Reader) ([]Event, error)

+ func (e Event) Duration() float64

+ func (e Event) HasError() bool

+ func (e Event) IsAfter() bool

+ func (e Event) IsAttemptEnd() bool

+ func (e Event) IsAttemptStart() bool

+ func (e Event) IsBefore() bool

+ type EventType string

+ const EventTypeAttemptEnd

+ const EventTypeAttemptStart

+ func (e EventType) Color() string

+ func (e EventType) Label() string

+ type Phase string

+ const PhaseAfter

+ const PhaseBefore

+ type Recorder struct

+ func NewRecorder(workflowID, runID string, onEvent func(Event)) *Recorder

+ func (r *Recorder) BuildReport() WorkflowReport

+ func (r *Recorder) DroppedEventCount() int64

+ func (r *Recorder) Events() []Event

+ func (r *Recorder) EventsCount() int

+ func (r *Recorder) RunID() string

+ type ReportIndex struct

+ func NewReportIndex(r WorkflowReport) *ReportIndex

+ func (idx *ReportIndex) EventsByStep(name string) []Event

+ func (idx *ReportIndex) EventsByType(t EventType) []Event

+ func (idx *ReportIndex) StepByID(id int) *StepInfo

+ func (idx *ReportIndex) StepByName(name string) *StepInfo

+ type ReportOption func(*reportFilter)

+ func WithEventsByType(eventType EventType) ReportOption

+ func WithStepsByName(names ...string) ReportOption

+ func WithStepsByStatus(statuses ...StepStatus) ReportOption

+ func WithTimeRange(from, to time.Time) ReportOption

+ type StepDiff struct

+ Duration float64

+ Name string

+ OldStatus StepStatus

+ Status StepStatus

+ type StepInfo struct

+ AttemptCount int

+ Dependencies []StepRef

+ Dependents []StepRef

+ DurationMs *float64

+ Error *string

+ FinishedAt *time.Time

+ HasRetry bool

+ HasTimeout bool

+ MaxAttempts int

+ StartedAt *time.Time

+ Status StepStatus

+ StepID int

+ func (s StepInfo) DeriveStatus() StepStatus

+ func (s StepInfo) Duration() float64

+ func (s StepInfo) HasError() bool

+ type StepRef struct

+ Name string

+ StepType string

+ type StepStatus string

+ const StepStatusCanceled

+ const StepStatusFailed

+ const StepStatusPending

+ const StepStatusRunning

+ const StepStatusSkipped

+ const StepStatusSucceeded

+ func (s StepStatus) Icon() string

+ func (s StepStatus) IsError() bool

+ func (s StepStatus) IsTerminal() bool

+ func (s StepStatus) Label() string

+ func (s StepStatus) String() string

+ type WorkflowReport struct

+ CanceledCount int

+ DroppedEventCount int64

+ EventCount int

+ Events []Event

+ ExportedAt time.Time

+ FailedCount int

+ Reconstructed bool

+ RunID string

+ SkippedCount int

+ StepCount int

+ Steps []StepInfo

+ SucceededCount int

+ TotalDurationMs float64

+ Version string

+ WorkflowID string

+ WorkflowSucceeded bool

+ func LoadReport(path string) (WorkflowReport, error)

+ func LoadReportFromBytes(data []byte) (WorkflowReport, error)

+ func LoadReportFromReader(reader io.Reader) (WorkflowReport, error)

+ func ReplayEvents(events []Event) (WorkflowReport, error)

+ func (r WorkflowReport) Diff(other WorkflowReport) DiffResult

+ func (r WorkflowReport) Duration() time.Duration

+ func (r WorkflowReport) EventsByStep(stepName string) []Event

+ func (r WorkflowReport) EventsByType(t EventType) []Event

+ func (r WorkflowReport) FailedSteps() []StepInfo

+ func (r WorkflowReport) Filtered(opts ...ReportOption) WorkflowReport

+ func (r WorkflowReport) RetriedSteps() []StepInfo

+ func (r WorkflowReport) SkippedSteps() []StepInfo

+ func (r WorkflowReport) StepByName(name string) *StepInfo

+ func (r WorkflowReport) SucceededSteps() []StepInfo

+ func (r WorkflowReport) Summary() string

+ func (r WorkflowReport) Validate() error

+ func (r WorkflowReport) WriteGraphviz(writer io.Writer) error

+ func (r WorkflowReport) WriteGraphvizString() (string, error)

+ func (r WorkflowReport) WriteJSON(writer io.Writer) error

+ func (r WorkflowReport) WriteMermaid(writer io.Writer) error

+ func (r WorkflowReport) WriteMermaidString() (string, error)

+ func (r WorkflowReport) WriteNDJSON(writer io.Writer) error

+ func (r WorkflowReport) WritePlantUML(writer io.Writer) error

+ func (r WorkflowReport) WritePlantUMLString() (string, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL