package
0.0.0-20241220035036-fbafc0f80254
Repository: https://github.com/aws/shim-loggers-for-containerd.git
Documentation: pkg.go.dev

# Packages

Package awslogs provides functionalities for integrating the awslogs logging driver with shim-loggers-for-containerd.
Package fluentd provides functionalities for integrating the fluentd logging driver with shim-loggers-for-containerd.
Package mock_logger is a generated GoMock package.
Package splunk provides functionalities for integrating the splunk logging driver with shim-loggers-for-containerd.

# Functions

NewBufferedLogger creates a logger with the provided LoggerOpt, a buffer with customized max size and a channel monitor if stdout and stderr pipes are closed.
NewInfo creates the placeholder info.
NewLogger creates a LogDriver with the provided LoggerOpt.
SetUIDAndGID sets UID and/or GID for current goroutine/process.
UpdateDockerConfigs updates the docker config fields to the logger info.
WithBufferSizeInBytes sets the buffer size of log driver.
WithConfig sets logger config of logger info.
WithInfo sets log driver's info.
WithMaxReadBytes sets how many bytes will be read from container pipe per iteration.
WithStderr sets log driver's stderr pipe.
WithStdout sets log driver's stdout pipe.
WithStream sets the actual stream of log driver.

# Constants

DaemonName represents the name of the shim logger daemon for containerd.
DefaultBufSizeInBytes provides a reasonable default for loggers that do not have an external limit to impose on log line size.
NonBlockingMode indicates the mode of logger which doesn't block on logging.

# Structs

DockerConfigs holds optional Docker configuration details.
GlobalArgs contains the essential arguments required for initializing the logger.
Logger is the basic struct for all log drivers.
WindowsArgs struct for Windows configuration.

# Interfaces

Client is a wrapper for docker logger's Log method, which is mostly used for testing purposes.
LogDriver is the interface for all log drivers.

# Type aliases

InfoOpt is a type of function that is used to update the values of fields in logger info for each driver.
Opt is a type of function that is used to update the values of fields in LoggerArgs.