telemetry recorded locally as info log (algorand#666)

config.json: {"TelemetryToLog":true} logging.config: {"Enable":false,"SendToLog":true}
danyreyna · Jan 8, 2020 · 0d56cc1 · 0d56cc1
1 parent 95b412d
commit 0d56cc1
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 24 deletions.
diff --git a/cmd/algod/main.go b/cmd/algod/main.go
@@ -153,6 +153,12 @@ func main() {
 	}
 	defer fileLock.Unlock()
 
+	cfg, err := config.LoadConfigFromDisk(absolutePath)
+	if err != nil && !os.IsNotExist(err) {
+		// log is not setup yet, this will log to stderr
+		log.Fatalf("Cannot load config: %v", err)
+	}
+
 	// Enable telemetry hook in daemon to send logs to cloud
 	// If ALGOTEST env variable is set, telemetry is disabled - allows disabling telemetry for tests
 	isTest := os.Getenv("ALGOTEST") != ""
@@ -166,10 +172,12 @@ func main() {
 			os.Exit(1)
 		}
 
+		telemetryConfig.SendToLog = telemetryConfig.SendToLog || cfg.TelemetryToLog
+
 		// Apply telemetry override.
 		telemetryConfig.Enable = logging.TelemetryOverride(*telemetryOverride)
 
-		if telemetryConfig.Enable {
+		if telemetryConfig.Enable || telemetryConfig.SendToLog {
 			// If session GUID specified, use it.
 			if *sessionGUID != "" {
 				if len(*sessionGUID) == 36 {
@@ -188,12 +196,6 @@ func main() {
 		Genesis:  genesis,
 	}
 
-	cfg, err := config.LoadConfigFromDisk(s.RootPath)
-	if err != nil && !os.IsNotExist(err) {
-		// log is not setup yet, this will log to stderr
-		log.Fatalf("Cannot load config: %v", err)
-	}
-
 	// Generate a REST API token if one was not provided
 	apiToken, wroteNewToken, err := tokens.ValidateOrGenerateAPIToken(s.RootPath, tokens.AlgodTokenFilename)
 

diff --git a/config/config.go b/config/config.go
@@ -790,6 +790,9 @@ type Local struct {
 	// PeerConnectionsUpdateInterval defines the interval at which the peer connections information is being sent to the
 	// telemetry ( when enabled ). Defined in seconds.
 	PeerConnectionsUpdateInterval int
+
+	// TelemetryToLog records messages to node.log that are normally sent to remote event monitoring
+	TelemetryToLog bool
 }
 
 // Filenames of config files within the configdir (e.g. ~/.algorand)

diff --git a/config/local_defaults.go b/config/local_defaults.go
@@ -82,6 +82,7 @@ var defaultLocalV5 = Local{
 	RunHosted:                             false,
 	SuggestedFeeBlockHistory:              3,
 	SuggestedFeeSlidingWindowSize:         50,
+	TelemetryToLog:                        true,
 	TxPoolExponentialIncreaseFactor:       2,
 	TxPoolSize:                            15000,
 	TxSyncIntervalSeconds:                 60,

diff --git a/installer/config.json.example b/installer/config.json.example
@@ -40,6 +40,7 @@
     "RunHosted": false,
     "SuggestedFeeBlockHistory": 3,
     "SuggestedFeeSlidingWindowSize": 50,
+    "TelemetryToLog": true,
     "TxPoolExponentialIncreaseFactor": 2,
     "TxPoolSize": 15000,
     "TxSyncIntervalSeconds": 60,

diff --git a/logging/log.go b/logging/log.go
@@ -366,7 +366,7 @@ func NewLogger() Logger {
 }
 
 func (l logger) EnableTelemetry(cfg TelemetryConfig) (err error) {
-	if l.loggerState.telemetry != nil || !cfg.Enable {
+	if l.loggerState.telemetry != nil || (!cfg.Enable && !cfg.SendToLog) {
 		return nil
 	}
 	return EnableTelemetry(cfg, &l)

diff --git a/logging/telemetry.go b/logging/telemetry.go
@@ -48,7 +48,9 @@ func EnableTelemetry(cfg TelemetryConfig, l *logger) (err error) {
 func enableTelemetryState(telemetry *telemetryState, l *logger) {
 	l.loggerState.telemetry = telemetry
 	// Hook our normal logging to send desired types to telemetry
-	l.AddHook(telemetry.hook)
+	if telemetry.hook != nil {
+		l.AddHook(telemetry.hook)
+	}
 	// Wrap current logger Output writer to capture history
 	l.setOutput(telemetry.wrapOutput(l.getOutput()))
 }
@@ -71,19 +73,19 @@ func makeLevels(min logrus.Level) []logrus.Level {
 }
 
 func makeTelemetryState(cfg TelemetryConfig, hookFactory hookFactory) (*telemetryState, error) {
-	history := createLogBuffer(logBufferDepth)
-	if cfg.SessionGUID == "" {
-		cfg.SessionGUID = uuid.NewV4().String()
-	}
-	hook, err := createTelemetryHook(cfg, history, hookFactory)
-	if err != nil {
-		return nil, err
-	}
-
-	telemetry := &telemetryState{
-		history,
-		createAsyncHookLevels(hook, 32, 100, makeLevels(cfg.MinLogLevel)),
+	telemetry := &telemetryState{}
+	telemetry.history = createLogBuffer(logBufferDepth)
+	if cfg.Enable {
+		if cfg.SessionGUID == "" {
+			cfg.SessionGUID = uuid.NewV4().String()
+		}
+		hook, err := createTelemetryHook(cfg, telemetry.history, hookFactory)
+		if err != nil {
+			return nil, err
+		}
+		telemetry.hook = createAsyncHookLevels(hook, 32, 100, makeLevels(cfg.MinLogLevel))
 	}
+	telemetry.sendToLog = cfg.SendToLog
 	return telemetry, nil
 }
 
@@ -222,7 +224,12 @@ func (t *telemetryState) logTelemetry(l logger, message string, details interfac
 	entry.Level = logrus.InfoLevel
 	entry.Message = message
 
-	t.hook.Fire(entry)
+	if t.sendToLog {
+		entry.Info(message)
+	}
+	if t.hook != nil {
+		t.hook.Fire(entry)
+	}
 }
 
 func (t *telemetryState) Close() {

diff --git a/logging/telemetryCommon.go b/logging/telemetryCommon.go
@@ -36,13 +36,15 @@ type TelemetryOperation struct {
 }
 
 type telemetryState struct {
-	history *logBuffer
-	hook    *asyncTelemetryHook
+	history   *logBuffer
+	hook      *asyncTelemetryHook
+	sendToLog bool
 }
 
 // TelemetryConfig represents the configuration of Telemetry logging
 type TelemetryConfig struct {
 	Enable             bool
+	SendToLog          bool
 	URI                string
 	Name               string
 	GUID               string

diff --git a/test/testdata/configs/config-v5.json b/test/testdata/configs/config-v5.json
@@ -38,6 +38,7 @@
     "RestWriteTimeoutSeconds": 120,
     "RunHosted": false,
     "SuggestedFeeBlockHistory": 3,
+    "TelemetryToLog": true,
     "TxPoolExponentialIncreaseFactor": 2,
     "TxPoolSize": 15000,
     "TxSyncIntervalSeconds": 60,