README
¶
go-healthchecks 
Simple http client api for healthchecks.io
Installation
go get -u github.com/frozzare/go-healthchecks
Example
package main
import (
"context"
"log"
"github.com/frozzare/go-healthchecks"
)
func main() {
client := healthchecks.NewClient(nil)
err := client.Start(context.Background(), "your-uuid-here")
if err != nil {
log.Fatal(err)
}
err := client.Success(context.Background(), "your-uuid-here")
if err != nil {
log.Fatal(err)
}
err = client.Fail(context.Background(), "your-uuid-here")
if err != nil {
log.Fatal(err)
}
}
License
MIT © Fredrik Forsmo
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrBadStatusCode is the error returned when a bad status code occurs. ErrBadStatusCode = errors.New("Bad status code from healthchecks") // DefaultURL is the default url to healthchecks. DefaultURL = "https://hc-ping.com/" )
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
A Client manages communication with Healthchecks.
func NewClient ¶
NewClient returns a new Healthchecks client. If a nil httpClient is provided, http.DefaultClient will be used.
func (*Client) Fail ¶
Fail sends a fail request to Healthchecks, a error is returned if a error has occurred.
Source Files
Click to show internal directories.
Click to hide internal directories.