Update module github.com/prometheus/client_golang to v1.20.5

Update alpine Docker tag to v3.17.2

.github/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

.github/workflows/build-docker-image.yaml

@@ -0,0 +1,33 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - "master"
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to GHCR
+        uses: docker/login-action@v2
+        if: github.event_name != 'pull_request'
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v4
+        with:
+          push: true
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          tags: |
+            ghcr.io/${{ github.repository_owner }}/aaisp-exporter:${{ github.ref_name }}
+            ghcr.io/${{ github.repository_owner }}/aaisp-exporter:latest

.github/workflows/release.yaml

@@ -0,0 +1,28 @@
+on: 
+  release:
+    types: [created]
+
+jobs:
+  releases-matrix:
+    name: Release Go Binary
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        goos: [linux, windows, darwin]
+        goarch: ["386", amd64, arm64]
+        exclude:  
+          - goarch: "386"
+            goos: darwin 
+          - goarch: arm64
+            goos: windows 
+    steps:
+    - uses: actions/checkout@v3
+    - uses: wangyoucao577/go-release-action@v1.36
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        goos: ${{ matrix.goos }}
+        goarch: ${{ matrix.goarch }}
+        goversion: "https://dl.google.com/go/go1.18.4.linux-amd64.tar.gz"
+        project_path: "./cmd/aaisp_exporter"
+        binary_name: "aaisp_exporter"
+        extra_files: LICENSE cmd/aaisp_exporter/README.md

.gitignore

@@ -0,0 +1 @@
+aaisp_exporter

Dockerfile

@@ -0,0 +1,10 @@
+FROM golang:1.18.4-alpine3.16 as build
+WORKDIR /build
+COPY . .
+RUN go get -d -v .
+RUN go build -v ./cmd/aaisp_exporter
+
+FROM alpine:3.17.2
+WORKDIR /service
+COPY --from=build /build/aaisp_exporter .
+ENTRYPOINT ["./aaisp_exporter"]

chaos.go

@@ -8,6 +8,7 @@ import (
 	"io/ioutil"
 	"net/http"
 	"net/url"
+	"runtime"
 	"strings"
 	"time"
 )
@@ -55,6 +56,14 @@ func (a Auth) form() url.Values {
 	return f
 }
 
