implementations

Documentation

Index

• Constants
• Variables
• func FlyteEmailToSesEmailInput(email *admin.EmailMessage) ses.SendEmailInput
• func NewAwsEmailer(config runtimeInterfaces.NotificationsConfig, scope promutils.Scope, ...) interfaces.Emailer
• func NewEventsPublisher(pub pubsub.Publisher, scope promutils.Scope, eventTypes []string) interfaces.Publisher
• func NewGcpProcessor(sub pubsub.Subscriber, emailer interfaces.Emailer, scope promutils.Scope) interfaces.Processor
• func NewNoopEmail() interfaces.Emailer
• func NewNoopProcess() interfaces.Processor
• func NewNoopPublish() interfaces.Publisher
• func NewProcessor(sub pubsub.Subscriber, emailer interfaces.Emailer, scope promutils.Scope) interfaces.Processor
• func NewPublisher(pub pubsub.Publisher, scope promutils.Scope) interfaces.Publisher
• func NewSMTPEmailer(ctx context.Context, config runtimeInterfaces.NotificationsConfig, ...) interfaces.Emailer
• func NewSandboxProcessor(subChan <-chan []byte, emailer interfaces.Emailer) interfaces.Processor
• func NewSendGridEmailer(config runtimeInterfaces.NotificationsConfig, scope promutils.Scope) interfaces.Emailer
• type AwsEmailer
  • func (e *AwsEmailer) SendEmail(ctx context.Context, email *admin.EmailMessage) error
• type EventPublisher
  • func (p *EventPublisher) Publish(ctx context.Context, notificationType string, msg proto.Message) error
• type EventPublisherSystemMetrics
  • func NewEventPublisherSystemMetrics(scope promutils.Scope) EventPublisherSystemMetrics
• type ExternalEmailer
• type GcpProcessor
  • func (p *GcpProcessor) StartProcessing()
  • func (p *GcpProcessor) StopProcessing() error
• type NoopEmail
  • func (n *NoopEmail) SendEmail(ctx context.Context, email *admin.EmailMessage) error
• type NoopProcess
  • func (n *NoopProcess) StartProcessing()
  • func (n *NoopProcess) StopProcessing() error
• type NoopPublish
  • func (n *NoopPublish) Publish(ctx context.Context, notificationType string, msg proto.Message) error
• type Processor
  • func (p *Processor) StartProcessing()
  • func (p *Processor) StopProcessing() error
• type Publisher
  • func (p *Publisher) Publish(ctx context.Context, notificationType string, msg proto.Message) error
• type SMTPEmailer
  • func (s *SMTPEmailer) SendEmail(ctx context.Context, email *admin.EmailMessage) error
• type SandboxProcessor
  • func (p *SandboxProcessor) StartProcessing()
  • func (p *SandboxProcessor) StopProcessing() error
• type SandboxPublisher
  • func NewSandboxPublisher(pubChan chan<- []byte) *SandboxPublisher
  • func (p *SandboxPublisher) Publish(ctx context.Context, notificationType string, msg proto.Message) error
• type SendgridEmailer
  • func (s SendgridEmailer) SendEmail(ctx context.Context, email *admin.EmailMessage) error

Constants

const (
	Task          = "task"
	Node          = "node"
	Workflow      = "workflow"
	AllTypes      = "all"
	AllTypesShort = "*"
)

Variables

var SupportedEvents = map[string]string{
	Task:     proto.MessageName(&taskExecutionReq),
	Node:     proto.MessageName(&nodeExecutionReq),
	Workflow: proto.MessageName(&workflowExecutionReq),
}

Functions

func FlyteEmailToSesEmailInput

func FlyteEmailToSesEmailInput(email *admin.EmailMessage) ses.SendEmailInput

func NewAwsEmailer

func NewAwsEmailer(config runtimeInterfaces.NotificationsConfig, scope promutils.Scope, awsEmail sesiface.SESAPI) interfaces.Emailer

func NewEventsPublisher

func NewEventsPublisher(pub pubsub.Publisher, scope promutils.Scope, eventTypes []string) interfaces.Publisher

func NewGcpProcessor

func NewGcpProcessor(sub pubsub.Subscriber, emailer interfaces.Emailer, scope promutils.Scope) interfaces.Processor

func NewNoopEmail

func NewNoopEmail() interfaces.Emailer

func NewNoopProcess

func NewNoopProcess() interfaces.Processor

func NewNoopPublish

func NewNoopPublish() interfaces.Publisher

