logger

package
v0.0.0-...-a3a5c94 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 21, 2021 License: MIT Imports: 25 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrNeglectedContainer = fmt.Errorf("Neglected container")

ErrNeglectedContainer no defined logger name

View Source 
var ErrReadLogsNotSupported = errors.New("configured logging driver does not support reading")

ErrReadLogsNotSupported is returned when the logger does not support reading logs.

View Source 
var RFC3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00"

RFC3339NanoFixed time format

Functions

func PutMessage 

func PutMessage(msg *Message)

PutMessage puts the specified message back n the message pool. The message fields are reset before putting into the pool.

func RegisterLogDriver 

func RegisterLogDriver(name string, c Creator) error

RegisterLogDriver registers the given logging driver builder with given logging driver name.

func RegisterLogOptValidator 

func RegisterLogOptValidator(name string, l LogOptValidator) error

RegisterLogOptValidator registers the logging option validator with the given logging driver name.

func ValidateLogOpts 

func ValidateLogOpts(name string, cfg map[string]string) error

ValidateLogOpts checks the options for the given log driver. The options supported are specific to the LogDriver implementation.

Types

type ContainerEvent 

type ContainerEvent struct {
	Action    string
	Container types.ContainerJSON
}

ContainerEvent

type ContainerLog 

type ContainerLog struct {
	types.ContainerJSON
	LogCopier *Copier
	LogDriver []Logger
	// contains filtered or unexported fields
}

ContainerLog

func (*ContainerLog) Close 

func (container *ContainerLog) Close()

Close

func (*ContainerLog) Restart 

func (container *ContainerLog) Restart()

Restart

func (*ContainerLog) StartLogging 

func (container *ContainerLog) StartLogging() error

StartLogging start copy log

func (*ContainerLog) Stop 

func (container *ContainerLog) Stop()

Stop copying container log

type ContainerLogManage 

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

ContainerLogManage

func CreatContainerLogManage 

func CreatContainerLogManage(conf *option.Conf) *ContainerLogManage

CreatContainerLogManage

func (*ContainerLogManage) Start 

func (c *ContainerLogManage) Start() error

Start

func (*ContainerLogManage) Stop 

func (c *ContainerLogManage) Stop()

Stop all loggers

type ContainerLoggerConfig 

type ContainerLoggerConfig struct {
	Name    string
	Options map[string]string
}

ContainerLoggerConfig

type Copier 

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

Copier can copy logs from specified sources to Logger and attach Timestamp. Writes are concurrent, so you need implement some sync in your logger.

func NewCopier 

func NewCopier(logfile *LogFile, dst []Logger, since time.Time) *Copier

NewCopier

func (*Copier) Close 

func (c *Copier) Close()

Close closes the copier

func (*Copier) Run 

func (c *Copier) Run()

Run starts logs copying

type Creator 

type Creator func(Info) (Logger, error)

Creator builds a logging driver instance with given context.

func GetLogDriver 

func GetLogDriver(name string) (Creator, error)

GetLogDriver provides the logging driver builder for a logging driver name.

type GetTailReaderFunc 

type GetTailReaderFunc func(ctx context.Context, f SizeReaderAt, nLogLines int) (rdr io.Reader, nLines int, err error)

GetTailReaderFunc is used to truncate a reader to only read as much as is required in order to get the passed in number of log lines. It returns the sectioned reader, the number of lines that the section reader contains, and any error that occurs.

type Info 

type Info struct {
	Config              map[string]string
	ContainerID         string
	ContainerName       string
	ContainerEntrypoint string
	ContainerArgs       []string
	ContainerImageID    string
	ContainerImageName  string
	ContainerCreated    time.Time
	ContainerEnv        []string
	ContainerLabels     map[string]string
	LogPath             string
	DaemonName          string
}

Info provides enough information for a logging driver to do its function.

func (*Info) Command 

func (info *Info) Command() string

Command returns the command that the container being logged was started with. The Entrypoint is prepended to the container arguments.

func (*Info) ExtraAttributes 

func (info *Info) ExtraAttributes(keyMod func(string) string) map[string]string

ExtraAttributes returns the user-defined extra attributes (labels, environment variables) in key-value format. This can be used by log drivers that support metadata to add more context to a log.

func (*Info) FullID 

