Skip to content

logger

import "github.com/alehatsman/mooncake/internal/logger"

Package logger provides logging interfaces and implementations for mooncake.

Index

Constants

const (
    // DebugLevel logs are typically voluminous, and are usually disabled in
    // production.
    DebugLevel = iota
    // InfoLevel is the default logging priority.
    InfoLevel
    // ErrorLevel logs are high-priority. If an application is running smoothly,
    // it shouldn't generate any error-logLevel logs.
    ErrorLevel
)

Step status constants used across all logger implementations

const (
    StatusRunning = "running"
    StatusSuccess = "success"
    StatusError   = "error"
    StatusSkipped = "skipped"
)

func GetTerminalSize

func GetTerminalSize() (width, height int)

GetTerminalSize returns the current terminal size. Returns default 80x24 if detection fails.

func IsTUISupported

func IsTUISupported() bool

IsTUISupported checks if the terminal supports TUI mode. Returns true if terminal is detected, supports ANSI codes, and meets minimum size requirements.

func ParseLogLevel

func ParseLogLevel(level string) (int, error)

ParseLogLevel converts a log level string to its integer constant. Valid values are "debug", "info", and "error" (case-insensitive). Returns an error if the level string is not recognized.

func StripANSI

func StripANSI(s string) string

StripANSI removes all ANSI escape codes from a string. This includes color codes, cursor movement, and other terminal control sequences.

Example:

StripANSI("\x1b[31mRed Text\x1b[0m") → "Red Text"

func TruncateANSI

func TruncateANSI(s string, maxWidth int) string

TruncateANSI truncates a string to the specified visible width while preserving ANSI escape codes. If truncation occurs, an ellipsis is added.

The function: 1. Preserves all ANSI codes before the truncation point 2. Counts only visible characters for width calculation 3. Adds "..." when truncation occurs 4. Handles UTF-8 characters correctly

Example:

TruncateANSI("\x1b[31mLong Red Text\x1b[0m", 8) → "\x1b[31mLong...\x1b[0m"

func VisibleLength

func VisibleLength(s string) int

VisibleLength returns the number of visible characters in a string, excluding ANSI escape codes.

This properly counts UTF-8 characters (runes) rather than bytes, so emoji and other multi-byte characters count as 1.

Example:

VisibleLength("\x1b[31mRed\x1b[0m") → 3
VisibleLength("Hello 🌙") → 7

type AgentSubscriber

AgentSubscriber writes one flat JSON line per lifecycle event to stdout. No ANSI, no human framing — designed for programmatic consumption.

type AgentSubscriber struct{}

func NewAgentSubscriber

func NewAgentSubscriber() *AgentSubscriber

NewAgentSubscriber creates a new AgentSubscriber.

func (*AgentSubscriber) Close

func (a *AgentSubscriber) Close()

Close implements the Subscriber interface.

func (*AgentSubscriber) OnEvent

func (a *AgentSubscriber) OnEvent(event events.Event)

OnEvent handles an incoming event and writes a JSONL record.

type AnimationFrames

AnimationFrames manages animation frames for the mooncake character.

type AnimationFrames struct {
    // contains filtered or unexported fields
}

func LoadEmbeddedFrames

func LoadEmbeddedFrames() (*AnimationFrames, error)

LoadEmbeddedFrames loads animation frames from the embedded content.

func LoadFramesFromFile

func LoadFramesFromFile(path string) (*AnimationFrames, error)

LoadFramesFromFile loads animation frames from a file. Frames are expected to be 3 lines each, separated by blank lines.

func LoadFramesFromString

func LoadFramesFromString(content string) (*AnimationFrames, error)

LoadFramesFromString loads animation frames from a string. Frames are expected to be 3 lines each, separated by blank lines.

func (*AnimationFrames) Current

func (a *AnimationFrames) Current() []string

Current returns the current frame without advancing

func (*AnimationFrames) FrameCount

func (a *AnimationFrames) FrameCount() int

FrameCount returns the total number of frames

func (*AnimationFrames) Next

func (a *AnimationFrames) Next() []string

Next advances to the next frame and returns it

type BufferSnapshot

BufferSnapshot is an atomic snapshot of the buffer state for rendering.

type BufferSnapshot struct {
    StepHistory   []StepEntry
    CurrentStep   string
    Progress      ProgressInfo
    DebugMessages []string
    ErrorMessages []string
    Completion    *ExecutionStats
}

type ConsoleLogger

ConsoleLogger implements Logger interface with colored console output.

