cloudwatch

README

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

Usage

group := AttachGroup("group", cloudwatchlogs.New(defaults.DefaultConfig))
w, err := group.AttachStream("stream")

fmt.Fprintln(w, "Hello World")

w.Flush()

or

group := AttachGroup("group", cloudwatchlogs.New(defaults.DefaultConfig))
w, err := group.AttachStream("stream")

io.WriteString(w, "Hello World")

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

Dependencies

This library depends on aws-sdk-go.

Documentation

Index

• type Group
  • func AttachGroup(group string, client *cloudwatchlogs.CloudWatchLogs) (*Group, error)
  • func (g *Group) AttachStream(stream string) (*Writer, error)
  • func (g *Group) Open(stream string) (*Reader, error)
• type Reader
  • func NewReader(group, stream string, client cloudwatchlogsiface.CloudWatchLogsAPI) *Reader
  • func (r *Reader) Read(b []byte) (int, error)
• type RejectedLogEventsInfoError
  • func (e *RejectedLogEventsInfoError) Error() string
• type Writer
  • func NewWriter(group, stream string, client cloudwatchlogsiface.CloudWatchLogsAPI) *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 AttachGroup

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

AttachGroup creates a reference to a log group.

If the group already exists, it is used. If the group doesn't exist, it is created.

func (*Group) AttachStream

func (g *Group) AttachStream(stream string) (*Writer, error)

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

If the requested stream doesn't exist, it is created. If the requested stream already exists, the requested stream is used.

func (*Group) Open

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

Open returns an 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 cloudwatchlogsiface.CloudWatchLogsAPI) *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.

func NewWriter

func NewWriter(group, stream string, client cloudwatchlogsiface.CloudWatchLogsAPI) *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.