heartbeat

README

opsgenie-heartbeat

A super simple client to send ping requests to the Opsgenie Heartbeat API.

While the SDK supports heartbeat requests, it's more involved to use & I wanted the underlying HTTP GET requests to be more robust to failure.

Usage

hb := heartbeat.New("api-key")
hb.Ping(context.Background(), "name-of-the-heartbeat")

Documentation

Index

• Variables
• type HTTPClient
• type PingRequest
  • func New(key string) PingRequest
  • func (r PingRequest) Ping(ctx context.Context, heartbeat string) error

Variables

var (
	// ErrUnauthorised signafies an invalid api key
	ErrUnauthorised = errors.New("invalid api key")
	// ErrNonOkStatusCode a non 2XX status code was returned
	ErrNonOkStatusCode = errors.New("non 200 status code")
)

Types

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

HTTPClient represents an HTTP client that can make a request

type PingRequest

type PingRequest struct {
	// APIKey used to talk to the API
	APIKey string

	Endpoint string
	Client   HTTPClient
}

PingRequest handles talking to the Opsgenie Heartbeat API

func New

func New(key string) PingRequest

New creates a PingRequest with a default HTTP client and API key from env variable

func (PingRequest) Ping

func (r PingRequest) Ping(ctx context.Context, heartbeat string) error

Ping performs a HTTP request to the Opsgenie Heartbeat Ping endpoint