heartbeat

Documentation

Index

• type Monitor
  • func (m Monitor) LastHeartbeat() time.Time
  • func (m Monitor) LastState() State
  • func (m Monitor) Normalize() (*Monitor, error)
• type State
  • func (r *State) Scan(value interface{}) error
• type Store
  • func NewStore(ctx context.Context, db *sql.DB) (*Store, error)
  • func (s *Store) CreateTx(ctx context.Context, tx *sql.Tx, m *Monitor) (*Monitor, error)
  • func (s *Store) DeleteTx(ctx context.Context, tx *sql.Tx, ids ...string) error
  • func (s *Store) FindAllByService(ctx context.Context, serviceID string) ([]Monitor, error)
  • func (s *Store) FindMany(ctx context.Context, ids []string) ([]Monitor, error)
  • func (s *Store) FindOneTx(ctx context.Context, tx *sql.Tx, id string) (*Monitor, error)
  • func (s *Store) RecordHeartbeat(ctx context.Context, id string) error
  • func (s *Store) UpdateTx(ctx context.Context, tx *sql.Tx, m *Monitor) error

Types

type Monitor

type Monitor struct {
	ID        string        `json:"id,omitempty"`
	Name      string        `json:"name,omitempty"`
	ServiceID string        `json:"service_id,omitempty"`
	Timeout   time.Duration `json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

A Monitor will generate an alert if it does not receive a heartbeat within the configured TimeoutMinutes.

func (Monitor) LastHeartbeat

func (m Monitor) LastHeartbeat() time.Time

LastHeartbeat returns the timestamp of the last successful heartbeat.

func (Monitor) LastState

func (m Monitor) LastState() State

LastState returns the last known state.

func (Monitor) Normalize

func (m Monitor) Normalize() (*Monitor, error)

Normalize performs validation and returns a new copy.

type State

type State string

State represents the health of a heartbeat monitor.

const (
	// StateInactive means the heartbeat has not yet reported for the first time.
	StateInactive State = "inactive"

	// StateHealthy indicates a heartbeat was received within the past interval.
	StateHealthy State = "healthy"

	// StateUnhealthy indicates a heartbeat has not been received since beyond the interval.
	StateUnhealthy State = "unhealthy"
)

func (*State) Scan

func (r *State) Scan(value interface{}) error

Scan handles reading State from the DB format

type Store

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

Store manages heartbeat checks and recording heartbeats.

func NewStore

func NewStore(ctx context.Context, db *sql.DB) (*Store, error)

NewStore creates a new Store and prepares all sql statements.

func (*Store) CreateTx

func (s *Store) CreateTx(ctx context.Context, tx *sql.Tx, m *Monitor) (*Monitor, error)

CreateTx creates a new heartbeat Monitor.

func (*Store) DeleteTx

func (s *Store) DeleteTx(ctx context.Context, tx *sql.Tx, ids ...string) error

DeleteTx deletes the heartbeat check with the given ID(s).

func (*Store) FindAllByService

func (s *Store) FindAllByService(ctx context.Context, serviceID string) ([]Monitor, error)

FindAllByService returns all heartbeats belonging to the given service ID.

func (*Store) FindMany

func (s *Store) FindMany(ctx context.Context, ids []string) ([]Monitor, error)

FindMany returns the heartbeat monitors with the given IDs.

The order and number of returned monitors is not guaranteed.

func (*Store) FindOneTx

func (s *Store) FindOneTx(ctx context.Context, tx *sql.Tx, id string) (*Monitor, error)

FindOneTx returns a heartbeat montior for updating.

func (*Store) RecordHeartbeat

func (s *Store) RecordHeartbeat(ctx context.Context, id string) error

RecordHeartbeat records a heartbeat for the given heartbeat ID.

func (*Store) UpdateTx

func (s *Store) UpdateTx(ctx context.Context, tx *sql.Tx, m *Monitor) error

UpdateTx updates a heartbeat Monitor.