func NewProcessor

func NewProcessor(sub pubsub.Subscriber, emailer interfaces.Emailer, scope promutils.Scope) interfaces.Processor

func NewPublisher

func NewPublisher(pub pubsub.Publisher, scope promutils.Scope) interfaces.Publisher

func NewSMTPEmailer

func NewSMTPEmailer(ctx context.Context, config runtimeInterfaces.NotificationsConfig, scope promutils.Scope, sm core.SecretManager) interfaces.Emailer

func NewSandboxProcessor

func NewSandboxProcessor(subChan <-chan []byte, emailer interfaces.Emailer) interfaces.Processor

func NewSendGridEmailer

func NewSendGridEmailer(config runtimeInterfaces.NotificationsConfig, scope promutils.Scope) interfaces.Emailer

Types

type AwsEmailer

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

func (*AwsEmailer) SendEmail

func (e *AwsEmailer) SendEmail(ctx context.Context, email *admin.EmailMessage) error

type EventPublisher

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

TODO: Add a counter that encompasses the publisher stats grouped by project and domain.

func (*EventPublisher) Publish

func (p *EventPublisher) Publish(ctx context.Context, notificationType string, msg proto.Message) error

The key is the notification type as defined as an enum.

type EventPublisherSystemMetrics

type EventPublisherSystemMetrics struct {
	Scope          promutils.Scope
	PublishTotal   prometheus.Counter
	PublishSuccess prometheus.Counter
	PublishError   prometheus.Counter
}

func NewEventPublisherSystemMetrics

func NewEventPublisherSystemMetrics(scope promutils.Scope) EventPublisherSystemMetrics

type ExternalEmailer

type ExternalEmailer = string

const (
	Sendgrid ExternalEmailer = "sendgrid"
	SMTP     ExternalEmailer = "smtp"
)

type GcpProcessor

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

TODO: Add a counter that encompasses the publisher stats grouped by project and domain.

func (*GcpProcessor) StartProcessing

func (p *GcpProcessor) StartProcessing()

func (*GcpProcessor) StopProcessing

func (p *GcpProcessor) StopProcessing() error

type NoopEmail

type NoopEmail struct{}

Email to use when there is no email configuration.

func (*NoopEmail) SendEmail

func (n *NoopEmail) SendEmail(ctx context.Context, email *admin.EmailMessage) error

type NoopProcess

type NoopProcess struct{}

func (*NoopProcess) StartProcessing

func (n *NoopProcess) StartProcessing()

func (*NoopProcess) StopProcessing

func (n *NoopProcess) StopProcessing() error

type NoopPublish

type NoopPublish struct{}

func (*NoopPublish) Publish

func (n *NoopPublish) Publish(ctx context.Context, notificationType string, msg proto.Message) error

type Processor

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

TODO: Add a counter that encompasses the publisher stats grouped by project and domain.

func (*Processor) StartProcessing

func (p *Processor) StartProcessing()

Currently only email is the supported notification because slack and pagerduty both use email client to trigger those notifications. When Pagerduty and other notifications are supported, a publisher per type should be created.

func (*Processor) StopProcessing

func (p *Processor) StopProcessing() error

type Publisher

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

TODO: Add a counter that encompasses the publisher stats grouped by project and domain.

func (*Publisher) Publish

func (p *Publisher) Publish(ctx context.Context, notificationType string, msg proto.Message) error

The key is the notification type as defined as an enum.

type SMTPEmailer

type SMTPEmailer struct {
	CreateSMTPClientFunc func(connectString string) (interfaces.SMTPClient, error)
	// contains filtered or unexported fields
}

func (*SMTPEmailer) SendEmail

func (s *SMTPEmailer) SendEmail(ctx context.Context, email *admin.EmailMessage) error

type SandboxProcessor

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

func (*SandboxProcessor) StartProcessing

func (p *SandboxProcessor) StartProcessing()

func (*SandboxProcessor) StopProcessing

func (p *SandboxProcessor) StopProcessing() error

type SandboxPublisher

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

func NewSandboxPublisher

func NewSandboxPublisher(pubChan chan<- []byte) *SandboxPublisher

func (*SandboxPublisher) Publish

func (p *SandboxPublisher) Publish(ctx context.Context, notificationType string, msg proto.Message) error

type SendgridEmailer

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

func (SendgridEmailer) SendEmail

func (s SendgridEmailer) SendEmail(ctx context.Context, email *admin.EmailMessage) error