+func userAgent() string {
+	return fmt.Sprintf("chaos-go (%s; %s; %s) github.com/jamesog/aaisp-chaos",
+		runtime.GOOS,
+		runtime.GOARCH,
+		runtime.Version(),
+	)
+}
+
 func (api API) makeRequest(url string) ([]byte, error) {
 	client := &http.Client{
 		Timeout: 10 * time.Second,
@@ -64,6 +73,7 @@ func (api API) makeRequest(url string) ([]byte, error) {
 	if err != nil {
 		return nil, err
 	}
+	req.Header.Set("User-Agent", userAgent())
 	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
 	resp, err := client.Do(req)
 	if err != nil {

cmd/aaisp_exporter/main.go

@@ -2,7 +2,8 @@ package main
 
 import (
 	"flag"
-	"log"
+	"fmt"
+	"net"
 	"net/http"
 	"os"
 	"strconv"
@@ -10,6 +11,7 @@ import (
 	chaos "github.com/jamesog/aaisp-chaos"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
+	"github.com/rs/zerolog"
 )
 
 var (
@@ -37,10 +39,15 @@ var (
 		[]string{"line_id"},
 		nil,
 	)
+	scrapeSuccessGauge = prometheus.NewGauge(prometheus.GaugeOpts{
+		Name: "aaisp_scrape_success",
+		Help: "Displays whether or not the AAISP API scrape was a success",
+	})
 )
 
 type broadbandCollector struct {
 	*chaos.API
+	log zerolog.Logger
 }
 
 func (bc broadbandCollector) Describe(ch chan<- *prometheus.Desc) {
@@ -50,9 +57,11 @@ func (bc broadbandCollector) Describe(ch chan<- *prometheus.Desc) {
 func (bc broadbandCollector) Collect(ch chan<- prometheus.Metric) {
 	lines, err := bc.BroadbandInfo()
 	if err != nil {
-		log.Printf("error getting broadband info: %v\n", err)
+		bc.log.Debug().Err(err).Msg("error getting broadband info")
+		scrapeSuccessGauge.Set(0)
 		return
 	}
+	scrapeSuccessGauge.Set(1)
 	for _, line := range lines {
 		ch <- prometheus.MustNewConstMetric(
 			broadbandQuotaRemainingDesc,
@@ -81,18 +90,98 @@ func (bc broadbandCollector) Collect(ch chan<- prometheus.Metric) {
 	}
 }
 
+func loggingMiddleware(log zerolog.Logger) func(next http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+		fn := func(w http.ResponseWriter, r *http.Request) {
+			remoteHost, _, err := net.SplitHostPort(r.RemoteAddr)
+			if err != nil {
+				remoteHost = r.RemoteAddr
+			}
+			log.Log().
+				Str("proto", r.Proto).
+				Str("method", r.Method).
+				Str("path", r.URL.Path).
+				Str("remote_addr", remoteHost).
+				Str("user_agent", r.Header.Get("User-Agent")).
+				Send()
+			next.ServeHTTP(w, r)
+		}
+		return http.HandlerFunc(fn)
+	}
+}
+
+func usage(fs *flag.FlagSet) func() {
+	return func() {
+		o := fs.Output()
+		fmt.Fprintf(o, "Usage:\n    %s ", os.Args[0])
+		fs.VisitAll(func(f *flag.Flag) {
+			s := fmt.Sprintf(" [-%s", f.Name)
+			if arg, _ := flag.UnquoteUsage(f); len(arg) > 0 {
+				s += " " + arg
+			}
+			s += "]"
+			fmt.Fprint(o, s)
+		})
+		fmt.Fprint(o, "\n\nOptions:\n")
+		fs.PrintDefaults()
+		fmt.Fprint(o, "\nThe environment variables CHAOS_CONTROL_LOGIN and CHAOS_CONTROL_PASSWORD must be set.\n")
+	}
+}
+
+func setupLogger(level, output string) zerolog.Logger {
+	ll, err := zerolog.ParseLevel(level)
+	if err != nil {
+		ll = zerolog.InfoLevel
+	}
+
+	log := zerolog.New(os.Stderr).Level(ll).With().Timestamp().Logger()
+
+	switch output {
+	case "console":
+		log = log.Output(zerolog.ConsoleWriter{Out: os.Stderr})
+	}
+
+	return log
+}
+
 func main() {
-	listen := flag.String("listen", ":8080", "listen `address`")
-	flag.Parse()
+	fs := flag.NewFlagSet(os.Args[0], flag.ExitOnError)
+	fs.Usage = usage(fs)
+	var (
+		listen    = fs.String("listen", ":8080", "listen `address`")
+		logLevel  = fs.String("log.level", "info", "log `level`")
+		logOutput = fs.String("log.output", "json", "log output `style` (json, console)")
+	)
+	fs.Parse(os.Args[1:])
+
+	log := setupLogger(*logLevel, *logOutput)
+
+	var (
+		controlLogin    = os.Getenv("CHAOS_CONTROL_LOGIN")
+		controlPassword = os.Getenv("CHAOS_CONTROL_PASSWORD")
+	)
+	switch {
+	case controlLogin == "" && controlPassword == "":
+		log.Fatal().Msg("CHAOS_CONTROL_LOGIN and CHAOS_CONTROL_PASSWORD must be set in the environment")
+	case controlLogin == "":
+		log.Fatal().Msg("CHAOS_CONTROL_LOGIN is not set")
+	case controlPassword == "":
+		log.Fatal().Msg("CHAOS_CONTROL_PASSWORD is not set")
+	}
 
 	collector := broadbandCollector{
 		API: chaos.New(chaos.Auth{
-			ControlLogin:    os.Getenv("CHAOS_CONTROL_LOGIN"),
-			ControlPassword: os.Getenv("CHAOS_CONTROL_PASSWORD"),
+			ControlLogin:    controlLogin,
+			ControlPassword: controlPassword,
 		}),
+		log: log,
 	}
 
+	loggedHandler := loggingMiddleware(log)
+
 	prometheus.MustRegister(collector)
-	http.Handle("/metrics", promhttp.Handler())
-	log.Fatal(http.ListenAndServe(*listen, nil))
+	prometheus.MustRegister(scrapeSuccessGauge)
+	http.Handle("/metrics", loggedHandler(promhttp.Handler()))
+	log.Info().Msgf("Listening on %s", *listen)
+	log.Fatal().Err(http.ListenAndServe(*listen, nil)).Send()
 }

go.mod

@@ -2,4 +2,7 @@ module github.com/jamesog/aaisp-chaos
 
 go 1.13
 
-require github.com/prometheus/client_golang v1.1.0
+require (
+	github.com/prometheus/client_golang v1.20.5
+	github.com/rs/zerolog v1.27.0
+)