Feature/jaeger agent (#27)

* added jaeger agent

* Merged collector URL to Jaeger config section

* simplified jaeger config watcher

* private tace provider ctor function

.vscode/launch.json

@@ -11,6 +11,14 @@
             "mode": "auto",
             "program": "./cmd/rusid",
             "args": ["--app-id", "rusi-vs-code-debug", "--config", "../../examples/components/config-node-pipeline.yaml", "--components-path", "../../examples/components", "--v", "4"]
+        },
+        {
+            "name": "Test Current File",
+            "type": "go",
+            "request": "launch",
+            "mode": "test",
+            "program": "${relativeFileDirname}",
+            "args": []
         }
 
     ]

examples/components/config-node-pipeline.yaml

@@ -7,8 +7,9 @@ spec:
     enabled: true
   tracing:
     samplingRate: '1'
-    zipkin:
-      endpointAddress: 'http://kube-worker1.totalsoft.local:31034/api/traces'
+    jaeger:
+      useAgent: true
+      collectorEndpointAddress: 'http://kube-worker1.totalsoft.local:31034/api/traces'
   subscriberPipeline:
     handlers:
     - name: pubsub-uppercase

helm/crds/configuration.yaml

@@ -81,15 +81,18 @@ spec:
                 tracing:
                   description: TracingSpec is the spec object in ConfigurationSpec
                   properties:
-                    zipkin:
+                    jaeger:
                       type: object
-                      description: Defines the Zipkin trace configurations
+                      description: Defines the Jaeger trace configurations
                       properties:
-                        endpointAddress:
-                          description: The endpoint address of Zipkin server to receive traces
+                        useAgent:
+                          description: Determines if a Jaeger agent is used
+                          type: boolean
+                        collectorEndpointAddress:
+                          description: The endpoint address of Jaeger collector to receive traces. Ignored if 'useAgent' is set.
                           type: string
                   required:
-                    - zipkin
+                    - jaeger
                   type: object
                 pubSub:
                   description: Defines the default pubSub

internal/diagnostics/diagnostics.go

