logstreamer

README

logstreamer

Prefixes streams (e.g. stdout or stderr) in Go.

If you are executing a lot of (remote) commands, you may want to indent all of their output, prefix the loglines with hostnames, or mark anything that was thrown to stderr red, so you can spot errors more easily.

For this purpose, Logstreamer was written.

You pass 3 arguments to NewLogstreamer():

• Your *log.Logger
• Your desired prefix ("stdout" and "stderr" prefixed have special meaning)
• If the lines should be recorded true or false. This is useful if you want to retrieve any errors.

This returns an interface that you can point exec.Command's cmd.Stderr and cmd.Stdout to. All bytes that are written to it are split by newline and then prefixed to your specification.

Don't forget to call Flush() or Close() if the last line of the log might not end with a newline character!

A typical usage pattern looks like this:

// Create a logger (your app probably already has one)
logger := log.New(os.Stdout, "--> ", log.Ldate|log.Ltime)

// Setup a streamer that we'll pipe cmd.Stdout to
logStreamerOut := NewLogstreamer(logger, "stdout", false)
defer logStreamerOut.Close()
// Setup a streamer that we'll pipe cmd.Stderr to.
// We want to record/buffer anything that's written to this (3rd argument true)
logStreamerErr := NewLogstreamer(logger, "stderr", true)
defer logStreamerErr.Close()

// Execute something that succeeds
cmd := exec.Command(
	"ls",
	"-al",
)
cmd.Stderr = logStreamerErr
cmd.Stdout = logStreamerOut

// Reset any error we recorded
logStreamerErr.FlushRecord()

// Execute command
err := cmd.Start()

Test

$ cd src/pkg/logstreamer/
$ go test

Here I issue two local commands, ls -al and ls nonexisting:

Over at Transloadit we use it for streaming remote commands. Servers stream command output over SSH back to me, and every line is prefixed with a date, their hostname & marked red in case they wrote to stderr.

License

This project is licensed under the MIT license, see LICENSE.txt.

Documentation

Index

• type Logstreamer
  • func NewLogstreamer(logger *log.Logger, prefix string, record bool) *Logstreamer
  • func NewLogstreamerForStderr(prefix string) *Logstreamer
  • func NewLogstreamerForStdout(prefix string) *Logstreamer
  • func NewLogstreamerForWriter(prefix string, writer io.Writer) *Logstreamer
  • func (l *Logstreamer) Close() error
  • func (l *Logstreamer) Flush() error
  • func (l *Logstreamer) FlushRecord() string
  • func (l *Logstreamer) OutputLines() error
  • func (l *Logstreamer) Write(p []byte) (n int, err error)

Types

type Logstreamer

type Logstreamer struct {
	Logger *log.Logger
	// contains filtered or unexported fields
}

func NewLogstreamer

func NewLogstreamer(logger *log.Logger, prefix string, record bool) *Logstreamer

func NewLogstreamerForStderr

func NewLogstreamerForStderr(prefix string) *Logstreamer

func NewLogstreamerForStdout

func NewLogstreamerForStdout(prefix string) *Logstreamer

func NewLogstreamerForWriter

func NewLogstreamerForWriter(prefix string, writer io.Writer) *Logstreamer

func (*Logstreamer) Close

func (l *Logstreamer) Close() error

func (*Logstreamer) Flush

func (l *Logstreamer) Flush() error

func (*Logstreamer) FlushRecord

func (l *Logstreamer) FlushRecord() string

func (*Logstreamer) OutputLines

func (l *Logstreamer) OutputLines() error

func (*Logstreamer) Write

func (l *Logstreamer) Write(p []byte) (n int, err error)