logrus_cloudwatchlogs_async

README

Asynchronous CloudWatch Logs hook for Logrus

Send Logrus logs to Amazon's CloudWatch Logs service.

Inspired by logrus-cloudwatchlogs, but it sends logs asynchronously, therefore it doesn't impair application performance. It can also handle the host temporarily going offline.

Example

package main

import (
	"os"

	"github.com/sirupsen/logrus"
	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/credentials"
	"github.com/szemate/logrus-cloudwatchlogs-async"
)

func main() {
	key := os.Getenv("AWS_ACCESS_KEY")
	secret := os.Getenv("AWS_SECRET_KEY")
	group := os.Getenv("AWS_CLOUDWATCHLOGS_GROUP_NAME")
	stream := os.Getenv("AWS_CLOUDWATCHLOGS_STREAM_NAME")

	cred := credentials.NewStaticCredentials(key, secret, "")
	cfg := aws.NewConfig().WithRegion("us-east-1").WithCredentials(cred)

	logger := logrus.New()

	hook, err := logrus_cloudwatchlogs_async.NewHook(group, stream, cfg)
	if err != nil {
		logger.Fatal(err)
	}
	logger.Hooks.Add(hook)

	logger.Fatal("Some fatal event")
}

Documentation

Index

• type Hook
  • func NewHook(groupName, streamName string, config *aws.Config) (*Hook, error)
  • func (hook *Hook) Fire(entry *logrus.Entry) error
  • func (hook *Hook) Levels() []logrus.Level
  • func (hook *Hook) StartSendingEvents()
  • func (hook *Hook) StopSendingEvents()

Types

type Hook

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

func NewHook

func NewHook(groupName, streamName string, config *aws.Config) (*Hook, error)

func (*Hook) Fire

func (hook *Hook) Fire(entry *logrus.Entry) error

Implements logrus.Hook interface

func (*Hook) Levels

func (hook *Hook) Levels() []logrus.Level

Implements logrus.Hook interface

func (*Hook) StartSendingEvents

func (hook *Hook) StartSendingEvents()

func (*Hook) StopSendingEvents

func (hook *Hook) StopSendingEvents()