feat: add option to ignore services on the dashboard (#26)

* feat: add option to ignore services on the dashboard

* feat: add green case to demo mode and refine dashboard

* fix: update to go 1.21 for the slices package

* fix: sort unstable apps as well

.github/workflows/main.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go: [ '1.18', '1.*' ]
+        go: [ '1.21', '1.*' ]
     name: Tests
     steps:
       - uses: actions/checkout@v3
@@ -50,4 +50,4 @@ jobs:
       - name: Goimports
         run: |
           go run golang.org/x/tools/cmd/goimports@latest -w .
-          git diff --quiet || (echo 'goimports requires code cleanup:' ; git diff ; exit 1)
+          git diff --quiet || (echo 'goimports requires code cleanup:' ; git diff ; exit 1)

Makefile

@@ -1,4 +1,4 @@
-VERSION=2.2.1
+VERSION=2.2.2
 
 .PHONY: docker dockerpublish test run run-demo
 

Readme.md

@@ -4,7 +4,7 @@ Docker: `aoepeople/vistecture-dashboard`
 
 Works together with [Vistecture](https://github.com/aoepeople/vistecture) and shows the state of the vistecture architecture in kubernetes like this:
 
-![Vistecture_Dashboard](screenshot.jpg)
+![Vistecture_Dashboard](screenshot.png)
 
 
 ## Usage ##
@@ -13,7 +13,7 @@ You can use the Dockerimage: `aoepeople/vistecture-dashboard`
 
 ### Example Project
 
-```
+```shell
 docker run --rm -ti -p 8080:8080 aoepeople/vistecture-dashboard
 ```
 
@@ -38,7 +38,7 @@ The following "Properties" are used to control dashboard behaviour
 - `k8sDeploymentName`: Override the name of the deployment in kubernetes that is checked(default = appname)
 - `k8sHealthCheckServiceName`: Override service name that is used to check health (default = appname)
 - `k8sHealthCheckThroughIngress`: If the app should be checked from public (ingress is required for the service)
-- `k8sType`: set to "job" if the application is not represented by an deployment in kubernetes, but it is just a job
+- `k8sType`: set to "job" if the application is not represented by a deployment in kubernetes, but it is just a job
 
 ### Healtcheck Format:
 
@@ -66,15 +66,31 @@ If a Healthcheck path is configured for the application the following format is
 }
 ```
 
-## Development: ##
+### Ignore/Silence services
+
+T ignore failing services you can provide their `name` as ignore flags, e.g.
+
+```shell
+go run vistecture-dashboard.go -Demo -ignore akeneo -ignore flamingo
+```
+
+respectively adjust the command in your dockerfile
 
+```dockerfile
+CMD ["-config", "/definition/project.yml", "-ignore", "myApp", "-ignore", "otherApp"]
 ```
-# run
+
+## Development:
+
+run
+
+```shell
 go run vistecture-dashboard.go
 ```
 
 For a demo display please use:
-```
+
+```shell
 go run vistecture-dashboard.go -config=example/project.yml -Demo
 ```
 

example/services/service.yml

@@ -0,0 +1,6 @@
+name: service
+title: Example Service
+summary: This is an example
+properties:
+  deployment: kubernetes
+  k8sHealthCheckServiceName: localhost

go.mod

@@ -1,6 +1,6 @@
 module github.com/AOEpeople/vistecture-dashboard/v2
 
-go 1.18
+go 1.21
 
 require (
 	github.com/AOEpeople/vistecture/v2 v2.5.2

src/interfaces/listener.go

@@ -6,31 +6,36 @@ import (
 	"html/template"
 	"io"
 	"log"
+	"net"
 	"net/http"
 	"os"
 	"path"
 	"sort"
+	"strconv"
+	"strings"
 	"time"
 
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+
 	"github.com/AOEpeople/vistecture-dashboard/v2/src/model/kube"
 	"github.com/AOEpeople/vistecture-dashboard/v2/src/model/vistecture"
-	"github.com/prometheus/client_golang/prometheus/promhttp"
 )
 
 type (
 	DashboardController struct {
-		ProjectPath string
-		Templates   string
-		Listen      string
-		DemoMode    bool
+		ProjectPath     string
+		Templates       string
+		Listen          string
+		IgnoredServices []string
+		DemoMode        bool
 	}
 
 	ByName []kube.AppDeploymentInfo
 
 	// templateData holds info for Dashboard Rendering
 	templateData struct {
-		Failed, Unhealthy, Healthy, Unknown, Unstable []kube.AppDeploymentInfo
-		Now                                           time.Time
+		Failed, Unhealthy, Healthy, Unknown, Unstable, Ignored []kube.AppDeploymentInfo
+		Now                                                    time.Time
 	}
 )
 
@@ -39,9 +44,16 @@ func (d *DashboardController) Server() error {
 	// load once (will panic before we start listen)
 	project := vistecture.LoadProject(d.ProjectPath)
 
+	var fakeHealthcheckPort int32
+	if d.DemoMode {
+		portReceive := make(chan int32)
+		go serveDemoHealthCheck(portReceive)
+		fakeHealthcheckPort = <-portReceive
+	}
+
 	// Prepare the status fetcher (will run in background and starts regual checks)
-	statusFetcher := kube.NewStatusFetcher(project.Applications, d.DemoMode)
-	go statusFetcher.FetchStatusInRegularInterval()
+	statusFetcher := kube.NewStatusFetcher(project.Applications, d.DemoMode, fakeHealthcheckPort)
+	go statusFetcher.FetchStatusInRegularInterval(d.IgnoredServices)
 
 	http.Handle("/static/", http.StripPrefix("/static/", http.FileServer(http.Dir(path.Join(d.Templates, "static")))))
 	http.Handle("/metrics", promhttp.Handler())
@@ -61,6 +73,8 @@ func (d *DashboardController) dashBoardHandler(rw http.ResponseWriter, _ *http.R
 	result := statusFetcher.GetCurrentResult()
 	for _, deployment := range result {
 		switch deployment.AppStateInfo.State {
+		case kube.State_ignored:
+			viewdata.Ignored = append(viewdata.Ignored, deployment)
 		case kube.State_unknown:
 			viewdata.Unknown = append(viewdata.Unknown, deployment)
 		case kube.State_unhealthy:
@@ -74,8 +88,10 @@ func (d *DashboardController) dashBoardHandler(rw http.ResponseWriter, _ *http.R
 		}
 	}
 
+	sort.Sort(ByName(viewdata.Ignored))
 	sort.Sort(ByName(viewdata.Unknown))
 	sort.Sort(ByName(viewdata.Unhealthy))
+	sort.Sort(ByName(viewdata.Unstable))
 	sort.Sort(ByName(viewdata.Failed))
 	sort.Sort(ByName(viewdata.Healthy))
 
@@ -87,11 +103,15 @@ func (d *DashboardController) renderDashboardStatus(rw http.ResponseWriter, view
 	tpl := template.New("dashboard")
 
 	tpl.Funcs(template.FuncMap{
+		"ignored":   func() uint { return kube.State_ignored },
 		"unknown":   func() uint { return kube.State_unknown },
 		"unhealthy": func() uint { return kube.State_unhealthy },
 		"failed":    func() uint { return kube.State_failed },
 		"healthy":   func() uint { return kube.State_healthy },
 		"unstable":  func() uint { return kube.State_unstable },
+		"splitLines": func(s string) []string {
+			return strings.Split(s, "\n")
+		},
 	})
 
 	b, err := os.ReadFile(path.Join(d.Templates, "dashboard.html"))
@@ -131,3 +151,21 @@ func e(rw http.ResponseWriter, err error) {
 	rw.Header().Set("content-type", "text/plain")
 	_, _ = fmt.Fprintf(rw, "%+v", err)
 }
+
+func serveDemoHealthCheck(fakeHealthcheckPort chan<- int32) {
+	ln, err := net.Listen("tcp", "")
+	if err != nil {
+		log.Fatal(err)
+	}
+	log.Println("Demo mode enabled: start fake health check on " + ln.Addr().String())
+	_, p, _ := net.SplitHostPort(ln.Addr().String())
+	pp, _ := strconv.Atoi(p)
+	fakeHealthcheckPort <- int32(pp)
+
+	err = http.Serve(ln, http.HandlerFunc(func(writer http.ResponseWriter, request *http.Request) {
+		writer.WriteHeader(http.StatusOK)
+	}))
+	if err != nil {
+		log.Fatal("fake health check failed: ", err)
+	}
+}