notify

Documentation

Index

• type CulpritNotifier
  • func GetDefaultNotifier(ctx context.Context, cfg *config.InstanceConfig, commitURLTemplate string) (CulpritNotifier, error)
• type DefaultCulpritNotifier
  • func (n *DefaultCulpritNotifier) NotifyAnomaliesFound(ctx context.Context, anomalies []*pb.Anomaly, ...) (string, error)
  • func (n *DefaultCulpritNotifier) NotifyCulpritFound(ctx context.Context, culprit *pb.Culprit, subscription *sub_pb.Subscription) (string, error)

Types

type CulpritNotifier

type CulpritNotifier interface {
	// Sends out notification to users about the detected culprit.
	NotifyCulpritFound(ctx context.Context, culprit *pb.Culprit, subscription *sub_pb.Subscription) (string, error)

	// Sends out notification to users about the detected anomalies.
	NotifyAnomaliesFound(ctx context.Context, anomalies []*pb.Anomaly, subscription *sub_pb.Subscription) (string, error)
}

TODO(wenbinzhang): considering using specific type for issue ID instead of 'string'.

func GetDefaultNotifier

func GetDefaultNotifier(ctx context.Context, cfg *config.InstanceConfig, commitURLTemplate string) (CulpritNotifier, error)

newNotifier returns a newNotifier Notifier.

type DefaultCulpritNotifier

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

DefaultCulpritNotifier sends notifications.

func (*DefaultCulpritNotifier) NotifyAnomaliesFound

func (n *DefaultCulpritNotifier) NotifyAnomaliesFound(ctx context.Context, anomalies []*pb.Anomaly, subscription *sub_pb.Subscription) (string, error)

Creates a bug in Buganizer about the detected anomalies.

func (*DefaultCulpritNotifier) NotifyCulpritFound

func (n *DefaultCulpritNotifier) NotifyCulpritFound(ctx context.Context, culprit *pb.Culprit, subscription *sub_pb.Subscription) (string, error)

Creates a bug in Buganizer about the detected culprit.