README
¶
Send Alert Notifications for Go Errors.
Notify when new error arrives.
Throttle notifications to avoid overwhelming your inbox.
Supports multiple Emails, MS Teams and proxy support.
Usage
go install github.com/rakutentech/go-alertnotification@latest
Configurations
This package use golang env variables as settings.
General Configs
| Env Variable | default | Description |
|---|---|---|
| APP_ENV | application environment to be appeared in email/teams message | |
| APP_NAME | application name to be appeared in email/teams message |
Email Configs
| Env Variable | default | Description |
|---|---|---|
| EMAIL_SENDER | required sender email address | |
| EMAIL_RECEIVERS | required receiver email addresses. Eg. test1@gmail.com,test2@gmail.com |
|
| EMAIL_ALERT_ENABLED | false | change to "true" to enable |
| SMTP_HOST | SMTP server hostname | |
| SMTP_PORT | SMTP server port | |
| EMAIL_USERNAME | SMTP username | |
| EMAIL_PASSWORD | SMTP password |
Ms Teams Configs
| Env Variable | default | Description |
|---|---|---|
| MS_TEAMS_WEBHOOK | required Ms Teams webhook. | |
| MS_TEAMS_ALERT_ENABLED | false | change to "true" to enable |
| MS_TEAMS_CARD_SUBJECT | MS teams card subject | |
| ALERT_CARD_SUBJECT | Alert MessageCard subject | |
| ALERT_THEME_COLOR | Themes color | |
| MS_TEAMS_PROXY_URL | Work behind corporate proxy |
Throttling Configs
| Env Variable | default | Explanation |
|---|---|---|
| THROTTLE_DURATION | 7 | throttling duration in minutes |
| THROTTLE_GRACE_SECONDS | 0 | throttling grace in seconds |
| THROTTLE_DISKCACHE_DIR | /tmp/cache/{APP_NAME}_throttler_disk_cache |
disk location for throttling |
| THROTTLE_ENABLED | true | Disable all together |
Usage
Simple
//import
import n "github.com/rakutentech/go-alertnotification"
err := errors.New("Alert me")
ignoringErrs := []error{errors.New("Ignore 001"), errors.New("Ignore 002")};
//Create New Alert
alert := n.NewAlert(err, ignoringErrs)
//Send notification
alert.Notify()
With customized fields
import n "github.com/rakutentech/go-alertnotification"
//Create expandos, can keep the field value as configured by removing that field from expandos
expandos := &n.Expandos{
EmailBody: "This is the customized email body",
EmailSubject: "This is the customized email subject",
MsTeamsCardSubject: "This is the customized MS Teams card summary",
MsTeamsAlertCardSubject: "This is the customized MS Teams card title",
MsTeamsError: "This is the customized MS Teams card error message",
}
//Create New Alert
alert := n.NewAlertWithExpandos(err, ignoringErr, expandos)
//Send notification
alert.Notify()
// To remove all current throttling
alert.RemoveCurrentThrotting()
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DoSendNotification ¶
func DoSendNotification(alert AlertNotification) error
DoSendNotification is to send the alert to the specified implemenation of the AlertNoticication interface
Types ¶
type Alert ¶
Alert struct for specify the ignoring error and the occuring error
func NewAlertWithExpandos ¶ added in v1.0.5
NewAlertWithExpandos creates Alert struct instance with expandos
func (*Alert) RemoveCurrentThrotting ¶
RemoveCurrentThrotting remove all current throttlings.
type AlertNotification ¶
type AlertNotification interface {
Send() error
}
AlertNotification is interface that all send notification function satify including send email
type EmailConfig ¶
type EmailConfig struct {
Username string
Password string
Host string
Port string
Sender string
EnvelopeFrom string
Receivers []string // Can use comma for multiple email
Subject string
ErrorObj error
Expandos *Expandos // can modify mail subject and content on demand
}
EmailConfig is email setting struct
func NewEmailConfig ¶
func NewEmailConfig(err error, expandos *Expandos) EmailConfig
NewEmailConfig create new EmailConfig struct
type ErrorOccurrence ¶
ErrorOccurrence store error time and error
type Expandos ¶ added in v1.0.5
type Expandos struct {
EmailBody string
EmailSubject string
MsTeamsAlertCardSubject string
MsTeamsCardSubject string
MsTeamsError string
}
Expandos struct for body and subject
type FactStruct ¶
FactStruct is sub-struct of SectionStruct
type MsTeam ¶
type MsTeam struct {
Type string `json:"@type"`
Context string `json:"@context"`
Summary string `json:"summary"`
ThemeColor string `json:"themeColor"`
Title string `json:"title"`
Sections []SectionStruct `json:"sections"`
}
MsTeam is MessageCard for Team notification
type SectionStruct ¶
type SectionStruct struct {
ActivityTitle string `json:"activityTitle"`
ActivitySubtitle string `json:"activitySubtitle"`
ActivityImage string `json:"activityImage"`
Facts []FactStruct `json:"facts"`
}
SectionStruct is sub-struct of MsTeam
type Throttler ¶
Throttler struct storing disckage directory and Throttling duration
func NewThrottler ¶
func NewThrottler() Throttler
NewThrottler constructs new Throttle struct and init diskcache directory
func (*Throttler) CleanThrottlingCache ¶
CleanThrottlingCache clean all the diskcache in throttling cache directory
func (*Throttler) InitGrace ¶ added in v1.1.2
ThrottleError throttle the alert within the limited duration
func (*Throttler) IsThrottledOrGraced ¶ added in v1.1.2
IsThrottled checks if the error has been throttled. If not, throttle it
func (*Throttler) ThrottleError ¶
ThrottleError throttle the alert within the limited duration
Source Files