Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterLogDriver(name string, c Creator) error
- func RegisterLogOptValidator(name string, l LogOptValidator) error
- func ValidateLogOpts(name string, cfg map[string]string) error
- type Context
- type Copier
- type Creator
- type LogOptValidator
- type LogReader
- type LogWatcher
- type Logger
- type Message
- type ReadConfig
Constants ¶
const ( // TimeFormat is the time format used for timestamps sent to log readers TimeFormat = timeutils.RFC3339NanoFixed )
Variables ¶
var ErrReadLogsNotSupported = errors.New("configured logging reader does not support reading")
ErrReadLogsNotSupported is returned when the logger does not support reading logs
Functions ¶
func RegisterLogDriver ¶
RegisterLogDriver registers the given logging driver builder with given logging driver name.
func RegisterLogOptValidator ¶ added in v0.327.0
func RegisterLogOptValidator(name string, l LogOptValidator) error
Types ¶
type Context ¶
type Context struct { Config map[string]string ContainerID string ContainerName string ContainerEntrypoint string ContainerArgs []string ContainerImageID string ContainerImageName string ContainerCreated time.Time LogPath string }
Context provides enough information for a logging driver to do its function
type Copier ¶
type Copier struct {
// contains filtered or unexported fields
}
Copier can copy logs from specified sources to Logger and attach ContainerID and Timestamp. Writes are concurrent, so you need implement some sync in your logger
type Creator ¶
Creator is a method that builds a logging driver instance with given context
func GetLogDriver ¶
GetLogDriver provides the logging driver builder for a logging driver name.
type LogOptValidator ¶ added in v0.327.0
LogOptValidator is a method that validates the log opts provided
type LogReader ¶ added in v0.327.0
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 ¶ added in v0.327.0
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 ¶ added in v0.327.0
func NewLogWatcher() *LogWatcher
NewLogWatcher returns a new LogWatcher.
func (*LogWatcher) Close ¶ added in v0.327.0
func (w *LogWatcher) Close()
Close notifies the underlying log reader to stop
func (*LogWatcher) WatchClose ¶ added in v0.327.0
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