renderer

type BaseDir ¶

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

BaseDir renders the directory of the executable relative to the current working directory and is typically useful for specifying where to save log files

Example:

"filename": "${basedir}/logs/debug.log"

func (*BaseDir) IsDynamic() bool

func (bd *BaseDir) Write(info event.Info, w io.Writer) (int, error)

type DateTime ¶

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

func (dt *DateTime) CreateLayoutRenderer(parameters map[string]string) (LayoutRenderer, error)

func (*DateTime) IsDynamic() bool

func (dt *DateTime) Write(info event.Info, w io.Writer) (int, error)

type LayoutFunc ¶

type LayoutFunc func(event.Info, io.Writer) (int, error)

The LayoutFunc type is an adapter to allow the use of ordinary functions as layout renderers. If f is a function with the appropriate signature, LayoutFunc(f) is a LayoutRenderer that calls f.

func (f LayoutFunc) IsDynamic() bool

func (f LayoutFunc) Write(info event.Info, w io.Writer) (int, error)

type LayoutRenderer ¶

type LayoutRenderer interface {
	// Write takes the information in info and writes it to w.  The return values are
	// the number of bytes written and any error that occurred.
	Write(info event.Info, w io.Writer) (int, error)
	// IsDynamic returns false if the data written by Write is static throughout the
	// course of the applications lifetime. It returns true otherwise.
	IsDynamic() bool
}

LayoutRenderer is the interface that wraps a layout renderer.

When creating custom renderers, this is the interface that needs to be implemented.

type LayoutRendererWithParameters ¶

type LayoutRendererWithParameters interface {
	CreateLayoutRenderer(parameters map[string]string) (LayoutRenderer, error)
}

LayoutRendererWithParameters is the interface which wraps a LayoutRenderer factory such that parameters can be specified in the layout

Custom LayoutRenderers will typically also implement this interface if its behaviour can be customized

type Renderer ¶

type Renderer interface {
	// Render returns a string rendered from info based on the template provided to New
	Render(info event.Info) string
}

Renderer is the interface that wraps a specific template

func New(template string) (Renderer, error)