observability

package

v0.6.7 Latest Latest Go to latest Published: Jan 2, 2026 License: MIT Imports: 7 Imported by: 0

Details

Package observability provides local file logging.

View Source

const HistoryFileName = "history.json"

HistoryFileName is the history file name

View Source

var HistoryFilePath = filepath.Join(LogDir, HistoryFileName)

HistoryFilePath is the full path to the history file

View Source

var LogDir = filepath.Join(os.Getenv("HOME"), ".yapi")

LogDir is the yapi data directory

func AddProvider(p Provider)

AddProvider registers a new observability provider

func Close()

Close flushes all providers

func Init(version, commit string)

Init initializes observability (file logging). Should be called once at startup with version info.

func Track(event string, props map[string]any)

Track sends an event to all registered providers

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

FileLoggerClient logs events to a file

func NewFileLoggerClient(path, version, commit string) (*FileLoggerClient, error)

NewFileLoggerClient creates a new file logger client

func (f *FileLoggerClient) Close() error

Close merges all tracked events and writes them to the log file.

func (f *FileLoggerClient) Track(event string, props map[string]any)

Track records an event with properties to be written on Close.

type Provider interface {
	Track(event string, props map[string]any)
	Close() error
}

Provider defines the behavior for any observability backend