exporter

Documentation

Index

• type Exporter
• type LogExporter
  • func NewLogExporter(name string) *LogExporter
  • func (l LogExporter) Name() string
  • func (l LogExporter) Send(msg *formatter.Message) error
• type MailgunExporter
  • func NewMailgunExporter(name string, recipients string, from string, apiKey string) *MailgunExporter
  • func (m MailgunExporter) Name() string
  • func (m MailgunExporter) Send(msg *formatter.Message) error
• type SNSExporter
  • func NewSNSExporter(name string, client *api.SNSService, topicARN string) *SNSExporter
  • func (s SNSExporter) Name() string
  • func (s SNSExporter) Send(msg *formatter.Message) error
• type SlackService
  • func NewSlackExporter(name string, token string, channel string) *SlackService
  • func (s *SlackService) BuildMessageBlock(msg *formatter.Message) []slack.Block
  • func (s *SlackService) GenerateTextBlock(text string) slack.Block
  • func (s SlackService) Name() string
  • func (s *SlackService) PostMessage(blocks ...slack.Block) (string, string, error)
  • func (s SlackService) Send(msg *formatter.Message) error

Types

type Exporter

type Exporter interface {
	// Send implements payload transmission for each exporter
	Send(msg *formatter.Message) error
	// Name retruns exporter name
	Name() string
}

Exporter defines a common interface for different exporters

type LogExporter

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

LogExporter is a dummy exporter which prints formatted message to stdout. For debug and educational purposes.

func NewLogExporter

func NewLogExporter(name string) *LogExporter

NewLogExporter .

func (LogExporter) Name

func (l LogExporter) Name() string

Name .

func (LogExporter) Send

func (l LogExporter) Send(msg *formatter.Message) error

Send prints message to stdout

type MailgunExporter

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

MailgunExporter lets you send reports via email

func NewMailgunExporter

func NewMailgunExporter(name string, recipients string, from string, apiKey string) *MailgunExporter

NewMailgunExporter .

func (MailgunExporter) Name

func (m MailgunExporter) Name() string

Name .

func (MailgunExporter) Send

func (m MailgunExporter) Send(msg *formatter.Message) error

Send sends report via Mailgun

type SNSExporter

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

SNSExporter publishes message to SNS topic as json

func NewSNSExporter

func NewSNSExporter(name string, client *api.SNSService, topicARN string) *SNSExporter

NewSNSExporter .

func (SNSExporter) Name

func (s SNSExporter) Name() string

Name .

func (SNSExporter) Send

func (s SNSExporter) Send(msg *formatter.Message) error

Send publishes report to an arbitrary SNS topic in json format

type SlackService

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

SlackService data structure for storing slack client related data

func NewSlackExporter

func NewSlackExporter(name string, token string, channel string) *SlackService

NewSlackExporter populates a new SlackService instance

func (*SlackService) BuildMessageBlock

func (s *SlackService) BuildMessageBlock(msg *formatter.Message) []slack.Block

BuildMessageBlock constructs severity related message body

func (*SlackService) GenerateTextBlock

func (s *SlackService) GenerateTextBlock(text string) slack.Block

GenerateTextBlock returns a slack SectionBlock for text input

func (SlackService) Name

func (s SlackService) Name() string

Name .

func (*SlackService) PostMessage

func (s *SlackService) PostMessage(blocks ...slack.Block) (string, string, error)

PostMessage sends provided slack MessageBlocks to the given slack channel

func (SlackService) Send

func (s SlackService) Send(msg *formatter.Message) error

Send sends report to an arbitrary Slack channel