README
¶
logspout-cloudwatch
A Logspout adapter for writing Docker container logs to AWS CloudWatch.
Usage
Route logs from all containers to CloudWatch by starting logspout with the following options:
docker run --name=logspout --hostname=$HOSTNAME \
-e AWS_REGION=us-west-2 \
-v /var/run/docker.sock:/tmp/docker.sock
my-logspout-container cloudwatch://my-log-group
Once started, this container will create a new Log Stream ($HOSTNAME) within the specified Log Group (my-log-group) and begin streaming Docker container logs into CloudWatch.
This example depends on a custom Logspout container (my-logspout-container) built with the logspout-cloudwatch module and an existing CloudWatch Log Group (my-log-group). See gliderlabs/logspout#modules for more information on building custom logspout containers.
Configuration
logspout-cloudwatch accepts a number of environment variables that can be used to customize behavior.
AWS_REGION
Determines the AWS region to which logs will be sent. This option is required.
LOG_LEVEL
Determines the log level used for logspout-cloudwatch logs. This option defaults to INFO, and logspout-cloudwatch will only log startup information, information about failed uploads, and information about rejected events. Set this option to DEBUG for detailed information about each uploaded log batch.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewAdapter ¶
func NewAdapter(route *router.Route) (router.LogAdapter, error)
NewAdapter instances a new AWS CloudWatch adapter.
Types ¶
type Adapter ¶
type Adapter struct {
// contains filtered or unexported fields
}
Adapter ships logs to AWS CloudWatch.
type Batcher ¶
type Batcher struct {
// contains filtered or unexported fields
}
Batcher buffers messages on a channel until a flush is triggered.
func NewBatcher ¶
NewBatcher creates a Batcher that buffers message from the input channel to the output channel.
type LogMessage ¶
LogMessage represents a log message to be sent to CloudWatch.
func (*LogMessage) Body ¶
func (l *LogMessage) Body() string
Body returns a string representation of the log.
func (*LogMessage) Size ¶
func (l *LogMessage) Size() int
Size returns the size of the log message in bytes.
func (*LogMessage) Timestamp ¶
func (l *LogMessage) Timestamp() int64
Timestamp returns the number of milliseconds since the epoch.
type LogStream ¶
type LogStream struct {
Group *string
Stream *string
Token *string
// contains filtered or unexported fields
}
LogStream ships logs to AWS CloudWatch.
func NewLogStream ¶
NewLogStream instantiates a Logger.
func (*LogStream) Log ¶
func (s *LogStream) Log(logs []*cloudwatchlogs.InputLogEvent) error
Log submits a batch of logs to the LogStream.
Source Files
Directories