heartbeat

Documentation

Index

• func LoadParams(ctx context.Context, v *viper.Viper) (paramscmd.Params, error)
• func RateLimited(params RateLimitParams) bool
• func ResetRateLimit(ctx context.Context, v *viper.Viper) error
• func Run(ctx context.Context, v *viper.Viper) (int, error)
• func SendHeartbeats(ctx context.Context, v *viper.Viper, queueFilepath string) error
• type RateLimitParams

Functions

func LoadParams

func LoadParams(ctx context.Context, v *viper.Viper) (paramscmd.Params, error)

LoadParams loads params from viper.Viper instance. Returns ErrAuth if failed to retrieve api key.

func RateLimited

func RateLimited(params RateLimitParams) bool

RateLimited determines if we should send heartbeats to the API or save to the offline db.

func ResetRateLimit

func ResetRateLimit(ctx context.Context, v *viper.Viper) error

ResetRateLimit updates the internal.heartbeats_last_sent_at timestamp.

func Run

func Run(ctx context.Context, v *viper.Viper) (int, error)

Run executes the heartbeat command.

func SendHeartbeats

func SendHeartbeats(ctx context.Context, v *viper.Viper, queueFilepath string) error

SendHeartbeats sends a heartbeat to the wakatime api and includes additional heartbeats from the offline queue, if available and offline sync is not explicitly disabled.

Types

type RateLimitParams

type RateLimitParams struct {
	Disabled   bool
	LastSentAt time.Time
	Timeout    time.Duration
}

RateLimitParams contains params for the RateLimited function.