heartbeat

Documentation

Overview

Package heartbeat provides functionality for managing heartbeats in Opsgenie.

Index

• type HeartbeatRepository
  • func NewOpsgenieHeartbeatRepository(apiKey string, mc common.ManagementCluster) (HeartbeatRepository, error)
• type OpsgenieHeartbeatRepository
  • func (r *OpsgenieHeartbeatRepository) CreateOrUpdate(ctx context.Context) error
  • func (r *OpsgenieHeartbeatRepository) Delete(ctx context.Context) error

Types

type HeartbeatRepository

type HeartbeatRepository interface {
	// CreateOrUpdate creates or updates the heartbeat for the management cluster.
	CreateOrUpdate(ctx context.Context) error

	// Delete deletes the heartbeat for the management cluster.
	Delete(ctx context.Context) error
}

HeartbeatRepository is the interface for the heartbeat repository. It provides methods to create or update and delete a heartbeat. The heartbeat is used by the monitoring system to detect if the management cluster is alive. The current implementation relies on OpsGenie but other implementations can be added in the future.

func NewOpsgenieHeartbeatRepository

func NewOpsgenieHeartbeatRepository(apiKey string, mc common.ManagementCluster) (HeartbeatRepository, error)

NewOpsgenieHeartbeatRepository creates a new OpsgenieHeartbeatRepository.

type OpsgenieHeartbeatRepository

type OpsgenieHeartbeatRepository struct {
	*heartbeat.Client
	common.ManagementCluster
}

OpsgenieHeartbeatRepository is a repository for managing heartbeats in Opsgenie.

func (*OpsgenieHeartbeatRepository) CreateOrUpdate

func (r *OpsgenieHeartbeatRepository) CreateOrUpdate(ctx context.Context) error

func (*OpsgenieHeartbeatRepository) Delete

func (r *OpsgenieHeartbeatRepository) Delete(ctx context.Context) error