healthchecks.io integration

vendor/gitlab.com/etke.cc/go/healthchecks/.gitignore

@@ -0,0 +1 @@
+/testdata

vendor/gitlab.com/etke.cc/go/healthchecks/LICENSE

@@ -0,0 +1,166 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

vendor/gitlab.com/etke.cc/go/healthchecks/README.md

@@ -0,0 +1,13 @@
+# healthchecks
+
+A [healthchecks.io](https://github.com/healthchecks/healthchecks) wrapper
+
+check the godoc for information
+
+```go
+hc := healthchecks.New("your-uuid")
+go hc.Auto()
+
+hc.Log(strings.NewReader("optional body you can attach to any action"))
+hc.Shutdown()
+```

vendor/gitlab.com/etke.cc/go/healthchecks/auto.go

@@ -0,0 +1,24 @@
+package healthchecks
+
+import "time"
+
+// Auto is intended to start as separate goroutine (go c.Auto(5*time.Second))
+// it will automatically send Success (ping) requests, leaving the client itself fully usable
+// to stop the Auto(), call Shutdown() and destroy the client
+func (c *Client) Auto(every time.Duration) {
+	ticker := time.NewTicker(every)
+	defer ticker.Stop()
+	for {
+		select {
+		case <-ticker.C:
+			c.Success()
+		case <-c.done:
+			return
+		}
+	}
+}
+
+// Shutdown the client
+func (c *Client) Shutdown() {
+	c.done <- true
+}

vendor/gitlab.com/etke.cc/go/healthchecks/client.go

@@ -0,0 +1,70 @@
+package healthchecks
+
+import (
+	"fmt"
+	"io"
+	"net/http"
+	"strconv"
+)
+
+// Client for healthchecks
+type Client struct {
+	HTTP    *http.Client
+	log     func(string, error)
+	baseURL string
+	uuid    string
+	rid     string
+	done    chan bool
+}
+
+func (c *Client) call(operation, endpoint string, body ...io.Reader) {
+	var err error
+	var resp *http.Response
+	targetURL := fmt.Sprintf("%s/%s%s?rid=%s", c.baseURL, c.uuid, endpoint, c.rid)
+	if len(body) > 0 {
+		resp, err = c.HTTP.Post(targetURL, "text/plain; charset=utf-8", body[0])
+	} else {
+		resp, err = c.HTTP.Head(targetURL)
+	}
+	if err != nil {
+		c.log(operation, err)
+		return
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		respb, rerr := io.ReadAll(resp.Body)
+		if rerr != nil {
+			c.log(operation+":response", rerr)
+			return
+		}
+		rerr = fmt.Errorf(string(respb))
+		c.log(operation+":response", rerr)
+		return
+	}
+}
+
+// Start signal means the job started
+func (c *Client) Start(optionalBody ...io.Reader) {
+	c.call("start", "/start", optionalBody...)
+}
+
+// Success signal means the job has completed successfully (or, a continuously running process is still running and healthy).
+func (c *Client) Success(optionalBody ...io.Reader) {
+	c.call("success", "", optionalBody...)
+}
+
+// Fail signal means the job failed
+func (c *Client) Fail(optionalBody ...io.Reader) {
+	c.call("fail", "/fail", optionalBody...)
+}
+
+// Log signal just adds an event to the job log, without changing job status
+func (c *Client) Log(optionalBody ...io.Reader) {
+	c.call("log", "/log", optionalBody...)
+}
+
+// ExitStatus signal sends job's exit code (0-255)
+func (c *Client) ExitStatus(exitCode int, optionalBody ...io.Reader) {
+	c.call("exit status", "/"+strconv.Itoa(exitCode), optionalBody...)
+}

vendor/gitlab.com/etke.cc/go/healthchecks/healthchecks.go

@@ -0,0 +1,40 @@
+package healthchecks
+
+import (
+	"fmt"
+	"net/http"
+	"time"
+
+	"github.com/google/uuid"
+)
+
+// DefaultAPI base url for checks
+const DefaultAPI = "https://hc-ping.com"
+
+// ErrLog used to log errors occurred during an operation
+type ErrLog func(operation string, err error)
+
+// DefaultErrLog if you don't provide one yourself
+var DefaultErrLog = func(operation string, err error) {
+	fmt.Printf("healtchecks operation %q failed: %v\n", operation, err)
+}
+
+// New healthchecks client
+func New(hcUUID string, errlog ...ErrLog) *Client {
+	rid, _ := uuid.NewRandom()
+	c := &Client{
+		baseURL: DefaultAPI,
+		uuid:    hcUUID,
+		rid:     rid.String(),
+		done:    make(chan bool, 1),
+	}
+	c.HTTP = &http.Client{
+		Timeout: 10 * time.Second,
+	}
+	c.log = DefaultErrLog
+	if len(errlog) > 0 {
+		c.log = errlog[0]
+	}
+
+	return c
+}