type ConsoleLogger struct {
    // contains filtered or unexported fields
}

func NewConsoleLogger

func NewConsoleLogger(logLevel int) *ConsoleLogger

NewConsoleLogger creates a ConsoleLogger directly (for type-specific needs).

func (*ConsoleLogger) Codef

func (l *ConsoleLogger) Codef(format string, v ...interface{})

Codef logs a code snippet message.

func (*ConsoleLogger) Complete

func (l *ConsoleLogger) Complete(stats ExecutionStats)

Complete logs the execution completion summary with statistics.

func (*ConsoleLogger) Debugf

func (l *ConsoleLogger) Debugf(format string, v ...interface{})

Debugf logs a debug message.

func (*ConsoleLogger) Errorf

func (l *ConsoleLogger) Errorf(format string, v ...interface{})

Errorf logs an error message.

func (*ConsoleLogger) Infof

func (l *ConsoleLogger) Infof(format string, v ...interface{})

Infof logs an informational message.

func (*ConsoleLogger) LogStep

func (l *ConsoleLogger) LogStep(info StepInfo)

LogStep logs a step execution with status.

func (*ConsoleLogger) Mooncake

func (l *ConsoleLogger) Mooncake()

Mooncake displays the mooncake banner.

func (*ConsoleLogger) SetLogLevel

func (l *ConsoleLogger) SetLogLevel(logLevel int)

SetLogLevel sets the logging level for the logger.

func (*ConsoleLogger) SetLogLevelStr

func (l *ConsoleLogger) SetLogLevelStr(logLevel string) error

SetLogLevelStr sets the logging level from a string value.

func (*ConsoleLogger) SetRedactor

func (l *ConsoleLogger) SetRedactor(redactor Redactor)

SetRedactor sets the redactor for automatic sensitive data redaction.

func (*ConsoleLogger) Textf

func (l *ConsoleLogger) Textf(format string, v ...interface{})

Textf logs a plain text message.

func (*ConsoleLogger) WithPadLevel

func (l *ConsoleLogger) WithPadLevel(padLevel int) Logger

WithPadLevel creates a new logger with the specified padding level.

type ConsoleSubscriber

ConsoleSubscriber implements event-based console logging

type ConsoleSubscriber struct {
    // contains filtered or unexported fields
}

func NewConsoleSubscriber

func NewConsoleSubscriber(logLevel int, logFormat string, streamOutput bool) *ConsoleSubscriber

NewConsoleSubscriber creates a new console subscriber. streamOutput=false matches the historical `mooncake apply` UX (step-start/end markers only at info; shell stdout/stderr only at debug). `mooncake task` constructs with streamOutput=true.

func (*ConsoleSubscriber) Close

func (c *ConsoleSubscriber) Close()

Close implements the Subscriber interface

func (*ConsoleSubscriber) OnEvent

func (c *ConsoleSubscriber) OnEvent(event events.Event)

OnEvent handles incoming events

func (*ConsoleSubscriber) SetRedactor

func (c *ConsoleSubscriber) SetRedactor(r interface{ Redact(string) string })

SetRedactor sets the redactor for sensitive data

type DiscardLogger

DiscardLogger implements Logger by ignoring every call.

Use it on a production code path that needs to satisfy the Logger interface but has no place to surface the output. The MCP server's best-effort plan-inspection calls (internal/mcp/tools.go) are the motivating case: InspectPlan logs are noise to the LLM client and dropping them avoids reaching for NewTestLogger (which retains every entry in a Logs slice — see F022).

type DiscardLogger struct{}

func NewDiscardLogger

func NewDiscardLogger() *DiscardLogger

NewDiscardLogger returns a Logger that drops every entry.

func (DiscardLogger) Codef

func (DiscardLogger) Codef(string, ...interface{})

func (DiscardLogger) Complete

func (DiscardLogger) Complete(ExecutionStats)

func (DiscardLogger) Debugf

func (DiscardLogger) Debugf(string, ...interface{})

func (DiscardLogger) Errorf

func (DiscardLogger) Errorf(string, ...interface{})

func (DiscardLogger) Infof

func (DiscardLogger) Infof(string, ...interface{})

func (DiscardLogger) LogStep

func (DiscardLogger) LogStep(StepInfo)

func (DiscardLogger) Mooncake

func (DiscardLogger) Mooncake()

func (DiscardLogger) SetLogLevel

func (DiscardLogger) SetLogLevel(int)

func (DiscardLogger) SetLogLevelStr

