notifier

Documentation

Index

• Variables
• func NewContext(ctx context.Context, n Notifier) context.Context
• type Healthchecks
  • func (h *Healthchecks) Finished(ctx context.Context, err error) error
  • func (h *Healthchecks) SendStatus(ctx context.Context, status Status, log string) error
  • func (h *Healthchecks) SetLog(log string)
  • func (h *Healthchecks) Started(ctx context.Context) error
• type Logs
• type Notifier
  • func FromContext(ctx context.Context) (Notifier, bool)
  • func New(handler, url string) (Notifier, error)
  • func NewHealthchecks(url string) (Notifier, error)
• type Status

Variables

var (
	ErrInvalidResponse  = errors.New("invalid http response")
	ErrUnknownHandler   = errors.New("unknown handler")
	ErrEmptyURL         = errors.New("url must be set")
	ErrRetriesExhausted = errors.New("retries exhausted")
)

Functions

func NewContext

func NewContext(ctx context.Context, n Notifier) context.Context

Types

type Healthchecks

type Healthchecks struct {
	PingBodyLimit int
	RunID         string
	// contains filtered or unexported fields
}

func (*Healthchecks) Finished

func (h *Healthchecks) Finished(ctx context.Context, err error) error

func (*Healthchecks) SendStatus

func (h *Healthchecks) SendStatus(ctx context.Context, status Status, log string) error

func (*Healthchecks) SetLog

func (h *Healthchecks) SetLog(log string)

func (*Healthchecks) Started

func (h *Healthchecks) Started(ctx context.Context) error

type Logs

type Logs interface {
	SetLog(log string)
}

type Notifier

type Notifier interface {
	Started(ctx context.Context) error
	Finished(ctx context.Context, err error) error
}

func FromContext

func FromContext(ctx context.Context) (Notifier, bool)

func New

func New(handler, url string) (Notifier, error)

func NewHealthchecks

func NewHealthchecks(url string) (Notifier, error)

type Status

type Status uint8

const (
	StatusSuccess Status = iota
	StatusFailure
	StatusStart
)