Move a few occurrences of variables logged inline into tags

Author: lina-temporal

common/log/tag/tags.go

@@ -993,3 +993,18 @@ func Cause(cause string) ZapTag {
 func NexusOperation(operation string) ZapTag {
 	return NewStringTag("nexus-operation", operation)
 }
+
+// WorkflowRuleID returns tag for WorkflowRuleID
+func WorkflowRuleID(ruleID string) ZapTag {
+	return NewStringTag("wf-rule-id", ruleID)
+}
+
+// URL returns tag for URL
+func URL(url string) ZapTag {
+	return NewStringTag("url", url)
+}
+
+// TaskPriority returns tag for TaskPriority
+func TaskPriority(priority string) ZapTag {
+	return NewStringTag("task-priority", priority)
+}

common/rpc/encryption/local_store_tls_provider.go

@@ -428,7 +428,7 @@ func (s *localStoreTlsProvider) checkCertExpiration() {
 	if window != 0 {
 		expiring, expired, err := s.GetExpiringCerts(window)
 		if err != nil {
-			s.logger.Error(fmt.Sprintf("error while checking for certificate expiration: %v", err))
+			s.logger.Error("error while checking for certificate expiration", tag.Error(err))
 			return
 		}
 		if s.metricsHandler != nil {

service/frontend/namespace_handler.go

@@ -748,7 +748,7 @@ func (d *namespaceHandler) removeOldestExpiredWorkflowRule(rules map[string]*rul
 	}
 
 	if found {
-		d.logger.Info(fmt.Sprintf("Removed expired workflow rule %s", oldestKey))
+		d.logger.Info("Removed expired workflow rule", tag.WorkflowRuleID(oldestKey))
 		delete(rules, oldestKey)
 	}
 }

service/frontend/nexus_handler.go

@@ -484,7 +484,7 @@ func parseLinks(links []*nexuspb.Link, logger log.Logger) []nexus.Link {
 		if err != nil {
 			// TODO(rodrigozhou): links are non-essential for the execution of the workflow,
 			// so ignoring the error for now; we will revisit how to handle these errors later.
-			logger.Error(fmt.Sprintf("failed to parse link url: %s", link.Url), tag.Error(err))
+			logger.Error("failed to parse link url", tag.URL(link.Url), tag.Error(err))
 			continue
 		}
 		nexusLinks = append(nexusLinks, nexus.Link{
@@ -678,7 +678,11 @@ func (h *nexusHandler) nexusClientForActiveCluster(oc *operationContext, service
 			TaskQueue: oc.taskQueue,
 		}))
 	if err != nil {
-		oc.logger.Error(fmt.Sprintf("failed to forward Nexus request. error constructing ServiceBaseURL. baseURL=%s namespace=%s task_queue=%s", httpClient.BaseURL(), oc.namespaceName, oc.taskQueue), tag.Error(err))
+		oc.logger.Error("failed to forward Nexus request. error constructing ServiceBaseURL",
+			tag.URL(httpClient.BaseURL()),
+			tag.WorkflowNamespace(oc.namespaceName),
+			tag.WorkflowTaskQueueName(oc.taskQueue),
+			tag.Error(err))
 		oc.metricsHandler = oc.metricsHandler.WithTags(metrics.OutcomeTag("request_forwarding_failed"))
 		return nil, nexus.HandlerErrorf(nexus.HandlerErrorTypeInternal, "request forwarding failed")
 	}

service/history/replication/stream_sender.go

@@ -427,11 +427,10 @@ func (s *StreamSenderImpl) sendTasks(
 	endExclusiveWatermark int64,
 ) error {
 	if beginInclusiveWatermark > endExclusiveWatermark {
-		err := serviceerror.NewInternal(fmt.Sprintf("StreamWorkflowReplication encountered invalid task range [%v, %v)",
+		errMsg := fmt.Sprintf("StreamWorkflowReplication encountered invalid task range [%v, %v)",
 			beginInclusiveWatermark,
-			endExclusiveWatermark,
-		))
-		return err
+			endExclusiveWatermark)
+		return serviceerror.NewInternal(errMsg)
 	}
 	if beginInclusiveWatermark == endExclusiveWatermark {
 		return s.sendToStream(&historyservice.StreamWorkflowReplicationMessagesResponse{

service/history/replication/stream_sender_flow_controller.go

@@ -4,7 +4,6 @@ package replication
 
 import (
 	"context"
-	"fmt"
 	"sync"
 	"time"
 
@@ -106,9 +105,9 @@ func (s *SenderFlowControllerImpl) Wait(ctx context.Context, priority enumsspb.T
 	state.mu.Lock()
 	if !state.resume {
 		state.waiters++
-		s.logger.Info(fmt.Sprintf("%v sender is paused", priority.String()))
+		s.logger.Info("sender is paused", tag.TaskPriority(priority.String()))
 		state.cond.Wait()
-		s.logger.Info(fmt.Sprintf("%s sender is resumed", priority.String()))
+		s.logger.Info("sender is resumed", tag.TaskPriority(priority.String()))
 		state.waiters--
 	}
 	state.mu.Unlock()

service/history/replication/sync_state_retriever.go

@@ -326,7 +326,8 @@ func (s *SyncStateRetrieverImpl) getNewRunInfo(ctx context.Context, namespaceId
 	switch err.(type) {
 	case nil:
 	case *serviceerror.NotFound:
-		s.logger.Info(fmt.Sprintf("SyncWorkflowState new run not found, newRunId: %v", newRunId),
+		s.logger.Info("SyncWorkflowState new run not found",
+			tag.WorkflowNewRunID(newRunId),
 			tag.WorkflowNamespaceID(namespaceId.String()),
 			tag.WorkflowID(execution.WorkflowId),
 			tag.WorkflowRunID(execution.RunId))
@@ -350,7 +351,8 @@ func (s *SyncStateRetrieverImpl) getNewRunInfo(ctx context.Context, namespaceId
 	switch err.(type) {
 	case nil:
 	case *serviceerror.NotFound:
-		s.logger.Info(fmt.Sprintf("SyncWorkflowState new run event not found, newRunId: %v", newRunId),
+		s.logger.Info("SyncWorkflowState new run event not found",
+			tag.WorkflowNewRunID(newRunId),
 			tag.WorkflowNamespaceID(namespaceId.String()),
 			tag.WorkflowID(execution.WorkflowId),
 			tag.WorkflowRunID(execution.RunId))
@@ -359,7 +361,8 @@ func (s *SyncStateRetrieverImpl) getNewRunInfo(ctx context.Context, namespaceId
 		return nil, err
 	}
 	if len(newRunEvents) == 0 {
-		s.logger.Info(fmt.Sprintf("SyncWorkflowState new run event is empty, newRunId: %v", newRunId),
+		s.logger.Info("SyncWorkflowState new run event is empty",
+			tag.WorkflowNewRunID(newRunId),
 			tag.WorkflowNamespaceID(namespaceId.String()),
 			tag.WorkflowID(execution.WorkflowId),
 			tag.WorkflowRunID(execution.RunId))

service/history/transfer_queue_active_task_executor.go

@@ -500,7 +500,7 @@ func (t *transferQueueActiveTaskExecutor) processCancelExecution(
 		requestCancelInfo,
 		attributes,
 	); err != nil {
-		t.logger.Debug(fmt.Sprintf("Failed to cancel external workflow execution. Error: %v", err))
+		t.logger.Debug("Failed to cancel external workflow execution", tag.Error(err))
 
 		// Check to see if the error is non-transient, in which case add RequestCancelFailed
 		// event and complete transfer task by returning nil error.

service/worker/scanner/scanner.go

@@ -265,9 +265,9 @@ func (s *Scanner) startWorkflow(
 		if _, ok := err.(*serviceerror.WorkflowExecutionAlreadyStarted); ok {
 			return nil
 		}
-		s.context.logger.Error("error starting "+workflowType+" workflow", tag.Error(err))
+		s.context.logger.Error("error starting workflow", tag.WorkflowType(workflowType), tag.Error(err))
 		return err
 	}
-	s.context.logger.Info(workflowType + " workflow successfully started")
+	s.context.logger.Info("workflow successfully started", tag.WorkflowType(workflowType))
 	return nil
 }