heartbeat

package module

v0.0.0-...-68a1e1b Latest Latest Go to latest Published: Aug 21, 2018 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/rcrowe/opsgenie-heartbeat

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

View Source

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")
)

Functions ¶

This section is empty.

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

Source Files ¶

View all Source files

heartbeat.go

Directories ¶

Path	Synopsis
cmd

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL