feat: Enable adding customized logging fields in sensor (#2325)

Signed-off-by: emmayylu <44856279+emmayylu@users.noreply.github.com>
argoproj · Dec 1, 2022 · 4464e57 · 4464e57
1 parent 76b14c2
commit 4464e57
Show file tree

Hide file tree

Showing 10 changed files with 541 additions and 274 deletions.
diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json
@@ -3845,6 +3845,13 @@
           "description": "EventBusName references to a EventBus name. By default the value is \"default\"",
           "type": "string"
         },
+        "loggingFields": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "LoggingFields add additional key-value pairs when logging happens",
+          "type": "object"
+        },
         "replicas": {
           "description": "Replicas is the sensor deployment replicas",
           "format": "int32",

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
diff --git a/api/sensor.html b/api/sensor.html
diff --git a/api/sensor.md b/api/sensor.md
diff --git a/pkg/apis/sensor/v1alpha1/generated.pb.go b/pkg/apis/sensor/v1alpha1/generated.pb.go
diff --git a/pkg/apis/sensor/v1alpha1/generated.proto b/pkg/apis/sensor/v1alpha1/generated.proto
diff --git a/pkg/apis/sensor/v1alpha1/openapi_generated.go b/pkg/apis/sensor/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/sensor/v1alpha1/types.go b/pkg/apis/sensor/v1alpha1/types.go
@@ -110,6 +110,9 @@ type SensorSpec struct {
 	// RevisionHistoryLimit specifies how many old deployment revisions to retain
 	// +optional
 	RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty" protobuf:"varint,7,opt,name=revisionHistoryLimit"`
+	// LoggingFields add additional key-value pairs when logging happens
+	// +optional
+	LoggingFields map[string]string `json:"loggingFields" protobuf:"bytes,8,rep,name=loggingFields"`
 }
 
 func (s SensorSpec) GetReplicas() int32 {

diff --git a/pkg/apis/sensor/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/sensor/v1alpha1/zz_generated.deepcopy.go
diff --git a/sensors/cmd/start.go b/sensors/cmd/start.go
@@ -66,6 +66,10 @@ func Start() {
 	dynamicClient := dynamic.NewForConfigOrDie(restConfig)
 
 	logger = logger.With("sensorName", sensor.Name)
+	for name, value := range sensor.Spec.LoggingFields {
+		logger.With(name, value)
+	}
+
 	ctx := logging.WithLogger(signals.SetupSignalHandler(), logger)
 	m := metrics.NewMetrics(sensor.Namespace)
 	go m.Run(ctx, fmt.Sprintf(":%d", common.SensorMetricsPort))