logger

package
v1.4.2-0...-705e031 Latest Latest
Warning

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

 Go to latest Published: Mar 9, 2017 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package logger defines interfaces that logger drivers implement to log messages.

The other half of a logger driver is the implementation of the factory, which holds the contextual instance information that allows multiple loggers of the same type to perform different actions, such as logging to different locations.

Index

Constants

View Source 
const (
	// TimeFormat is the time format used for timestamps sent to log readers.
	TimeFormat = jsonlog.RFC3339NanoFixed
)

Variables

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

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

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 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(srcs map[string]io.Reader, dst Logger) *Copier

NewCopier creates a new Copier

func (*Copier) Close 

func (c *Copier) Close()

Close closes the copier

func (*Copier) Run 

func (c *Copier) Run()

Run starts logs copying

func (*Copier) Wait 

func (c *Copier) Wait()

Wait waits until all copying is done

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 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.

func (LogAttributes) String 

func (a LogAttributes) String() string

type LogOptValidator 

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

LogOptValidator checks the options specific to the underlying logging implementation.

type LogReader 

type LogReader interface {
	// Read logs from underlying logging backend
	ReadLogs(ReadConfig) *LogWatcher
}

LogReader is the interface for reading log messages for loggers that support reading.

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) 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.

type Logger 

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

Logger is the interface for docker logging drivers.

func NewRingLogger 

func NewRingLogger(driver Logger, logInfo Info, maxSize int64) Logger

NewRingLogger creates a new Logger that is implemented as a RingBuffer wrapping the passed in logger.

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
	Tail   int
	Follow bool
}

ReadConfig is the configuration passed into ReadLogs.

type RingLogger 

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

RingLogger is a ring buffer that implements the Logger interface. This is used when lossy logging is OK.

func (*RingLogger) Close 

func (r *RingLogger) Close() error

Close closes the logger

func (*RingLogger) Log 

func (r *RingLogger) Log(msg *Message) error

Log queues messages into the ring buffer

func (*RingLogger) Name 

func (r *RingLogger) Name() string

Name returns the name of the underlying logger

Source Files

View all Source files

Directories

Path Synopsis
Package awslogs provides the logdriver for forwarding container logs to Amazon CloudWatch Logs
 Package awslogs provides the logdriver for forwarding container logs to Amazon CloudWatch Logs
Package etwlogs provides a log driver for forwarding container logs as ETW events.(ETW stands for Event Tracing for Windows) A client can then create an ETW listener to listen for events that are sent by the ETW provider that we register, using the provider's GUID "a3693192-9ed6-46d2-a981-f8226c8363bd".
 Package etwlogs provides a log driver for forwarding container logs as ETW events.(ETW stands for Event Tracing for Windows) A client can then create an ETW listener to listen for events that are sent by the ETW provider that we register, using the provider's GUID "a3693192-9ed6-46d2-a981-f8226c8363bd".
Package fluentd provides the log driver for forwarding server logs to fluentd endpoints.
 Package fluentd provides the log driver for forwarding server logs to fluentd endpoints.
Package gelf provides the log driver for forwarding server logs to endpoints that support the Graylog Extended Log Format.
 Package gelf provides the log driver for forwarding server logs to endpoints that support the Graylog Extended Log Format.
Package journald provides the log driver for forwarding server logs to endpoints that receive the systemd format.
 Package journald provides the log driver for forwarding server logs to endpoints that receive the systemd format.
Package jsonfilelog provides the default Logger implementation for Docker logging.
 Package jsonfilelog provides the default Logger implementation for Docker logging.
Package logentries provides the log driver for forwarding server logs to logentries endpoints.
 Package logentries provides the log driver for forwarding server logs to logentries endpoints.
Package splunk provides the log driver for forwarding server logs to Splunk HTTP Event Collector endpoint.
 Package splunk provides the log driver for forwarding server logs to Splunk HTTP Event Collector endpoint.
Package syslog provides the logdriver for forwarding server logs to syslog endpoints.
 Package syslog provides the logdriver for forwarding server logs to syslog endpoints.

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.