Introduction

How to Use It

// Define a StatusEndpoint at '/status/db' for a database dependencydb := healthchecks.StatusEndpoint{  Name: "The DB",  Slug: "db",  Type: "internal",  IsTraversable: false,  StatusCheck: sqlsc.SQLDBStatusChecker{    DB: myDB  },  TraverseCheck: nil,}// Define a StatusEndpoint at '/status/service-organization' for the Organization serviceorg := healthchecks.StatusEndpoint{  Name: "Organization Service",  Slug: "service-organization",  Type: "http",  IsTraversable: true,  StatusCheck: httpsc.HttpStatusChecker{    BaseUrl: "[Read value from config]",  },  TraverseCheck: httpsc.HttpStatusChecker{    BaseUrl: "[Read value from config]",  },}// Define the list of StatusEndpoints for your servicestatusEndpoints := []healthchecks.StatusEndpoint{ db, org }// Set the path for the about and version filesaboutFilePath := "conf/about.json"versionFilePath := "conf/version.txt"// Set up any service injected customData for /status/about response.// Values can be any valid JSON conversion and will override values set in about.json.customData := make(map[string]interface{})// Examples://// String value// customData["a-string"] = "some-value"//// Number value// customData["a-number"] = 123//// Boolean value// customData["a-bool"] = true//// Array// customData["an-array"] = []string{"val1", "val2"}//// Custom object// customObject := make(map[string]interface{})// customObject["key1"] = 1// customObject["key2"] = "some-value"// customData["an-object"] = customObject// Register all the "/status/..." requests to use our health checking frameworkhttp.Handle("/status/", healthchecks.Handler(statusEndpoints, aboutFilePath, versionFilePath, customData))

Writing a StatusCheck

type RedisStatusChecker struct {client RedisClient}func (r RedisStatusChecker) CheckStatus(name string) healthchecks.StatusList {pong, err := r.client.Ping()// Set a default responses := healthchecks.Status{Description:  name,Result: healthchecks.OK,Details: "",}// Handle any errors that Ping() function returnedif err != nil {s = healthchecks.Status{Description:  name,Result: healthchecks.CRITICAL,Details: err.Error(),}}// Make sure the pong response is what we expectedif pong != "PONG" {s = healthchecks.Status{Description:  name,Result: healthchecks.CRITICAL,Details: fmt.Sprintf("Expecting `PONG` response, got `%s`", pong),}}// Return our responsereturn healthchecks.StatusList{ StatusList: []healthchecks.Status{ s }}}

Writing a TraverseCheck

type HttpStatusChecker struct {BaseUrl stringName    string}func (h HttpStatusChecker) Traverse(traversalPath []string, action string) (string, error) {dependencies := ""if len(traversalPath) > 0 {dependencies = fmt.Sprintf("&dependencies=%s", strings.Join(traversalPath, ","))}// Build our HTTP requesturl := fmt.Sprintf("%s/status/traverse?action=%s%s", h.BaseUrl, action, dependencies)req, err := http.NewRequest("GET", url, nil)if err != nil {fmt.Printf("Error creating request: %s \n", err.Error())return "", err}// Execute HTTP requestclient := &http.Client{}resp, err := client.Do(req)if err != nil {fmt.Printf("Error executing request: %s \n", err.Error())return "", err}// Defer the closing of the bodydefer resp.Body.Close()// Read our responseresponseBody, err := ioutil.ReadAll(resp.Body)if err != nil {fmt.Printf("Error reading response body: %s", err.Error())return "", err}// Return our responsereturn string(responseBody), nil}

How To Contribute

License

Maintainers