Merge pull request #4 from ccremer/liveness

Add liveness probe endpoint
ccremer · May 17, 2020 · a3e1708 · a3e1708
2 parents 2758b3b + bcfc380
commit a3e1708
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 11 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -9,18 +9,40 @@ on:
   pull_request:
     types: [opened, reopened]
 
+env:
+  GO_VERSION: "^1.14.3"
+
 jobs:
   goreleaser:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - uses: actions/setup-go@v2-beta
+    - uses: actions/setup-go@v2
       with:
-        go-version: '^1.14.2'
+        go-version: ${{ env.GO_VERSION }}
     - uses: actions/cache@v1
       with:
-        path: /home/runner/go/pkg/mod
-        key: go-mod-build
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+    - uses: goreleaser/goreleaser-action@v1
+      with:
+        args: release --snapshot --skip-sign
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-go@v2
+      with:
+        go-version: ${{ env.GO_VERSION }}
+    - uses: actions/cache@v1
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
     - name: Test & Publish Code Coverage
       uses: paambaati/codeclimate-action@v2.6.0
       env:
@@ -30,6 +52,19 @@ jobs:
         prefix: ${{ github.event.repository.name }}
         coverageLocations:
           "${{github.workspace}}/c.out:gocov"
-    - uses: goreleaser/goreleaser-action@v1
+
+  formatting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-go@v2
       with:
-        args: release --snapshot --skip-sign
+        go-version: ${{ env.GO_VERSION }}
+    - uses: actions/cache@v1
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+    - name: Verify if Code needs formatting
+      run: make fmt
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -5,18 +5,23 @@ on:
     tags:
     - "*"
 
+env:
+  GO_VERSION: "^1.14.3"
+
 jobs:
   goreleaser:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - uses: actions/setup-go@v2-beta
+    - uses: actions/setup-go@v2
       with:
-        go-version: '^1.14.2'
+        go-version: ${{ env.GO_VERSION }}
     - uses: actions/cache@v1
       with:
-        path: /home/runner/go/pkg/mod
-        key: go-mod-release
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
     - name: Login to Docker hub
       run: docker login -u ${{ secrets.DOCKER_HUB_USER }} -p ${{ secrets.DOCKER_HUB_PASSWORD }}
     - uses: goreleaser/goreleaser-action@v1

diff --git a/Makefile b/Makefile
@@ -13,7 +13,7 @@ dist: fmt
 clean:
 	@rm -rf fronius-exporter c.out dist
 
-test: fmt
+test:
 	@go test -coverprofile c.out ./...
 
 run:

diff --git a/main.go b/main.go
@@ -38,9 +38,28 @@ func main() {
 	}
 
 	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+		if r.URL.Path != "/" {
+			http.NotFound(w, r)
+			return
+		}
+		log.WithFields(log.Fields{
+			"uri":    r.RequestURI,
+			"client": r.RemoteAddr,
+		}).Debug("Accessed Root endpoint")
 		http.Redirect(w, r, "/metrics", http.StatusMovedPermanently)
 	})
+	http.HandleFunc("/liveness", func(w http.ResponseWriter, r *http.Request) {
+		log.WithFields(log.Fields{
+			"uri":    r.RequestURI,
+			"client": r.RemoteAddr,
+		}).Debug("Accessed Liveness endpoint")
+		w.WriteHeader(http.StatusNoContent)
+	})
 	http.HandleFunc("/metrics", func(w http.ResponseWriter, r *http.Request) {
+		log.WithFields(log.Fields{
+			"uri":    r.RequestURI,
+			"client": r.RemoteAddr,
+		}).Debug("Accessed Metrics endpoint")
 		collectMetricsFromTarget(symoClient)
 		promHandler.ServeHTTP(w, r)
 	})