eventreporter

package module

v0.1.5 Latest Latest Go to latest Published: Nov 13, 2023 License: AGPL-3.0 Imports: 9 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

The event reporter is a pluggable library for reporting on events.

GNU Affero General Public License v3.0 (GNU AGPLv3)
Copyright © 2021 Yale University

This section is empty.

This section is empty.

This section is empty.

type EmailReporter struct {
	Address string
	Auth    smtp.Auth
	To      []string
	From    string
}

EmailReporter wraps up the configuration needed for sending email events

func NewEmailReporter(options map[string]string) (*EmailReporter, error)

NewEmailReporter takes a map of options and produces a reporter that can send email message events

func (r *EmailReporter) Report(e Event) error

Report sends an email event

type Event struct {
	Message string
	Level   Level
}

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type Level uint32

const (
	DEBUG Level = iota
	INFO
	WARN
	ERROR
)

type Reporter interface {
	Report(Event) error
}

func New(name string, config map[string]string) (Reporter, error)

type SlackReporter struct {
	Endpoint string
	Token    string
	Channel  string
	Username string
	Icon     string
	Client   HTTPClient
}

func NewSlackReporter(options map[string]string) (*SlackReporter, error)

func (r *SlackReporter) Report(e Event) error