log

Documentation

Overview

Package log provides logging utilities

Index

• func FlushRoutine(w io.Writer, rc io.Reader, stop chan struct{})
• func WriteAndFlush(w io.Writer, reader *bufio.Reader) error
• type CloseOpts
• type MultiWriter
  • func (m *MultiWriter) Write(p []byte) (int, error)
• type SocketWriter
• type Streamer
  • func NewStreamer(opts StreamerOptions) *Streamer
  • func (s *Streamer) Close(opts ...CloseOpts) error
  • func (s *Streamer) Error(res *res.ErrResponse)
  • func (s *Streamer) GetSocketWriter() (io.Writer, error)
  • func (s *Streamer) Println(a ...interface{})
  • func (s *Streamer) Success(res *res.MsgResponse)
• type StreamerOptions
• type WebSocketWriter
  • func NewWebSocketTextWriter(socket SocketWriter) *WebSocketWriter
  • func (w *WebSocketWriter) Close() error
  • func (w *WebSocketWriter) Write(p []byte) (int, error)

Functions

func FlushRoutine

func FlushRoutine(w io.Writer, rc io.Reader, stop chan struct{})

FlushRoutine continuously writes everything in given ReadCloser to an io.Writer. Use this as a goroutine.

func WriteAndFlush

func WriteAndFlush(w io.Writer, reader *bufio.Reader) error

WriteAndFlush reads from buffer, writes to writer, and flushes if possible

Types

type CloseOpts

type CloseOpts struct {
	Message    string
	StatusCode int
}

CloseOpts defines options for closing the logger

type MultiWriter

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

MultiWriter writes to list of writers without caring whether one fails, and flushes if writer is flushable

func (*MultiWriter) Write

func (m *MultiWriter) Write(p []byte) (int, error)

type SocketWriter

type SocketWriter interface {
	WriteMessage(messageType int, bytes []byte) error
	CloseHandler() func(code int, text string) error
}

SocketWriter is an interface for writing to websocket connections

type Streamer

type Streamer struct {
	io.Writer
	// contains filtered or unexported fields
}

Streamer is a multilogger used by the daemon to pipe output to multiple places depending on context.

func NewStreamer

func NewStreamer(opts StreamerOptions) *Streamer

NewStreamer creates a new streamer. It must be closed if a Socket is provided, and one of Error() or Success() should be called.

func (*Streamer) Close

func (s *Streamer) Close(opts ...CloseOpts) error

Close shuts down the logger

func (*Streamer) Error

func (s *Streamer) Error(res *res.ErrResponse)

Error directs message and status to http.Error when appropriate

func (*Streamer) GetSocketWriter

func (s *Streamer) GetSocketWriter() (io.Writer, error)

GetSocketWriter retrieves the socketwriter as an io.Writer

func (*Streamer) Println

func (s *Streamer) Println(a ...interface{})

Println prints to logger's standard writer

func (*Streamer) Success

func (s *Streamer) Success(res *res.MsgResponse)

Success directs status to Header and sets content type when appropriate

type StreamerOptions

type StreamerOptions struct {
	Request    *http.Request
	Stdout     io.Writer
	Socket     SocketWriter
	HTTPWriter http.ResponseWriter
	HTTPStream bool
}

StreamerOptions defines configuration for a daemon streamer

type WebSocketWriter

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

WebSocketWriter wraps a SocketWriter in an io.Writer

func NewWebSocketTextWriter

func NewWebSocketTextWriter(socket SocketWriter) *WebSocketWriter

NewWebSocketTextWriter returns an io.Writer version of SocketWriter

func (*WebSocketWriter) Close

func (w *WebSocketWriter) Close() error

Close closes the socket writer's websocket.

func (*WebSocketWriter) Write

func (w *WebSocketWriter) Write(p []byte) (int, error)