func (info *Info) FullID() string

FullID is an alias of ContainerID.

func (*Info) Hostname 

func (info *Info) Hostname() (string, error)

Hostname returns the hostname from the underlying OS.

func (*Info) ID 

func (info *Info) ID() string

ID Returns the Container ID shortened to 12 characters.

func (*Info) ImageFullID 

func (info *Info) ImageFullID() string

ImageFullID is an alias of ContainerImageID.

func (*Info) ImageID 

func (info *Info) ImageID() string

ImageID returns the ContainerImageID shortened to 12 characters.

func (*Info) ImageName 

func (info *Info) ImageName() string

ImageName is an alias of ContainerImageName

func (*Info) Name 

func (info *Info) Name() string

Name returns the ContainerName without a preceding '/'.

type LogAttributes 

type LogAttributes map[string]string

LogAttributes is used to hold the extra attributes available in the log message Primarily used for converting the map type to string and sorting.

type LogFile 

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

LogFile is Logger implementation for default Docker logging.

func NewLogFile 

func NewLogFile(logPath string, maxFiles int, compress bool, decodeFunc makeDecoderFunc, perms os.FileMode, getTailReader GetTailReaderFunc) (*LogFile, error)

NewLogFile creates new LogFile

func (*LogFile) Close 

func (w *LogFile) Close() error

Close file close

func (*LogFile) ReadLogs 

func (w *LogFile) ReadLogs(config ReadConfig, watcher *LogWatcher)

ReadLogs decodes entries from log files and sends them the passed in watcher

Note: Using the follow option can become inconsistent in cases with very frequent rotations and max log files is 1. TODO: Consider a different implementation which can effectively follow logs under frequent rotations.

type LogOptValidator 

type LogOptValidator func(cfg map[string]string) error

LogOptValidator checks the options specific to the underlying logging implementation.

type LogWatcher 

type LogWatcher struct {
	// For sending log messages to a reader.
	Msg chan *Message
	// For sending error messages that occur while while reading logs.
	Err chan error
	// contains filtered or unexported fields
}

LogWatcher is used when consuming logs read from the LogReader interface.

func NewLogWatcher 

func NewLogWatcher() *LogWatcher

NewLogWatcher returns a new LogWatcher.

func (*LogWatcher) Close 

func (w *LogWatcher) Close()

Close notifies the underlying log reader to stop.

func (*LogWatcher) ConsumerGone 

func (w *LogWatcher) ConsumerGone()

ConsumerGone notifies that the logs consumer is gone.

func (*LogWatcher) ProducerGone 

func (w *LogWatcher) ProducerGone()

ProducerGone notifies the underlying log reader that the logs producer (a container) is gone.

func (*LogWatcher) WatchClose 

func (w *LogWatcher) WatchClose() <-chan struct{}

WatchClose returns a channel receiver that receives notification when the watcher has been closed. This should only be called from one goroutine.

func (*LogWatcher) WatchConsumerGone 

func (w *LogWatcher) WatchConsumerGone() <-chan struct{}

WatchConsumerGone returns a channel receiver that receives notification when the log watcher consumer is gone.

func (*LogWatcher) WatchProducerGone 

func (w *LogWatcher) WatchProducerGone() <-chan struct{}

WatchProducerGone returns a channel receiver that receives notification once the logs producer (a container) is gone.

type Logger 

type Logger interface {
	Log(*Message) error
	Name() string
	Close() error
}

Logger is the interface for docker logging drivers.

type Message 

type Message struct {
	Line      []byte
	Source    string
	Timestamp time.Time
	Attrs     LogAttributes
	Partial   bool
}

Message is datastructure that represents piece of output produced by some container. The Line member is a slice of an array whose contents can be changed after a log driver's Log() method returns. Any changes made to this struct must also be updated in the `reset` function

func NewMessage 

func NewMessage() *Message

NewMessage returns a new message from the message sync.Pool

type ReadConfig 

type ReadConfig struct {
	Since  time.Time
	Until  time.Time
	Tail   int
	Follow bool
}

ReadConfig read log config

type SizeReaderAt 

type SizeReaderAt interface {
	io.ReaderAt
	Size() int64
}

SizeReaderAt defines a ReaderAt that also reports its size. This is used for tailing log files.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.