@@ -2,13 +2,14 @@ package diagnostics
 
 import (
 	"context"
-	"k8s.io/klog/v2"
 	"rusi/pkg/custom-resource/configuration"
 	configuration_loader "rusi/pkg/custom-resource/configuration/loader"
+
+	"k8s.io/klog/v2"
 )
 
 func WatchConfig(ctx context.Context, configLoader configuration_loader.ConfigurationLoader,
-	tracerFunc func(url string) (func(), error)) {
+	tracerFunc func(url string, useAgent bool) (func(), error)) {
 
 	var (
 		prevConf       configuration.Spec
@@ -21,13 +22,15 @@ func WatchConfig(ctx context.Context, configLoader configuration_loader.Configur
 	}
 
 	for cfg := range configChan {
-		if prevConf.TracingSpec.Zipkin.EndpointAddresss != cfg.TracingSpec.Zipkin.EndpointAddresss {
+		changed := cfg.TracingSpec != prevConf.TracingSpec
+		validConfig := cfg.TracingSpec.Jaeger.UseAgent || cfg.TracingSpec.Jaeger.CollectorEndpointAddress != ""
+		if changed {
 			if tracingStopper != nil {
 				//flush prev logs
 				tracingStopper()
 			}
-			if cfg.TracingSpec.Zipkin.EndpointAddresss != "" {
-				tracingStopper, err = tracerFunc(cfg.TracingSpec.Zipkin.EndpointAddresss)
+			if validConfig {
+				tracingStopper, err = tracerFunc(cfg.TracingSpec.Jaeger.CollectorEndpointAddress, cfg.TracingSpec.Jaeger.UseAgent)
 				if err != nil {
 					klog.ErrorS(err, "error creating tracer")
 				}

internal/tracing/jaeger.go

@@ -14,9 +14,16 @@ import (
 // the Jaeger exporter that will send spans to the provided url. The returned
 // TracerProvider will also use a Resource configured with all the information
 // about the application.
-func JaegerTracerProvider(url, serviceName string) (*tracesdk.TracerProvider, error) {
+func jaegerTracerProvider(url string, useAgent bool, serviceName string) (*tracesdk.TracerProvider, error) {
 	// Create the Jaeger exporter
-	exp, err := jaeger_exporters.New(jaeger_exporters.WithCollectorEndpoint(jaeger_exporters.WithEndpoint(url)))
+	var exp *jaeger_exporters.Exporter
+	var err error
+
+	if useAgent {
+		exp, err = jaeger_exporters.New(jaeger_exporters.WithAgentEndpoint())
+	} else {
+		exp, err = jaeger_exporters.New(jaeger_exporters.WithCollectorEndpoint(jaeger_exporters.WithEndpoint(url)))
+	}
 	if err != nil {
 		return nil, err
 	}
@@ -36,9 +43,9 @@ func JaegerTracerProvider(url, serviceName string) (*tracesdk.TracerProvider, er
 	return tp, nil
 }
 
-func SetJaegerTracing(serviceName string) func(url string) (func(), error) {
-	return func(url string) (func(), error) {
-		tp, err := JaegerTracerProvider(url, serviceName)
+func SetJaegerTracing(serviceName string) func(url string, useAgent bool) (func(), error) {
+	return func(url string, useAgent bool) (func(), error) {
+		tp, err := jaegerTracerProvider(url, useAgent, serviceName)
 		if err != nil {
 			return nil, err
 		}

pkg/custom-resource/configuration/loader/local_test.go

@@ -32,8 +32,9 @@ metadata:
   name: secretappconfig
 spec:
   tracing:
-    zipkin:
-      endpointAddress: "${RUSI_ZIPKIN_ENDPOINT}" `)
+    jaeger:
+      collectorEndpointAddress: "${RUSI_JAEGER_COLLECTOR_ENDPOINT}" 
+      useAgent: false `)
 
 	defer os.Remove("config.yaml")
 	defer os.Remove("env_variables_config.yaml")
@@ -69,12 +70,12 @@ spec:
 	}
 
 	t.Run("Parse environment variables", func(t *testing.T) {
-		os.Setenv("RUSI_ZIPKIN_ENDPOINT", "http://localhost:42323")
+		os.Setenv("RUSI_JAEGER_COLLECTOR_ENDPOINT", "http://localhost:42323")
 		configChan, err := LoadStandaloneConfiguration("env_variables_config.yaml")(ctx)
 		config := <-configChan
 		assert.NoError(t, err, "Unexpected error")
 		assert.NotNil(t, config, "Config not loaded as expected")
-		assert.Equal(t, "http://localhost:42323", config.TracingSpec.Zipkin.EndpointAddresss)
+		assert.Equal(t, "http://localhost:42323", config.TracingSpec.Jaeger.CollectorEndpointAddress)
 	})
 
 	t.Run("Load config file", func(t *testing.T) {

pkg/custom-resource/configuration/types.go

@@ -35,12 +35,13 @@ type HandlerSpec struct {
 
 // TracingSpec defines distributed tracing configuration.
 type TracingSpec struct {
-	Zipkin ZipkinSpec `json:"zipkin" yaml:"zipkin"`
+	Jaeger JaegerSpec `json:"jaeger" yaml:"jaeger"`
 }
 
-// ZipkinSpec defines Zipkin trace configurations.
-type ZipkinSpec struct {
-	EndpointAddresss string `json:"endpointAddress" yaml:"endpointAddress"`
+// JaegerSpec defines Jaeger trace configurations.
+type JaegerSpec struct {
+	UseAgent                 bool   `json:"useAgent" yaml:"useAgent"`
+	CollectorEndpointAddress string `json:"collectorEndpointAddress" yaml:"collectorEndpointAddress"`
 }
 
 // FeatureSpec defines the features that are enabled/disabled.

pkg/operator/apis/rusi/v1alpha1/configurationTypes.go

@@ -46,12 +46,13 @@ type HandlerSpec struct {
 
 // TracingSpec defines distributed tracing configuration.
 type TracingSpec struct {
-	Zipkin ZipkinSpec `json:"zipkin"`
+	Jaeger JaegerSpec `json:"jaeger"`
 }
 
-// ZipkinSpec defines Zipkin trace configurations.
-type ZipkinSpec struct {
-	EndpointAddresss string `json:"endpointAddress"`
+// JaegerSpec defines Jaeger trace configurations.
+type JaegerSpec struct {
+	UseAgent                 bool   `json:"useAgent"`
+	CollectorEndpointAddress string `json:"collectorEndpointAddress"`
 }
 
 // FeatureSpec defines the features that are enabled/disabled.