fix: telemetry recorder.Done() may panic if telemetry is disabled

oceanbase · Nov 7, 2023 · a1cc0e2 · a1cc0e2
1 parent 8bb84c8
commit a1cc0e2
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/pkg/telemetry/recorder.go b/pkg/telemetry/recorder.go
@@ -97,6 +97,9 @@ func (t *recorder) GenerateTelemetryRecord(object any, objectType, eventType, re
 }
 
 func (t *recorder) Done() {
+	if t.telemetryDisabled {
+		return
+	}
 	t.throttler.close()
 }
 

diff --git a/pkg/telemetry/recorder_test.go b/pkg/telemetry/recorder_test.go
@@ -27,10 +27,13 @@ import (
 type fakeEventRecorder struct{}
 
 func (f *fakeEventRecorder) Event(object runtime.Object, eventtype, reason, message string) {
+	getLogger().Printf("Event: %+v, %s, %s, %s\n", object, eventtype, reason, message)
 }
 func (f *fakeEventRecorder) Eventf(object runtime.Object, eventtype, reason, messageFmt string, args ...any) {
+	getLogger().Printf("Eventf: %+v, %s, %s, %s, %v\n", object, eventtype, reason, messageFmt, args)
 }
 func (f *fakeEventRecorder) AnnotatedEventf(object runtime.Object, annotations map[string]string, eventtype, reason, messageFmt string, args ...any) {
+	getLogger().Printf("AnnotatedEventf: %+v, %+v, %s, %s, %s, %v\n", object, annotations, eventtype, reason, messageFmt, args)
 }
 
 var _ = Describe("Telemetry", Label("telemetry"), Ordered, func() {
@@ -60,7 +63,11 @@ var _ = Describe("Telemetry", Label("telemetry"), Ordered, func() {
 
 	It("GetHostMetrics", func() {
 		metrics := telemetry.GetHostMetrics()
-		Expect(metrics).ShouldNot(BeNil())
+		if TelemetryDisabled {
+			Expect(metrics).Should(BeNil())
+		} else {
+			Expect(metrics).ShouldNot(BeNil())
+		}
 	})
 
 	It("Event", func() {
-Original file line number
+Diff line change
@@ Expand Up @@
     }
     func (t *recorder) Done() {
+    	if t.telemetryDisabled {
+    		return
+    	}
     	t.throttler.close()
     }
@@ Expand Down @@