notify

Documentation

Index

• Constants
• Variables
• func NewLogger(r TemplateRenderer, l log.Logger) forward.Notifier
• type TemplateRenderer
  • func NewHTMLTemplateRenderer(tpl string) (TemplateRenderer, error)
  • func NewMeasureTemplateRenderer(rendererType string, rec TemplateRendererMetricsRecorder, ...) TemplateRenderer
• type TemplateRendererFunc
  • func (t TemplateRendererFunc) Render(ctx context.Context, ag *model.AlertGroup) (string, error)
• type TemplateRendererMetricsRecorder

Constants

const DefaultTemplateRenderer = defRenderer(0)

DefaultTemplateRenderer is the default renderer that will render the alerts using a premade HTML template.

const Dummy = dummy(0)

Dummy is a dummy notifier.

Variables

var ErrRenderTemplate = errors.New("error rendering template")

ErrRenderTemplate will be used when there is an error rendering the alerts to a template.

Functions

func NewLogger

func NewLogger(r TemplateRenderer, l log.Logger) forward.Notifier

NewLogger returns a notifier that only logs the renderer alerts, normally used to develop or dry/run.

Types

type TemplateRenderer

type TemplateRenderer interface {
	Render(ctx context.Context, ag *model.AlertGroup) (string, error)
}

TemplateRenderer knows how to render an alertgroup to get the final notification message.

func NewHTMLTemplateRenderer

func NewHTMLTemplateRenderer(tpl string) (TemplateRenderer, error)

NewHTMLTemplateRenderer returns a new template renderer using the go HTML template renderer. The templates use https://github.com/Masterminds/sprig to render.

func NewMeasureTemplateRenderer

func NewMeasureTemplateRenderer(rendererType string, rec TemplateRendererMetricsRecorder, next TemplateRenderer) TemplateRenderer

NewMeasureTemplateRenderer wraps a template renderer and measures using metrics.

type TemplateRendererFunc

type TemplateRendererFunc func(ctx context.Context, ag *model.AlertGroup) (string, error)

TemplateRendererFunc is a helper function to use funcs as TemplateRenderer types.

func (TemplateRendererFunc) Render

func (t TemplateRendererFunc) Render(ctx context.Context, ag *model.AlertGroup) (string, error)

Render satisfies TemplateRenderer interface.

type TemplateRendererMetricsRecorder

type TemplateRendererMetricsRecorder interface {
	ObserveTemplateRendererOpDuration(ctx context.Context, rendererType string, op string, success bool, t time.Duration)
}

TemplateRendererMetricsRecorder knows how to record the metrics in the TemplateRenderer.