runlog

package

v0.95.6 Latest Latest Go to latest Published: Sep 5, 2026 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sneat-dev/wb

Links

Open Source Insights

Documentation ¶

Overview ¶

Package runlog records privacy-safe telemetry for commands launched through `wb run --`. The log lives inside a managed worktree so an agent can write it without access to the user's home directory and so lifecycle tooling can later publish or aggregate it with the worktree's other local evidence.

Index ¶

Constants
func Append(path string, event Event) error
type Event
- func Read(path string) ([]Event, error)
- func ReadCurrent(cwd string) ([]Event, string, error)
type KindSummary
type Recorder
- func Begin(cwd string, argv []string, now time.Time) (Recorder, error)
- func (recorder Recorder) Finish(exitCode int, userCPU, systemCPU time.Duration, now time.Time) error
- func (recorder *Recorder) RecordAdmission(units int, wait time.Duration)
type Summary
- func Summarize(events []Event, since time.Time) Summary

Constants ¶

View Source

const (
	EventSchemaVersion = 1
	OperationIDEnv     = "WB_OPERATION_ID"
)

Variables ¶

This section is empty.

Functions ¶

func Append ¶

func Append(path string, event Event) error

Append writes one event under an exclusive file lock so concurrent commands in the same worktree cannot interleave JSON bytes.

Types ¶

type Event ¶

type Event struct {
	SchemaVersion int       `json:"schema_version"`
	Timestamp     time.Time `json:"timestamp"`
	OperationID   string    `json:"operation_id"`
	State         string    `json:"state"`
	Kind          string    `json:"kind"`
	ArgsSHA256    string    `json:"args_sha256"`
	ArgumentCount int       `json:"argument_count"`
	Repository    string    `json:"repository,omitempty"`
	EffortID      string    `json:"effort_id,omitempty"`
	RunID         string    `json:"run_id,omitempty"`
	DurationMS    int64     `json:"duration_ms,omitempty"`
	UserCPUMS     int64     `json:"user_cpu_ms,omitempty"`
	SystemCPUMS   int64     `json:"system_cpu_ms,omitempty"`
	QueueWaitMS   int64     `json:"queue_wait_ms,omitempty"`
	CPUUnits      int       `json:"cpu_units,omitempty"`
	ExitCode      *int      `json:"exit_code,omitempty"`
}

Event is one immutable command lifecycle observation. It deliberately omits raw arguments and output; ArgsSHA256 supports correlation without copying prompts, commit messages, paths, tokens, or source into the log.

func Read ¶

func Read(path string) ([]Event, error)

Read parses a run event log. Unknown newer schemas are rejected.

func ReadCurrent ¶

func ReadCurrent(cwd string) ([]Event, string, error)

ReadCurrent returns telemetry for the managed worktree containing cwd.

type KindSummary ¶

type KindSummary struct {
	Kind       string `json:"kind"`
	Operations int    `json:"operations"`
	Failed     int    `json:"failed"`
	WallMS     int64  `json:"wall_ms"`
	P50MS      int64  `json:"p50_ms"`
	P95MS      int64  `json:"p95_ms"`
}

type Recorder ¶

type Recorder struct {
	OperationID string
	Path        string
	StartedAt   time.Time
	// contains filtered or unexported fields
}

Recorder owns one operation ID and its optional managed-worktree log.

func Begin ¶

func Begin(cwd string, argv []string, now time.Time) (Recorder, error)

Begin records a requested operation when cwd belongs to a managed worktree. Unmanaged directories still get an operation ID but no filesystem side effect; WB can therefore wrap diagnostics outside a worktree safely.

func (Recorder) Finish ¶

func (recorder Recorder) Finish(exitCode int, userCPU, systemCPU time.Duration, now time.Time) error

Finish records the terminal result. CPU durations come from the child process state and exclude WB orchestration overhead.

func (*Recorder) RecordAdmission ¶

func (recorder *Recorder) RecordAdmission(units int, wait time.Duration)

RecordAdmission adds scheduler evidence to the terminal event without exposing command arguments or output.

type Summary ¶

type Summary struct {
	Since       time.Time     `json:"since"`
	Operations  int           `json:"operations"`
	Running     int           `json:"running"`
	Failed      int           `json:"failed"`
	WallMS      int64         `json:"wall_ms"`
	UserCPUMS   int64         `json:"user_cpu_ms"`
	SystemCPUMS int64         `json:"system_cpu_ms"`
	Kinds       []KindSummary `json:"kinds"`
}

func Summarize ¶

func Summarize(events []Event, since time.Time) Summary

Summarize computes completed-operation cost and currently unmatched starts.

Source Files ¶

View all Source files

runlog.go

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