healthchecksio

Documentation

Overview

Package healthchecksio is a wrapper for API calls to HealthChecks.io

Index

• type Client
  • func New(uuid string, c *http.Client) *Client
  • func (cl *Client) Start(ctx context.Context) error
  • func (cl *Client) Status(ctx context.Context, code int, msg []byte) error
• type StatusErr
  • func (se StatusErr) Error() string
  • func (se StatusErr) String() string

Types

type Client

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

Client is a convenient way to ping HealthChecks.io

func New

func New(uuid string, c *http.Client) *Client

New returns a configured client. If c is nil, http.DefaultClient is used.

func (*Client) Start

func (cl *Client) Start(ctx context.Context) error

Start calls the start HealthChecks.io endpoint

func (*Client) Status

func (cl *Client) Status(ctx context.Context, code int, msg []byte) error

Status calls the HealthChecks.io status endpoint

type StatusErr

type StatusErr int

StatusErr represents an unexpected response status from HealthChecks.io

func (StatusErr) Error

func (se StatusErr) Error() string

func (StatusErr) String

func (se StatusErr) String() string