chezmoilog

Documentation

Overview

Package chezmoilog contains support for chezmoi logging.

Index

• func FirstFewBytes(data []byte) []byte
• func LogCmdCombinedOutput(cmd *exec.Cmd) ([]byte, error)
• func LogCmdOutput(cmd *exec.Cmd) ([]byte, error)
• func LogCmdRun(cmd *exec.Cmd) error
• func LogCmdStart(cmd *exec.Cmd) error
• func LogCmdWait(cmd *exec.Cmd) error
• func LogHTTPRequest(logger *zerolog.Logger, client *http.Client, req *http.Request) (*http.Response, error)
• func Output(data []byte, err error) []byte
• type OSExecCmdLogObject
  • func (cmd OSExecCmdLogObject) MarshalZerologObject(event *zerolog.Event)
• type OSExecExitErrorLogObject
  • func (err OSExecExitErrorLogObject) MarshalZerologObject(event *zerolog.Event)
• type OSProcessStateLogObject
  • func (p OSProcessStateLogObject) MarshalZerologObject(event *zerolog.Event)

Functions

func FirstFewBytes

func FirstFewBytes(data []byte) []byte

FirstFewBytes returns the first few bytes of data in a human-readable form.

func LogCmdCombinedOutput

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

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

func LogCmdOutput

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

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

func LogCmdRun

func LogCmdRun(cmd *exec.Cmd) error

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

func LogCmdStart

func LogCmdStart(cmd *exec.Cmd) error

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

func LogCmdWait

func LogCmdWait(cmd *exec.Cmd) error

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

func LogHTTPRequest

func LogHTTPRequest(logger *zerolog.Logger, client *http.Client, req *http.Request) (*http.Response, error)

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

func Output

func Output(data []byte, err error) []byte

Output returns the first few bytes of output if err is nil, otherwise it returns the full output.

Types

type OSExecCmdLogObject

type OSExecCmdLogObject struct {
	*exec.Cmd
}

An OSExecCmdLogObject wraps an *os/exec.Cmd and adds github.com/rs/zerolog.LogObjectMarshaler functionality.

func (OSExecCmdLogObject) MarshalZerologObject

func (cmd OSExecCmdLogObject) MarshalZerologObject(event *zerolog.Event)

MarshalZerologObject implements github.com/rs/zerolog.LogObjectMarshaler.MarshalZerologObject.

type OSExecExitErrorLogObject

type OSExecExitErrorLogObject struct {
	Err error
}

An OSExecExitErrorLogObject wraps an error and adds github.com/rs/zerolog.LogObjectMarshaler functionality if the wrapped error is an os/exec.ExitError.

func (OSExecExitErrorLogObject) MarshalZerologObject

func (err OSExecExitErrorLogObject) MarshalZerologObject(event *zerolog.Event)

MarshalZerologObject implements github.com/rs/zerolog.LogObjectMarshaler.MarshalZerologObject.

type OSProcessStateLogObject

type OSProcessStateLogObject struct {
	*os.ProcessState
}

An OSProcessStateLogObject wraps an *os.ProcessState and adds github.com/rs/zerolog.LogObjectMarshaler functionality.

func (OSProcessStateLogObject) MarshalZerologObject

func (p OSProcessStateLogObject) MarshalZerologObject(event *zerolog.Event)

MarshalZerologObject implements github.com/rs/zerolog.LogObjectMarshaler.MarshalZerologObject.