services

package
v1.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 29, 2024 License: Apache-2.0 Imports: 47 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrMissingConfig = errors.New("config is missing")
	ErrMissingApiKey = errors.New("apiKey is missing")
)
View Source 
var GetQueueURL = func(c context.Context, api SQSSendMessageAPI, input *sqs.GetQueueUrlInput) (*sqs.GetQueueUrlOutput, error) {
	return api.GetQueueUrl(c, input)
}
View Source 
var SendMsg = func(c context.Context, api SQSSendMessageAPI, input *sqs.SendMessageInput) (*sqs.SendMessageOutput, error) {
	return api.SendMessage(c, input)
}

Functions

func NewConsoleService 

func NewConsoleService(stdout io.Writer) *consoleService

func NewEmailService 

func NewEmailService(opts EmailOptions) *emailService

Types

type AlertmanagerNotification 

type AlertmanagerNotification struct {
	Labels       map[string]string `json:"labels"`
	Annotations  map[string]string `json:"annotations"`
	GeneratorURL string            `json:"generatorURL"`
	StartsAt     time.Time         `json:"startsAt"`
}

AlertmanagerNotification message body is similar to Prometheus alertmanager postableAlert model

func (AlertmanagerNotification) GetTemplater 

func (n AlertmanagerNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

GetTemplater parse text template

type AlertmanagerOptions 

type AlertmanagerOptions struct {
	Targets            []string   `json:"targets"`
	Scheme             string     `json:"scheme"`
	APIPath            string     `json:"apiPath"`
	BasicAuth          *BasicAuth `json:"basicAuth"`
	BearerToken        string     `json:"bearerToken"`
	InsecureSkipVerify bool       `json:"insecureSkipVerify"`
	Timeout            int        `json:"timeout"`
}

AlertmanagerOptions cluster configuration

type AwsAccess 

type AwsAccess struct {
	Key    string `json:"key"`
	Secret string `json:"secret"`
}

type AwsSqsNotification 

type AwsSqsNotification struct {
	MessageAttributes map[string]string `json:"messageAttributes"`
	MessageGroupId    string            `json:"messageGroupId,omitempty"`
}

func (*AwsSqsNotification) GetTemplater 

func (n *AwsSqsNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type AwsSqsOptions 

type AwsSqsOptions struct {
	Queue       string `json:"queue"`
	Account     string `json:"account"`
	Region      string `json:"region"`
	EndpointUrl string `json:"endpointUrl,omitempty"`
	AwsAccess
}

type BasicAuth 

type BasicAuth struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type Destination 

type Destination struct {
	Service   string `json:"service"`
	Recipient string `json:"recipient"`
}

Destination holds notification destination details

type Destinations 

type Destinations map[string][]Destination

Destinations holds notification destinations group by trigger

func (Destinations) Dedup 

func (s Destinations) Dedup() Destinations

func (Destinations) Merge 

func (s Destinations) Merge(other Destinations)

type EmailNotification 

type EmailNotification struct {
	Subject string `json:"subject,omitempty"`
	Body    string `json:"body,omitempty"`
}

func (*EmailNotification) GetTemplater 

func (n *EmailNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type EmailOptions 

type EmailOptions struct {
	Host               string `json:"host"`
	Port               int    `json:"port"`
	InsecureSkipVerify bool   `json:"insecure_skip_verify"`
	Username           string `json:"username"`
	Password           string `json:"password"`
	From               string `json:"from"`
	Html               bool   `json:"html"`
}

type GitHubDeployment 

type GitHubDeployment struct {
	State                string   `json:"state,omitempty"`
	Environment          string   `json:"environment,omitempty"`
	EnvironmentURL       string   `json:"environmentURL,omitempty"`
	LogURL               string   `json:"logURL,omitempty"`
	RequiredContexts     []string `json:"requiredContexts"`
	AutoMerge            *bool    `json:"autoMerge,omitempty"`
	TransientEnvironment *bool    `json:"transientEnvironment,omitempty"`
	Reference            string   `json:"reference,omitempty"`
}

type GitHubNotification 

type GitHubNotification struct {
	Status             *GitHubStatus             `json:"status,omitempty"`
	Deployment         *GitHubDeployment         `json:"deployment,omitempty"`
	PullRequestComment *GitHubPullRequestComment `json:"pullRequestComment,omitempty"`
	RepoURLPath        string                    `json:"repoURLPath,omitempty"`
	RevisionPath       string                    `json:"revisionPath,omitempty"`
	// contains filtered or unexported fields
}

func (*GitHubNotification) GetTemplater 

func (g *GitHubNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type GitHubOptions 

type GitHubOptions struct {
	AppID             interface{} `json:"appID"`
	InstallationID    interface{} `json:"installationID"`
	PrivateKey        string      `json:"privateKey"`
	EnterpriseBaseURL string      `json:"enterpriseBaseURL"`
}

type GitHubPullRequestComment 

type GitHubPullRequestComment struct {
	Content string `json:"content,omitempty"`
}

type GitHubStatus 

type GitHubStatus struct {
	State     string `json:"state,omitempty"`
	Label     string `json:"label,omitempty"`
	TargetURL string `json:"targetURL,omitempty"`
}

type GoogleChatNotification 

type GoogleChatNotification struct {
	Cards     string `json:"cards"`
	CardsV2   string `json:"cardsV2"`
	ThreadKey string `json:"threadKey,omitempty"`
}

func (*GoogleChatNotification) GetTemplater 

func (n *GoogleChatNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type GoogleChatOptions 

type GoogleChatOptions struct {
	WebhookUrls map[string]string `json:"webhooks"`
}

type GrafanaAnnotation 

type GrafanaAnnotation struct {
	Time     int64    `json:"time"` // unix ts in ms
	IsRegion bool     `json:"isRegion"`
	Tags     []string `json:"tags"`
	Text     string   `json:"text"`
}

type GrafanaOptions 

type GrafanaOptions struct {
	ApiUrl             string `json:"apiUrl"`
	ApiKey             string `json:"apiKey"`
	InsecureSkipVerify bool   `json:"insecureSkipVerify"`
}
type Header struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type MattermostNotification 

type MattermostNotification struct {
	Attachments string `json:"attachments,omitempty"`
}

func (*MattermostNotification) GetTemplater 

func (n *MattermostNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type MattermostOptions 

type MattermostOptions struct {
	ApiURL             string `json:"apiURL"`
	Token              string `json:"token"`
	InsecureSkipVerify bool   `json:"insecureSkipVerify"`
}

type NewrelicNotification 

type NewrelicNotification struct {
	Revision    string `json:"revision"`
	Changelog   string `json:"changelog,omitempty"`
	Description string `json:"description,omitempty"`
	User        string `json:"user,omitempty"`
}

func (*NewrelicNotification) GetTemplater 

func (n *NewrelicNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type NewrelicOptions 

type NewrelicOptions struct {
	ApiKey string `json:"apiKey"`
	ApiURL string `json:"apiURL"`
}

type Notification 

type Notification struct {
	Message      string                    `json:"message,omitempty"`
	AwsSqs       *AwsSqsNotification       `json:"awssqs,omitempty"`
	Email        *EmailNotification        `json:"email,omitempty"`
	Slack        *SlackNotification        `json:"slack,omitempty"`
	Mattermost   *MattermostNotification   `json:"mattermost,omitempty"`
	RocketChat   *RocketChatNotification   `json:"rocketchat,omitempty"`
	Teams        *TeamsNotification        `json:"teams,omitempty"`
	Webhook      WebhookNotifications      `json:"webhook,omitempty"`
	Opsgenie     *OpsgenieNotification     `json:"opsgenie,omitempty"`
	GitHub       *GitHubNotification       `json:"github,omitempty"`
	Alertmanager *AlertmanagerNotification `json:"alertmanager,omitempty"`
	GoogleChat   *GoogleChatNotification   `json:"googlechat,omitempty"`
	Pagerduty    *PagerDutyNotification    `json:"pagerduty,omitempty"`
	PagerdutyV2  *PagerDutyV2Notification  `json:"pagerdutyv2,omitempty"`
	Newrelic     *NewrelicNotification     `json:"newrelic,omitempty"`
}

func (*Notification) GetTemplater 

func (n *Notification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

func (*Notification) Preview 

func (n *Notification) Preview() string

type NotificationService 

type NotificationService interface {
	Send(notification Notification, dest Destination) error
}

NotificationService defines notification service interface

func NewAlertmanagerService 

func NewAlertmanagerService(opts AlertmanagerOptions) NotificationService

NewAlertmanagerService new service

func NewAwsSqsService 

func NewAwsSqsService(opts AwsSqsOptions) NotificationService

func NewGitHubService 

func NewGitHubService(opts GitHubOptions) (NotificationService, error)

func NewGoogleChatService 

func NewGoogleChatService(opts GoogleChatOptions) NotificationService

func NewGrafanaService 

func NewGrafanaService(opts GrafanaOptions) NotificationService

func NewMattermostService 

func NewMattermostService(opts MattermostOptions) NotificationService

func NewNewrelicService 

func NewNewrelicService(opts NewrelicOptions) NotificationService

func NewOpsgenieService 

func NewOpsgenieService(opts OpsgenieOptions) NotificationService

func NewPagerdutyService 

func NewPagerdutyService(opts PagerdutyOptions) NotificationService

func NewPagerdutyV2Service 

func NewPagerdutyV2Service(opts PagerdutyV2Options) NotificationService

func NewPushoverService 

func NewPushoverService(opts PushoverOptions) NotificationService

func NewRocketChatService 

func NewRocketChatService(opts RocketChatOptions) NotificationService

func NewService 

func NewService(serviceType string, optsData []byte) (NotificationService, error)

func NewSlackService 

func NewSlackService(opts SlackOptions) NotificationService

func NewTeamsService 

func NewTeamsService(opts TeamsOptions) NotificationService

func NewTelegramService 

func NewTelegramService(opts TelegramOptions) NotificationService

func NewWebexService 

func NewWebexService(opts WebexOptions) NotificationService

func NewWebhookService 

func NewWebhookService(opts WebhookOptions) NotificationService

type OpsgenieNotification 

type OpsgenieNotification struct {
	Description string `json:"description"`
	Priority    string `json:"priority,omitempty"`
	Alias       string `json:"alias,omitempty"`
	Note        string `json:"note,omitempty"`
}

func (*OpsgenieNotification) GetTemplater 

func (n *OpsgenieNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type OpsgenieOptions 

type OpsgenieOptions struct {
	ApiUrl  string            `json:"apiUrl"`
	ApiKeys map[string]string `json:"apiKeys"`
}

type PagerDutyNotification 

type PagerDutyNotification struct {
	Title      string `json:"title"`
	Body       string `json:"body,omitempty"`
	Urgency    string `json:"urgency,omitempty"`
	PriorityId string `json:"priorityId,omitempty"`
}

func (*PagerDutyNotification) GetTemplater 

func (p *PagerDutyNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type PagerDutyV2Notification 

type PagerDutyV2Notification struct {
	Summary   string `json:"summary"`
	Severity  string `json:"severity"`
	Source    string `json:"source"`
	Component string `json:"component,omitempty"`
	Group     string `json:"group,omitempty"`
	Class     string `json:"class,omitempty"`
	URL       string `json:"url"`
}

func (*PagerDutyV2Notification) GetTemplater 

func (p *PagerDutyV2Notification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type PagerdutyOptions 

type PagerdutyOptions struct {
	Token     string `json:"token"`
	From      string `json:"from,omitempty"`
	ServiceID string `json:"serviceId"`
}

type PagerdutyV2Options 

type PagerdutyV2Options struct {
	ServiceKeys map[string]string `json:"serviceKeys"`
}

type PushoverOptions 

type PushoverOptions struct {
	Token string `json:"token"`
}

type RocketChatNotification 

type RocketChatNotification struct {
	Attachments string `json:"attachments,omitempty"`
}

func (*RocketChatNotification) GetTemplater 

func (n *RocketChatNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type RocketChatOptions 

type RocketChatOptions struct {
	Alias     string `json:"alias"`
	Email     string `json:"email"`
	Password  string `json:"password"`
	Icon      string `json:"icon"`
	Avatar    string `json:"avatar"`
	ServerUrl string `json:"serverUrl"`
}

type SQSSendMessageAPI 

type SQSSendMessageAPI interface {
	GetQueueUrl(ctx context.Context,
		params *sqs.GetQueueUrlInput,
		optFns ...func(*sqs.Options)) (*sqs.GetQueueUrlOutput, error)

	SendMessage(ctx context.Context,
		params *sqs.SendMessageInput,
		optFns ...func(*sqs.Options)) (*sqs.SendMessageOutput, error)
}

type SlackNotification 

type SlackNotification struct {
	Attachments     string                   `json:"attachments,omitempty"`
	Blocks          string                   `json:"blocks,omitempty"`
	GroupingKey     string                   `json:"groupingKey"`
	NotifyBroadcast bool                     `json:"notifyBroadcast"`
	DeliveryPolicy  slackutil.DeliveryPolicy `json:"deliveryPolicy"`
}

func (*SlackNotification) GetTemplater 

func (n *SlackNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type SlackOptions 

type SlackOptions struct {
	Username           string   `json:"username"`
	Icon               string   `json:"icon"`
	Token              string   `json:"token"`
	SigningSecret      string   `json:"signingSecret"`
	Channels           []string `json:"channels"`
	InsecureSkipVerify bool     `json:"insecureSkipVerify"`
	ApiURL             string   `json:"apiURL"`
	DisableUnfurl      bool     `json:"disableUnfurl"`
}

type TeamsNotification 

type TeamsNotification struct {
	Template        string `json:"template,omitempty"`
	Title           string `json:"title,omitempty"`
	Summary         string `json:"summary,omitempty"`
	Text            string `json:"text,omitempty"`
	ThemeColor      string `json:"themeColor,omitempty"`
	Facts           string `json:"facts,omitempty"`
	Sections        string `json:"sections,omitempty"`
	PotentialAction string `json:"potentialAction,omitempty"`
}

func (*TeamsNotification) GetTemplater 

func (n *TeamsNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type TeamsOptions 

type TeamsOptions struct {
	RecipientUrls map[string]string `json:"recipientUrls"`
}

type TelegramOptions 

type TelegramOptions struct {
	Token string `json:"token"`
}

type Templater 

type Templater func(notification *Notification, vars map[string]interface{}) error

type TemplaterSource 

type TemplaterSource interface {
	GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)
}

type WebexOptions 

type WebexOptions struct {
	Token  string `json:"token"`
	ApiURL string `json:"apiURL"`
}

type WebhookNotification 

type WebhookNotification struct {
	Method string `json:"method"`
	Body   string `json:"body"`
	Path   string `json:"path"`
}

type WebhookNotifications 

type WebhookNotifications map[string]WebhookNotification

func (WebhookNotifications) GetTemplater 

func (n WebhookNotifications) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type WebhookOptions 

type WebhookOptions struct {
	URL                string        `json:"url"`
	Headers            []Header      `json:"headers"`
	BasicAuth          *BasicAuth    `json:"basicAuth"`
	InsecureSkipVerify bool          `json:"insecureSkipVerify"`
	RetryWaitMin       time.Duration `json:"retryWaitMin"`
	RetryWaitMax       time.Duration `json:"retryWaitMax"`
	RetryMax           int           `json:"retryMax"`
}

Source Files

View all Source files

Directories

Path Synopsis
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.