cloudwatch

README

This is a Go library to treat CloudWatch Log streams as io.Writers and io.Readers.

Usage

group := NewGroup("group", cloudwatchlogs.New(defaults.DefaultConfig))
w, err := group.Create("stream")

io.WriteString(w, "Hello World")

r, err := group.Open("stream")
io.Copy(os.Stdout, r)

Documentation

Index

• type Group
  • func NewGroup(group string, client *cloudwatchlogs.CloudWatchLogs) *Group
  • func (g *Group) Create(stream string) (io.Writer, error)
  • func (g *Group) Open(stream string) (io.Reader, error)
• type Reader
  • func NewReader(group, stream string, client *cloudwatchlogs.CloudWatchLogs) *Reader
  • func (r *Reader) Read(b []byte) (int, error)
• type RejectedLogEventsInfoError
  • func (e *RejectedLogEventsInfoError) Error() string
• type Writer
  • func NewWriter(group, stream string, client *cloudwatchlogs.CloudWatchLogs) *Writer
  • func (w *Writer) Close() error
  • func (w *Writer) Flush() error
  • func (w *Writer) Write(b []byte) (int, error)

Types

type Group

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

Group wraps a log stream group and provides factory methods for creating readers and writers for streams.

func NewGroup

func NewGroup(group string, client *cloudwatchlogs.CloudWatchLogs) *Group

NewGroup returns a new Group instance.

func (*Group) Create

func (g *Group) Create(stream string) (io.Writer, error)

Create creates a log stream in the group and returns an io.Writer for it.

func (*Group) Open

func (g *Group) Open(stream string) (io.Reader, error)

Open returns an io.Reader to read from the log stream.

type Reader

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

Reader is an io.Reader implementation that streams log lines from cloudwatch logs.

func NewReader

func NewReader(group, stream string, client *cloudwatchlogs.CloudWatchLogs) *Reader

func (*Reader) Read

func (r *Reader) Read(b []byte) (int, error)

type RejectedLogEventsInfoError

type RejectedLogEventsInfoError struct {
	Info *cloudwatchlogs.RejectedLogEventsInfo
}

func (*RejectedLogEventsInfoError) Error

func (e *RejectedLogEventsInfoError) Error() string

type Writer

type Writer struct {
	sync.Mutex // This protects calls to flush.
	// contains filtered or unexported fields
}

Writer is an io.Writer implementation that writes lines to a cloudwatch logs stream.

The writer will only flush log events every 1 second or when the buffer becomes full according to the following from http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html

The maximum batch size is 1,048,576 bytes, and this size is calculated
as the sum of all event messages in UTF-8, plus 26 bytes for each log
event.

func NewWriter

func NewWriter(group, stream string, client *cloudwatchlogs.CloudWatchLogs) *Writer

func (*Writer) Close

func (w *Writer) Close() error

Closes the writer. Any subsequent calls to Write will return io.ErrClosedPipe.

func (*Writer) Flush

func (w *Writer) Flush() error

Flush flushes the events that are currently buffered.

func (*Writer) Write

func (w *Writer) Write(b []byte) (int, error)

Write takes b, and creates cloudwatch log events for each individual line. If Flush returns an error, subsequent calls to Write will fail.