observability

type CLIHooks ¶

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

CLIHooks implements basecamp.Hooks for CLI observability. It supports configurable verbosity levels:

• 0: Silent (collect stats only, no output)
• 1: Operations only (log SDK operations)
• 2: Operations + requests (log both operations and HTTP requests)

func NewCLIHooks(level int, collector *SessionCollector, writer *TraceWriter) *CLIHooks

func (h *CLIHooks) Level() int

func (h *CLIHooks) OnOperationEnd(ctx context.Context, op basecamp.OperationInfo, err error, duration time.Duration)

func (h *CLIHooks) OnOperationStart(ctx context.Context, op basecamp.OperationInfo) context.Context

func (h *CLIHooks) OnRequestEnd(ctx context.Context, info basecamp.RequestInfo, result basecamp.RequestResult)

func (h *CLIHooks) OnRequestStart(ctx context.Context, info basecamp.RequestInfo) context.Context

func (h *CLIHooks) OnRetry(ctx context.Context, info basecamp.RequestInfo, attempt int, err error)

func (h *CLIHooks) SetLevel(level int)

type OperationMetrics ¶

type OperationMetrics struct {
	Service      string // e.g., "Todos", "Projects"
	Operation    string // e.g., "Complete", "List"
	ResourceType string // e.g., "todo", "project"
	IsMutation   bool
	ResourceID   int64
	Duration     time.Duration
	Error        error
}

OperationMetrics holds timing information for a high-level SDK operation.

type RequestMetrics ¶

type RequestMetrics struct {
	Method     string
	URL        string
	Attempt    int
	StatusCode int
	Duration   time.Duration
	FromCache  bool
	Retryable  bool
	Error      error
}

RequestMetrics holds timing and status information for a single HTTP request.

type RetryMetrics ¶

type RetryMetrics struct {
	Method  string
	URL     string
	Attempt int
	Error   error
}

RetryMetrics records a retry event.

type SessionCollector ¶

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

SessionCollector accumulates metrics across a CLI session. It is safe for concurrent use and uses counters instead of unbounded slices.

func NewSessionCollector() *SessionCollector

func (c *SessionCollector) RecordOperation(m OperationMetrics)

func (c *SessionCollector) RecordOperationFromSDK(op basecamp.OperationInfo, err error, duration time.Duration)

func (c *SessionCollector) RecordRequest(m RequestMetrics)

func (c *SessionCollector) RecordRequestFromSDK(info basecamp.RequestInfo, result basecamp.RequestResult)

func (c *SessionCollector) RecordRetry(_ RetryMetrics)

func (c *SessionCollector) RecordRetryFromSDK(info basecamp.RequestInfo, attempt int, err error)

func (c *SessionCollector) Reset()

func (c *SessionCollector) Summary() SessionMetrics

type SessionMetrics ¶

type SessionMetrics struct {
	StartTime       time.Time
	EndTime         time.Time
	TotalRequests   int
	CacheHits       int
	CacheMisses     int
	TotalOperations int
	FailedOps       int
	TotalRetries    int
	TotalLatency    time.Duration
}

SessionMetrics aggregates metrics for an entire CLI session.

func SessionMetricsFromMap(stats map[string]any) *SessionMetrics

func (m *SessionMetrics) FormatParts() []string

type TraceWriter ¶

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

TraceWriter outputs human-readable trace information to stderr. It formats output with timestamps relative to session start.

func NewTraceWriter() *TraceWriter

func NewTraceWriterTo(w io.Writer) *TraceWriter

func (t *TraceWriter) Reset()

func (t *TraceWriter) WriteOperationEnd(op basecamp.OperationInfo, err error, duration time.Duration)

func (t *TraceWriter) WriteOperationStart(op basecamp.OperationInfo)

func (t *TraceWriter) WriteRequestEnd(info basecamp.RequestInfo, result basecamp.RequestResult)

func (t *TraceWriter) WriteRequestStart(info basecamp.RequestInfo)

func (t *TraceWriter) WriteRetry(info basecamp.RequestInfo, attempt int, err error)