func (DiscardLogger) SetLogLevelStr(string) error

func (DiscardLogger) SetRedactor

func (DiscardLogger) SetRedactor(Redactor)

func (DiscardLogger) Textf

func (DiscardLogger) Textf(string, ...interface{})

func (DiscardLogger) WithPadLevel

func (d DiscardLogger) WithPadLevel(int) Logger

type ExecutionStats

ExecutionStats contains execution statistics.

type ExecutionStats struct {
    Duration time.Duration
    Executed int
    Skipped  int
    Failed   int
}

type FirstRunHintSubscriber

FirstRunHintSubscriber prints a single line of next-step guidance after the first successful `mooncake apply` on a host. It is a one-shot: once the marker file \~/.mooncake/.first-run-completed exists, the subscriber is a no-op. Spec 40 §"First-run hint".

Suppression rules: - Marker file already exists. - The run failed (we don't celebrate failures). - Output format is anything other than text (`agent`, `json`, `quiet`) so the hint cannot corrupt downstream parsers. - MOONCAKE_NO_HINTS=1 in the environment.

type FirstRunHintSubscriber struct {
    // contains filtered or unexported fields
}

func NewFirstRunHintSubscriber

func NewFirstRunHintSubscriber(out io.Writer, outputFormat string) *FirstRunHintSubscriber

NewFirstRunHintSubscriber returns a subscriber that prints the hint to out (typically os.Stdout) on the first successful run. outputFormat is the CLI's --output-format value; the hint is only printed when it is empty or "text".

func (*FirstRunHintSubscriber) Close

func (s *FirstRunHintSubscriber) Close()

Close implements the Subscriber interface.

func (*FirstRunHintSubscriber) OnEvent

func (s *FirstRunHintSubscriber) OnEvent(event events.Event)

OnEvent prints the hint when the run completes successfully and no marker exists. Marker creation and printing are best-effort: a failure to write the marker just means the hint may print again next run.

type LogEntry

LogEntry represents a single log entry.

type LogEntry struct {
    Level   string
    Message string
}

type Logger

Logger interface defines the logging contract.

type Logger interface {
    Infof(format string, v ...interface{})
    Debugf(format string, v ...interface{})
    Errorf(format string, v ...interface{})
    Codef(format string, v ...interface{})
    Textf(format string, v ...interface{})
    Mooncake()
    SetLogLevel(logLevel int)
    SetLogLevelStr(logLevel string) error
    WithPadLevel(padLevel int) Logger
    LogStep(info StepInfo)
    Complete(stats ExecutionStats)
    SetRedactor(redactor Redactor)
}

func NewLogger

func NewLogger(logLevel int) Logger

NewLogger creates a new ConsoleLogger with the specified log level.

type ProgressInfo

ProgressInfo tracks overall execution progress.

type ProgressInfo struct {
    Current int
    Total   int
}

type QuietSubscriber

QuietSubscriber suppresses all output except failures and the final recap. Designed for CI pipelines and scripting where only failures matter.

type QuietSubscriber struct {
    // contains filtered or unexported fields
}

func NewQuietSubscriber

func NewQuietSubscriber() *QuietSubscriber

NewQuietSubscriber creates a new QuietSubscriber.

func (*QuietSubscriber) Close

func (q *QuietSubscriber) Close()

Close implements the Subscriber interface.

func (*QuietSubscriber) OnEvent

func (q *QuietSubscriber) OnEvent(event events.Event)

OnEvent handles an incoming event.

type Redactor

Redactor interface for redacting sensitive data in logs.

type Redactor interface {
    Redact(string) string
}

type RunLogSubscriber

RunLogSubscriber appends a compact run record to \~/.mooncake/runs.jsonl on EventRunCompleted. Write failures are silently dropped so they never fail a run.

type RunLogSubscriber struct {
    // contains filtered or unexported fields
}

func NewRunLogSubscriber

func NewRunLogSubscriber(configPath string) *RunLogSubscriber

NewRunLogSubscriber creates a subscriber that records runs under the given config basename.

func (*RunLogSubscriber) Close

func (r *RunLogSubscriber) Close()

Close implements the Subscriber interface.

func (*RunLogSubscriber) OnEvent

func (r *RunLogSubscriber) OnEvent(event events.Event)

OnEvent handles incoming events.

type StderrErrorSubscriber

StderrErrorSubscriber writes a structured JSON error line to stderr on every step failure, regardless of the active output format.

type StderrErrorSubscriber struct {
    // contains filtered or unexported fields
}

func NewStderrErrorSubscriber

func NewStderrErrorSubscriber() *StderrErrorSubscriber

NewStderrErrorSubscriber creates a subscriber that writes to os.Stderr.

func (*StderrErrorSubscriber) Close

func (s *StderrErrorSubscriber) Close()

Close implements the Subscriber interface.

func (*StderrErrorSubscriber) OnEvent

func (s *StderrErrorSubscriber) OnEvent(event events.Event)

OnEvent handles incoming events.

type StepEntry

StepEntry represents a single step in the execution history.

type StepEntry struct {
    Name      string
    Status    string // "success", "error", "skipped", "running"
    Level     int    // Nesting level for indentation
    Timestamp time.Time
}

type StepInfo

StepInfo contains structured information about a step execution.

type StepInfo struct {
    Name       string
    Level      int    // Nesting level for indentation
    GlobalStep int    // Cumulative step number
    Status     string // "running", "success", "error", "skipped"
}

type TUIBuffer

TUIBuffer manages step history and message buffering.

type TUIBuffer struct {
    // contains filtered or unexported fields
}

func NewTUIBuffer

func NewTUIBuffer(historySize int) *TUIBuffer

NewTUIBuffer creates a new TUI buffer with specified history size.

func (*TUIBuffer) AddDebug

func (b *TUIBuffer) AddDebug(message string)

AddDebug adds a debug message to the buffer.

func (*TUIBuffer) AddError

func (b *TUIBuffer) AddError(message string)

AddError adds an error message to the buffer.

func (*TUIBuffer) AddStep

func (b *TUIBuffer) AddStep(entry StepEntry)

AddStep adds a step to the history (circular buffer).

func (*TUIBuffer) GetSnapshot

func (b *TUIBuffer) GetSnapshot() BufferSnapshot

GetSnapshot returns an atomic snapshot of the buffer state.

func (*TUIBuffer) SetCompletion

func (b *TUIBuffer) SetCompletion(stats ExecutionStats)

SetCompletion sets execution completion statistics.

func (*TUIBuffer) SetCurrentStep

func (b *TUIBuffer) SetCurrentStep(name string, progress ProgressInfo)

SetCurrentStep sets the currently executing step.

type TUIDisplay

TUIDisplay handles screen rendering for the animated TUI.

type TUIDisplay struct {
    // contains filtered or unexported fields
}

func NewTUIDisplay

func NewTUIDisplay(animator *AnimationFrames, buffer *TUIBuffer, width, height int) *TUIDisplay

NewTUIDisplay creates a new TUI display renderer.

func (*TUIDisplay) Render

func (d *TUIDisplay) Render() string

Render generates the complete screen output.

type TUILogger

TUILogger implements Logger interface with animated TUI display.

type TUILogger struct {
    // contains filtered or unexported fields
}

func NewTUILogger

func NewTUILogger(logLevel int) (*TUILogger, error)

NewTUILogger creates a new TUI logger.

func (*TUILogger) Codef

func (l *TUILogger) Codef(format string, v ...interface{})

Codef logs formatted code.

func (*TUILogger) Complete

func (l *TUILogger) Complete(stats ExecutionStats)

Complete logs the execution completion summary with statistics.

func (*TUILogger) Debugf

func (l *TUILogger) Debugf(format string, v ...interface{})

Debugf logs a debug message.

func (*TUILogger) Errorf

func (l *TUILogger) Errorf(format string, v ...interface{})

Errorf logs an error message.

func (*TUILogger) Infof

func (l *TUILogger) Infof(_ string, _ ...interface{})

Infof logs an info message (ignored in TUI mode - use LogStep for steps).

func (*TUILogger) LogStep

func (l *TUILogger) LogStep(info StepInfo)

LogStep handles structured step logging.

func (*TUILogger) Mooncake

func (l *TUILogger) Mooncake()

Mooncake displays the mooncake banner (initializes display).

func (*TUILogger) SetLogLevel

func (l *TUILogger) SetLogLevel(logLevel int)

SetLogLevel sets the log level.

func (*TUILogger) SetLogLevelStr

func (l *TUILogger) SetLogLevelStr(logLevel string) error

SetLogLevelStr sets the log level from a string.

func (*TUILogger) SetRedactor

func (l *TUILogger) SetRedactor(redactor Redactor)

SetRedactor sets the redactor for automatic sensitive data redaction.

func (*TUILogger) Start

func (l *TUILogger) Start()

Start begins the animation and rendering loop.

func (*TUILogger) Stop

func (l *TUILogger) Stop()

Stop stops the animation and shows final render.

func (*TUILogger) Textf

func (l *TUILogger) Textf(format string, v ...interface{})

Textf logs plain text.

func (*TUILogger) WithPadLevel

func (l *TUILogger) WithPadLevel(padLevel int) Logger

WithPadLevel creates a new logger with the specified padding level.

type TUISubscriber

TUISubscriber implements event-based TUI display.

type TUISubscriber struct {
    // contains filtered or unexported fields
}

func NewTUISubscriber

func NewTUISubscriber(logLevel int) (*TUISubscriber, error)

NewTUISubscriber creates a new TUI subscriber.

func (*TUISubscriber) Close

func (t *TUISubscriber) Close()

Close implements the Subscriber interface.

func (*TUISubscriber) OnEvent

func (t *TUISubscriber) OnEvent(event events.Event)

OnEvent handles incoming events.

func (*TUISubscriber) SetRedactor

func (t *TUISubscriber) SetRedactor(r Redactor)

SetRedactor sets the redactor for sensitive data.

func (*TUISubscriber) Start

func (t *TUISubscriber) Start()

Start begins the animation and rendering loop.

func (*TUISubscriber) Stop

func (t *TUISubscriber) Stop()

Stop stops the animation and shows final render.

type TerminalInfo

TerminalInfo contains information about terminal capabilities.

type TerminalInfo struct {
    IsTerminal   bool
    SupportsANSI bool
    Width        int
    Height       int
}

func DetectTerminal

func DetectTerminal() TerminalInfo

DetectTerminal detects terminal capabilities and returns terminal information.

type TestLogger

TestLogger implements Logger interface and captures log output for testing.

type TestLogger struct {
    Logs []LogEntry
    // contains filtered or unexported fields
}

func NewTestLogger

func NewTestLogger() *TestLogger

NewTestLogger creates a new TestLogger for use in tests.

func (*TestLogger) Clear

func (t *TestLogger) Clear()

Clear removes all log entries.

func (*TestLogger) Codef

func (t *TestLogger) Codef(format string, v ...interface{})

Codef logs a code snippet message.

func (*TestLogger) Complete

func (t *TestLogger) Complete(stats ExecutionStats)

Complete logs the execution completion summary with statistics.

func (*TestLogger) Contains

func (t *TestLogger) Contains(substr string) bool

Contains checks if any log message contains the substring.

func (*TestLogger) ContainsLevel

func (t *TestLogger) ContainsLevel(level, substr string) bool

ContainsLevel checks if any log at the specified level contains the substring.

func (*TestLogger) Count

func (t *TestLogger) Count() int

Count returns the number of log entries.

func (*TestLogger) CountLevel

func (t *TestLogger) CountLevel(level string) int

CountLevel returns the number of log entries at the specified level.

func (*TestLogger) Debugf

func (t *TestLogger) Debugf(format string, v ...interface{})

Debugf logs a debug message.

func (*TestLogger) Errorf

func (t *TestLogger) Errorf(format string, v ...interface{})

Errorf logs an error message.

func (*TestLogger) GetLogs

func (t *TestLogger) GetLogs() []LogEntry

GetLogs returns a copy of all log entries.

func (*TestLogger) Infof

func (t *TestLogger) Infof(format string, v ...interface{})

Infof logs an informational message.

func (*TestLogger) LogStep

func (t *TestLogger) LogStep(info StepInfo)

LogStep logs a step execution with status.

func (*TestLogger) Mooncake

func (t *TestLogger) Mooncake()

Mooncake displays the mooncake banner.

func (*TestLogger) SetLogLevel

func (t *TestLogger) SetLogLevel(logLevel int)

SetLogLevel sets the logging level for the logger.

func (*TestLogger) SetLogLevelStr

func (t *TestLogger) SetLogLevelStr(logLevel string) error

SetLogLevelStr sets the logging level from a string value.

func (*TestLogger) SetRedactor

func (t *TestLogger) SetRedactor(redactor Redactor)

SetRedactor sets the redactor for automatic sensitive data redaction.

func (*TestLogger) Textf

func (t *TestLogger) Textf(format string, v ...interface{})

Textf logs a plain text message.

func (*TestLogger) WithPadLevel

func (t *TestLogger) WithPadLevel(padLevel int) Logger

WithPadLevel creates a new logger with the specified padding level.

Generated by gomarkdoc