chezmoilog

Documentation

Overview

Package chezmoilog contains support for chezmoi logging.

Index

• func AppendExitErrorAttrs(attrs []slog.Attr, err error) []slog.Attr
• func Bytes(key string, data []byte) slog.Attr
• func FirstFewBytes(key string, data []byte) slog.Attr
• func InfoOrError(logger *slog.Logger, msg string, err error, attrs ...slog.Attr)
• func InfoOrErrorContext(ctx context.Context, logger *slog.Logger, msg string, err error, ...)
• func LogCmdCombinedOutput(logger *slog.Logger, cmd *exec.Cmd) ([]byte, error)
• func LogCmdOutput(logger *slog.Logger, cmd *exec.Cmd) ([]byte, error)
• func LogCmdRun(logger *slog.Logger, cmd *exec.Cmd) error
• func LogCmdStart(logger *slog.Logger, cmd *exec.Cmd) error
• func LogCmdWait(logger *slog.Logger, cmd *exec.Cmd) error
• func LogHTTPRequest(ctx context.Context, logger *slog.Logger, client *http.Client, ...) (*http.Response, error)
• func Stringer(key string, value fmt.Stringer) slog.Attr
• type NullHandler
  • func (NullHandler) Enabled(context.Context, slog.Level) bool
  • func (NullHandler) Handle(context.Context, slog.Record) error
  • func (h NullHandler) WithAttrs([]slog.Attr) slog.Handler
  • func (h NullHandler) WithGroup(string) slog.Handler
• type OSExecCmdLogValuer
  • func (cmd OSExecCmdLogValuer) LogValuer() slog.Value
• type OSExecExitErrorLogValuer
  • func (err OSExecExitErrorLogValuer) LogValuer() slog.Value
• type OSProcessStateLogValuer
  • func (p OSProcessStateLogValuer) LogValue() slog.Value

Functions

func AppendExitErrorAttrs

func AppendExitErrorAttrs(attrs []slog.Attr, err error) []slog.Attr

func Bytes

func Bytes(key string, data []byte) slog.Attr

Bytes returns an slog.Attr with the value data.

func FirstFewBytes

func FirstFewBytes(key string, data []byte) slog.Attr

FirstFewBytes returns an slog.Attr with the value of the first few bytes of data.

func InfoOrError

func InfoOrError(logger *slog.Logger, msg string, err error, attrs ...slog.Attr)

func InfoOrErrorContext

func InfoOrErrorContext(ctx context.Context, logger *slog.Logger, msg string, err error, attrs ...slog.Attr)

func LogCmdCombinedOutput

func LogCmdCombinedOutput(logger *slog.Logger, cmd *exec.Cmd) ([]byte, error)

LogCmdCombinedOutput calls cmd.CombinedOutput, logs the result, and returns the result.

func LogCmdOutput

func LogCmdOutput(logger *slog.Logger, cmd *exec.Cmd) ([]byte, error)

LogCmdOutput calls cmd.Output, logs the result, and returns the result.

func LogCmdRun

func LogCmdRun(logger *slog.Logger, cmd *exec.Cmd) error

LogCmdRun calls cmd.Run, logs the result, and returns the result.

func LogCmdStart

func LogCmdStart(logger *slog.Logger, cmd *exec.Cmd) error

LogCmdStart calls cmd.Start, logs the result, and returns the result.

func LogCmdWait

func LogCmdWait(logger *slog.Logger, cmd *exec.Cmd) error

LogCmdWait calls cmd.Wait, logs the result, and returns the result.

func LogHTTPRequest

func LogHTTPRequest(ctx context.Context, logger *slog.Logger, client *http.Client, req *http.Request) (*http.Response, error)

LogHTTPRequest calls httpClient.Do, logs the result to logger, and returns the result.

func Stringer

func Stringer(key string, value fmt.Stringer) slog.Attr

Stringer returns an slog.Attr with value.

Types

type NullHandler

type NullHandler struct{}

A NullHandler implements log/slog.Handler and drops all output.

func (NullHandler) Enabled

func (NullHandler) Enabled(context.Context, slog.Level) bool

func (NullHandler) Handle

func (NullHandler) Handle(context.Context, slog.Record) error

func (NullHandler) WithAttrs

func (h NullHandler) WithAttrs([]slog.Attr) slog.Handler

func (NullHandler) WithGroup

func (h NullHandler) WithGroup(string) slog.Handler

type OSExecCmdLogValuer

type OSExecCmdLogValuer struct {
	*exec.Cmd
}

An OSExecCmdLogValuer wraps an *os/exec.Cmd and adds log/slog.LogValuer functionality.

func (OSExecCmdLogValuer) LogValuer

func (cmd OSExecCmdLogValuer) LogValuer() slog.Value

LogValuer implements log/slog.LogValuer.LogValue.

type OSExecExitErrorLogValuer

type OSExecExitErrorLogValuer struct {
	*exec.ExitError
}

An OSExecExitErrorLogValuer wraps an *os/exec.ExitError and adds log/slog.LogValuer.

func (OSExecExitErrorLogValuer) LogValuer

func (err OSExecExitErrorLogValuer) LogValuer() slog.Value

LogValuer implements log/slog.LogValuer.LogValue.

type OSProcessStateLogValuer

type OSProcessStateLogValuer struct {
	*os.ProcessState
}

An OSProcessStateLogValuer wraps an *os.ProcessState and adds log/slog.LogValuer functionality.

func (OSProcessStateLogValuer) LogValue

func (p OSProcessStateLogValuer) LogValue() slog.Value

LogValue implements log/slog.LogValuer.LogValue.