mox!

vendor/github.com/mjl-/sherpaprom/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright 2017 Irias Informatiemanagement
+Copyright 2019 Mechiel Lukkien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

vendor/github.com/mjl-/sherpaprom/README.md

@@ -0,0 +1,13 @@
+# sherpaprom
+
+Go package with a Prometheus [1] collector for Sherpa API's [2,3]. It provides a prometheus collector that implements interface Collector.
+
+Read the godoc documentation at https://godoc.org/github.com/mjl-/sherpaprom
+
+[1] Prometheus: https://prometheus.io/
+[2] Sherpa protocol: https://www.ueber.net/who/mjl/sherpa/
+[3] Sherpa Go package: https://github.com/mjl-/sherpa
+
+# LICENSE
+
+Created by Mechiel Lukkien, originally at Irias, and released under an MIT-license, see LICENSE.md.

vendor/github.com/mjl-/sherpaprom/collector.go

@@ -0,0 +1,123 @@
+// Package sherpaprom provides a collector of statistics for incoming Sherpa requests that are exported over to Prometheus.
+package sherpaprom
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+// Collector implements the Collector interface from the sherpa package.
+type Collector struct {
+	requests, errors                              *prometheus.CounterVec
+	protocolErrors, badFunction, javascript, json prometheus.Counter
+	requestDuration                               *prometheus.HistogramVec
+}
+
+// NewCollector creates a new collector for the named API.
+// Metrics will be labeled with "api".
+// The following prometheus metrics are automatically registered on reg, or the default prometheus registerer if reg is nil:
+//
+// 	sherpa_requests_total
+// 		calls, per function
+// 	sherpa_errors_total
+// 		error responses, per function,code
+// 	sherpa_protocol_errors_total
+// 		incorrect requests
+// 	sherpa_bad_function_total
+// 		unknown functions called
+// 	sherpa_javascript_request_total
+// 		requests to sherpa.js
+// 	sherpa_json_request_total
+// 		requests to sherpa.json
+// 	sherpa_requests_duration_seconds
+// 		histogram for .01, .05, .1, .2, .5, 1, 2, 4, 8, 16, per function
+func NewCollector(api string, reg prometheus.Registerer) (*Collector, error) {
+	if reg == nil {
+		reg = prometheus.DefaultRegisterer
+	}
+	apiLabel := prometheus.Labels{"api": api}
+	c := &Collector{
+		requests: prometheus.NewCounterVec(prometheus.CounterOpts{
+			Name:        "sherpa_requests_total",
+			Help:        "Total sherpa requests.",
+			ConstLabels: apiLabel,
+		}, []string{"function"}),
+		errors: prometheus.NewCounterVec(prometheus.CounterOpts{
+			Name:        "sherpa_errors_total",
+			Help:        "Total sherpa error responses.",
+			ConstLabels: apiLabel,
+		}, []string{"function", "code"}),
+		protocolErrors: prometheus.NewCounter(prometheus.CounterOpts{
+			Name:        "sherpa_protocol_errors_total",
+			Help:        "Total sherpa protocol errors.",
+			ConstLabels: apiLabel,
+		}),
+		badFunction: prometheus.NewCounter(prometheus.CounterOpts{
+			Name:        "sherpa_bad_function_total",
+			Help:        "Total sherpa bad function calls.",
+			ConstLabels: apiLabel,
+		}),
+		javascript: prometheus.NewCounter(prometheus.CounterOpts{
+			Name:        "sherpa_javascript_request_total",
+			Help:        "Total sherpa.js requests.",
+			ConstLabels: apiLabel,
+		}),
+		json: prometheus.NewCounter(prometheus.CounterOpts{
+			Name:        "sherpa_json_requests_total",
+			Help:        "Total sherpa.json requests.",
+			ConstLabels: apiLabel,
+		}),
+		requestDuration: prometheus.NewHistogramVec(prometheus.HistogramOpts{
+			Name:        "sherpa_requests_duration_seconds",
+			Help:        "Sherpa request duration in seconds.",
+			ConstLabels: apiLabel,
+			Buckets:     []float64{.01, .05, .1, .2, .5, 1, 2, 4, 8, 16},
+		}, []string{"function"}),
+	}
+	first := func(errors ...error) error {
+		for _, err := range errors {
+			if err != nil {
+				return err
+			}
+		}
+		return nil
+	}
+	err := first(
+		reg.Register(c.requests),
+		reg.Register(c.errors),
+		reg.Register(c.protocolErrors),
+		reg.Register(c.badFunction),
+		reg.Register(c.javascript),
+		reg.Register(c.json),
+		reg.Register(c.requestDuration),
+	)
+	return c, err
+}
+
+// BadFunction increases counter "sherpa_bad_function_total" by one.
+func (c *Collector) BadFunction() {
+	c.badFunction.Inc()
+}
+
+// ProtocolError increases counter "sherpa_protocol_errors_total" by one.
+func (c *Collector) ProtocolError() {
+	c.protocolErrors.Inc()
+}
+
+// JSON increases "sherpa_json_requests_total" by one.
+func (c *Collector) JSON() {
+	c.json.Inc()
+}
+
+// JavaScript increases "sherpa_javascript_requests_total" by one.
+func (c *Collector) JavaScript() {
+	c.javascript.Inc()
+}
+
+// FunctionCall increases "sherpa_requests_total" by one, adds the call duration to "sherpa_requests_duration_seconds" and possibly increases "sherpa_error_total" and "sherpa_servererror_total".
+func (c *Collector) FunctionCall(name string, duration float64, errorCode string) {
+	c.requests.WithLabelValues(name).Inc()
+	if errorCode != "" {
+		c.errors.WithLabelValues(name, errorCode).Inc()
+	}
+	c.requestDuration.WithLabelValues(name).Observe(duration)
+}