[app] Add tracing support via Jaeger or Zipkin

CHANGELOG.md

@@ -11,6 +11,7 @@ NOTE: As semantic versioning states all 0.y.z releases can contain breaking chan
 ### Added
 
 - [#355](https://github.com/kobsio/kobs/pull/#355): [app] Add profile page for authenticated users, which can be customized via dashboards.
+- [#361](https://github.com/kobsio/kobs/pull/#361): [app] Add tracing support for kobs via Jaeger or Zipkin.
 
 ### Fixed
 

cmd/kobs/hub/hub.go

@@ -15,6 +15,7 @@ import (
 	"github.com/kobsio/kobs/pkg/hub/watcher"
 	"github.com/kobsio/kobs/pkg/log"
 	"github.com/kobsio/kobs/pkg/metrics"
+	"github.com/kobsio/kobs/pkg/tracer"
 	"github.com/kobsio/kobs/pkg/version"
 
 	"github.com/spf13/cobra"
@@ -58,6 +59,18 @@ var Cmd = &cobra.Command{
 		log.Info(nil, "Version information", version.Info()...)
 		log.Info(nil, "Build context", version.BuildContext()...)
 
+		traceEnabled, _ := cmd.Flags().GetBool("trace.enabled")
+		traceServiceName, _ := cmd.Flags().GetString("trace.service-name")
+		traceProvider, _ := cmd.Flags().GetString("trace.provider")
+		traceAddress, _ := cmd.Flags().GetString("trace.address")
+
+		if traceEnabled {
+			err := tracer.Setup(traceServiceName, traceProvider, traceAddress)
+			if err != nil {
+				log.Fatal(nil, "Could not setup tracing", zap.Error(err), zap.String("provider", traceProvider), zap.String("address", traceAddress))
+			}
+		}
+
 		// Load the configuration for the satellite from the provided configuration file.
 		cfg, err := config.Load(hubConfigFile)
 		if err != nil {

cmd/kobs/main.go

@@ -39,6 +39,21 @@ func init() {
 		defaultLogLevel = os.Getenv("KOBS_LOG_LEVEL")
 	}
 
+	defaultTraceServiceName := "kobs"
+	if os.Getenv("KOBS_TRACE_SERVICE_NAME") != "" {
+		defaultTraceServiceName = os.Getenv("KOBS_TRACE_SERVICE_NAME")
+	}
+
+	defaultTraceProvider := "jaeger"
+	if os.Getenv("KOBS_TRACE_PROVIDER") != "" {
+		defaultTraceProvider = os.Getenv("KOBS_TRACE_PROVIDER")
+	}
+
+	defaultTraceAddress := "http://localhost:14268/api/traces"
+	if os.Getenv("KOBS_TRACE_ADDRESS") != "" {
+		defaultTraceAddress = os.Getenv("KOBS_TRACE_ADDRESS")
+	}
+
 	rootCmd.AddCommand(hub.Cmd)
 	rootCmd.AddCommand(satellite.Cmd)
 	rootCmd.AddCommand(version.Cmd)
@@ -47,6 +62,10 @@ func init() {
 	rootCmd.PersistentFlags().String("debug.password", defaultDebugPassword, "The password for the debug endpoints. The endpoints are only available when a password is provided.")
 	rootCmd.PersistentFlags().String("log.format", defaultLogFormat, "Set the output format of the logs. Must be \"console\" or \"json\".")
 	rootCmd.PersistentFlags().String("log.level", defaultLogLevel, "Set the log level. Must be \"debug\", \"info\", \"warn\", \"error\", \"fatal\" or \"panic\".")
+	rootCmd.PersistentFlags().Bool("trace.enabled", false, "Enable / disable tracing.")
+	rootCmd.PersistentFlags().String("trace.service-name", defaultTraceServiceName, "The service name which should be used for tracing.")
+	rootCmd.PersistentFlags().String("trace.provider", defaultTraceProvider, "Set the trace exporter which should be used. Must be \"jaeger\" or \"zipkin\".")
+	rootCmd.PersistentFlags().String("trace.address", defaultTraceAddress, "Set the address of the Jaeger or Zipkin instance.")
 }
 
 func main() {

cmd/kobs/satellite/satellite.go

@@ -11,6 +11,7 @@ import (
 	"github.com/kobsio/kobs/pkg/metrics"
 	"github.com/kobsio/kobs/pkg/satellite"
 	"github.com/kobsio/kobs/pkg/satellite/plugins"
+	"github.com/kobsio/kobs/pkg/tracer"
 	"github.com/kobsio/kobs/pkg/version"
 
 	"github.com/spf13/cobra"
@@ -43,6 +44,18 @@ var Cmd = &cobra.Command{
 		log.Info(nil, "Version information", version.Info()...)
 		log.Info(nil, "Build context", version.BuildContext()...)
 
+		traceEnabled, _ := cmd.Flags().GetBool("trace.enabled")
+		traceServiceName, _ := cmd.Flags().GetString("trace.service-name")
+		traceProvider, _ := cmd.Flags().GetString("trace.provider")
+		traceAddress, _ := cmd.Flags().GetString("trace.address")
+
+		if traceEnabled {
+			err := tracer.Setup(traceServiceName, traceProvider, traceAddress)
+			if err != nil {
+				log.Fatal(nil, "Could not setup tracing", zap.Error(err), zap.String("provider", traceProvider), zap.String("address", traceAddress))
+			}
+		}
+
 		// Load the configuration for the satellite from the provided configuration file.
 		cfg, err := config.Load(satelliteConfigFile)
 		if err != nil {

deploy/helm/hub/Chart.yaml

@@ -4,5 +4,5 @@ description: Kubernetes Observability Platform
 type: application
 home: https://kobs.io
 icon: https://kobs.io/assets/images/logo.svg
-version: 0.14.4
+version: 0.15.0
 appVersion: v0.8.0

deploy/helm/hub/templates/deployment.yaml

@@ -34,6 +34,10 @@ spec:
             - hub
             - --log.format={{ .Values.hub.settings.logFormat }}
             - --log.level={{ .Values.hub.settings.logLevel }}
+            - --trace.enabled={{ .Values.hub.settings.traceEnabled }}
+            - --trace.service-name={{ .Values.hub.settings.traceServiceName }}
+            - --trace.provider={{ .Values.hub.settings.traceProvider }}
+            - --trace.address={{ .Values.hub.settings.traceAddress }}
             - --hub.mode={{ .Values.hub.settings.mode }}
             - --hub.store.driver={{ .Values.hub.settings.store.driver }}
             - --hub.store.uri={{ .Values.hub.settings.store.uri }}

deploy/helm/hub/values.yaml

@@ -119,6 +119,12 @@ hub:
   settings:
     logFormat: console
     logLevel: info
+
+    traceEnabled: false
+    traceServiceName: hub
+    traceProvider: jaeger
+    traceAddress: http://localhost:14268/api/traces
+
     mode: default
     store:
       driver: bolt

deploy/helm/satellite/Chart.yaml

@@ -4,5 +4,5 @@ description: Kubernetes Observability Platform
 type: application
 home: https://kobs.io
 icon: https://kobs.io/assets/images/logo.svg
-version: 0.14.4
+version: 0.15.0
 appVersion: v0.8.0

deploy/helm/satellite/templates/deployment.yaml

@@ -35,6 +35,10 @@ spec:
             - satellite
             - --log.format={{ .Values.satellite.settings.logFormat }}
             - --log.level={{ .Values.satellite.settings.logLevel }}
+            - --trace.enabled={{ .Values.satellite.settings.traceEnabled }}
+            - --trace.service-name={{ .Values.satellite.settings.traceServiceName }}
+            - --trace.provider={{ .Values.satellite.settings.traceProvider }}
+            - --trace.address={{ .Values.satellite.settings.traceAddress }}
           {{- with .Values.env }}
           env:
             {{- toYaml . | nindent 12 }}

deploy/helm/satellite/values.yaml

@@ -122,6 +122,11 @@ satellite:
     logFormat: console
     logLevel: info
 
+    traceEnabled: false
+    traceServiceName: hub
+    traceProvider: jaeger
+    traceAddress: http://localhost:14268/api/traces
+
   ## Set the content of the config.yaml file, which is used by kobs. The configuration file is used to specify the
   ## cluster providers and the configuration for the plugins.
   ##

go.mod

@@ -33,9 +33,16 @@ require (
 	github.com/prometheus/client_golang v1.12.0
 	github.com/prometheus/common v0.32.1
 	github.com/spf13/cobra v1.2.1
-	github.com/stretchr/testify v1.7.0
+	github.com/stretchr/testify v1.7.1
 	github.com/timshannon/bolthold v0.0.0-20210913165410-232392fc8a6a
 	go.etcd.io/bbolt v1.3.6
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.32.0
+	go.opentelemetry.io/contrib/propagators/b3 v1.7.0
+	go.opentelemetry.io/otel v1.7.0
+	go.opentelemetry.io/otel/exporters/jaeger v1.7.0
+	go.opentelemetry.io/otel/exporters/zipkin v1.7.0
+	go.opentelemetry.io/otel/sdk v1.7.0
+	go.opentelemetry.io/otel/trace v1.7.0
 	go.uber.org/zap v1.20.0
 	k8s.io/api v0.23.2
 	k8s.io/apiextensions-apiserver v0.23.2
@@ -65,14 +72,16 @@ require (
 	github.com/dimchansky/utfbom v1.1.1 // indirect
 	github.com/dustin/go-humanize v1.0.0 // indirect
 	github.com/evanphx/json-patch v4.12.0+incompatible // indirect
+	github.com/felixge/httpsnoop v1.0.2 // indirect
 	github.com/fluxcd/pkg/apis/kustomize v0.2.0 // indirect
 	github.com/fluxcd/pkg/runtime v0.12.2 // indirect
-	github.com/go-logr/logr v1.2.2 // indirect
+	github.com/go-logr/logr v1.2.3 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/gogo/googleapis v1.1.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang-jwt/jwt v3.2.1+incompatible // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
-	github.com/google/go-cmp v0.5.6 // indirect
+	github.com/google/go-cmp v0.5.7 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
 	github.com/google/uuid v1.3.0 // indirect
 	github.com/googleapis/gnostic v0.5.5 // indirect
@@ -85,9 +94,8 @@ require (
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
 	github.com/jaegertracing/jaeger v1.15.1 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/klauspost/compress v1.13.5 // indirect
+	github.com/klauspost/compress v1.13.6 // indirect
 	github.com/klauspost/cpuid v1.3.1 // indirect
-	github.com/kr/pretty v0.2.1 // indirect
 	github.com/kylelemons/godebug v1.1.0 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
 	github.com/minio/md5-simd v1.1.0 // indirect
@@ -100,6 +108,7 @@ require (
 	github.com/nitishm/engarde v0.1.1 // indirect
 	github.com/openshift/api v0.0.0-20200221181648-8ce0047d664f // indirect
 	github.com/opentracing/opentracing-go v1.1.0 // indirect
+	github.com/openzipkin/zipkin-go v0.4.0 // indirect
 	github.com/pkg/browser v0.0.0-20210115035449-ce105d075bb4 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
@@ -112,6 +121,7 @@ require (
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/stretchr/objx v0.2.0 // indirect
 	github.com/vjeantet/grok v1.0.0 // indirect
+	go.opentelemetry.io/otel/metric v0.30.0 // indirect
 	go.uber.org/atomic v1.7.0 // indirect
 	go.uber.org/multierr v1.6.0 // indirect
 	golang.org/x/crypto v0.0.0-20220511200225-c6db032c6c88 // indirect
@@ -124,9 +134,8 @@ require (
 	golang.org/x/time v0.0.0-20220224211638-0e9765cccd65 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20210831024726-fe130286e0e2 // indirect
-	google.golang.org/grpc v1.40.0 // indirect
+	google.golang.org/grpc v1.41.0 // indirect
 	google.golang.org/protobuf v1.27.1 // indirect
-	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/ini.v1 v1.62.0 // indirect
 	gopkg.in/square/go-jose.v2 v2.5.1 // indirect