jsonfilelog

Documentation

Overview

Package jsonfilelog provides the default Logger implementation for Docker logging. This logger logs to files on the host server in the JSON format.

Index

• Constants
• func New(ctx logger.Context) (logger.Logger, error)
• func ValidateLogOpt(cfg map[string]string) error
• type JSONFileLogger
  • func (l *JSONFileLogger) Close() error
  • func (l *JSONFileLogger) Log(msg *logger.Message) error
  • func (l *JSONFileLogger) LogPath() string
  • func (l *JSONFileLogger) Name() string
  • func (l *JSONFileLogger) ReadLogs(config logger.ReadConfig) *logger.LogWatcher

Constants

const (
	// Name is the name of the file that the jsonlogger logs to.
	Name = "json-file"
)

Functions

func New

func New(ctx logger.Context) (logger.Logger, error)

New creates new JSONFileLogger which writes to filename passed in on given context.

func ValidateLogOpt

func ValidateLogOpt(cfg map[string]string) error

ValidateLogOpt looks for json specific log options max-file & max-size.

Types

type JSONFileLogger

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

JSONFileLogger is Logger implementation for default Docker logging.

func (*JSONFileLogger) Close

func (l *JSONFileLogger) Close() error

Close closes underlying file and signals all readers to stop.

func (*JSONFileLogger) Log

func (l *JSONFileLogger) Log(msg *logger.Message) error

Log converts logger.Message to jsonlog.JSONLog and serializes it to file.

func (*JSONFileLogger) LogPath

func (l *JSONFileLogger) LogPath() string

LogPath returns the location the given json logger logs to.

func (*JSONFileLogger) Name

func (l *JSONFileLogger) Name() string

Name returns name of this logger.

func (*JSONFileLogger) ReadLogs

func (l *JSONFileLogger) ReadLogs(config logger.ReadConfig) *logger.LogWatcher

ReadLogs implements the logger's LogReader interface for the logs created by this driver.