Skip to content

Commit 9bdaa9c

Browse files
authored
reduce simulate info logs (#102)
* reduce simulate info logs * fix unit test * Return values to info + add new format * forgotten file * add multilevel logs * fix lint * cross platform colours and reformatted * remove error when stripping message * clean up
1 parent 3d64282 commit 9bdaa9c

5 files changed

Lines changed: 368 additions & 197 deletions

File tree

cmd/workflow/simulate/simulate.go

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ func (h *handler) ValidateInputs(inputs Inputs) error {
168168
if err := runRPCHealthCheck(inputs.EVMClients); err != nil {
169169
// we don't block execution, just show the error to the user
170170
// because some RPCs in settings might not be used in workflow and some RPCs might have hiccups
171-
h.log.Error().Msgf("some RPCs in setting is not functioning properly, please check: %v", err)
171+
fmt.Printf("Warning: some RPCs in settings are not functioning properly, please check: %v\n", err)
172172
}
173173

174174
h.validated = true
@@ -245,10 +245,7 @@ func run(
245245
verbosity bool,
246246
) error {
247247
logCfg := logger.Config{Level: getLevel(verbosity, zapcore.InfoLevel)}
248-
baseLggr, err := logCfg.New()
249-
if err != nil {
250-
return fmt.Errorf("failed to create logger: %w", err)
251-
}
248+
simLogger := NewSimulationLogger(verbosity)
252249

253250
engineLogCfg := logger.Config{Level: zapcore.FatalLevel}
254251

@@ -288,7 +285,7 @@ func run(
288285

289286
if cfg.EnableBeholder {
290287
beholderLggr := lggr.Named("Beholder")
291-
err := setupCustomBeholder(beholderLggr, verbosity)
288+
err := setupCustomBeholder(beholderLggr, verbosity, simLogger)
292289
if err != nil {
293290
fmt.Printf("Failed to setup beholder: %v\n", err)
294291
os.Exit(1)
@@ -310,6 +307,7 @@ func run(
310307
}
311308

312309
triggerLggr := lggr.Named("TriggerCapabilities")
310+
var err error
313311
triggerCaps, err = NewManualTriggerCapabilities(ctx, triggerLggr, registry, manualTriggerCapConfig, !inputs.Broadcast)
314312
if err != nil {
315313
fmt.Printf("failed to create trigger capabilities: %v\n", err)
@@ -360,44 +358,44 @@ func run(
360358

361359
// Manual trigger execution
362360
if triggerInfoAndBeforeStart.TriggerFunc == nil {
363-
baseLggr.Errorw("Trigger function not initialized")
361+
simLogger.Error("Trigger function not initialized")
364362
os.Exit(1)
365363
}
366364
if triggerInfoAndBeforeStart.TriggerToRun == nil {
367-
baseLggr.Errorw("Trigger to run not selected")
365+
simLogger.Error("Trigger to run not selected")
368366
os.Exit(1)
369367
}
370-
baseLggr.Infow("Running trigger", "trigger", triggerInfoAndBeforeStart.TriggerToRun.GetId())
368+
simLogger.Info("Running trigger", "trigger", triggerInfoAndBeforeStart.TriggerToRun.GetId())
371369
err := triggerInfoAndBeforeStart.TriggerFunc()
372370
if err != nil {
373-
baseLggr.Errorw("Failed to run trigger", "trigger", triggerInfoAndBeforeStart.TriggerToRun.GetId(), "error", err)
371+
simLogger.Error("Failed to run trigger", "trigger", triggerInfoAndBeforeStart.TriggerToRun.GetId(), "error", err)
374372
os.Exit(1)
375373
}
376374

377375
select {
378376
case <-executionFinishedCh:
379-
baseLggr.Infow("Execution finished signal received")
377+
simLogger.Info("Execution finished signal received")
380378
case <-ctx.Done():
381-
baseLggr.Infow("Received interrupt signal, stopping execution")
379+
simLogger.Info("Received interrupt signal, stopping execution")
382380
case <-time.After(WorkflowExecutionTimeout):
383-
baseLggr.Infow("Timeout waiting for execution to finish")
381+
simLogger.Warn("Timeout waiting for execution to finish")
384382
}
385383
}
386384
simulatorCleanup := func(ctx context.Context, cfg simulator.RunnerConfig, registry *capabilities.Registry, services []services.Service) {
387385
for _, service := range services {
388386
if service.Name() == "WorkflowEngine.WorkflowEngineV2" {
389-
baseLggr.Info("Skipping WorkflowEngineV2")
387+
simLogger.Info("Skipping WorkflowEngineV2")
390388
continue
391389
}
392390

393391
if err := service.Close(); err != nil {
394-
baseLggr.Errorw("Failed to close service", "service", service.Name(), "error", err)
392+
simLogger.Error("Failed to close service", "service", service.Name(), "error", err)
395393
}
396394
}
397395

398-
err = cleanupBeholder()
396+
err := cleanupBeholder()
399397
if err != nil {
400-
baseLggr.Warnw("Failed to cleanup beholder", "error", err)
398+
simLogger.Warn("Failed to cleanup beholder", "error", err)
401399
}
402400
}
403401
emptyHook := func(context.Context, simulator.RunnerConfig, *capabilities.Registry, []services.Service) {}
@@ -425,10 +423,10 @@ func run(
425423
LifecycleHooks: v2.LifecycleHooks{
426424
OnInitialized: func(err error) {
427425
if err != nil {
428-
baseLggr.Errorw("Failed to initialize simulator", "error", err)
426+
simLogger.Error("Failed to initialize simulator", "error", err)
429427
os.Exit(1)
430428
}
431-
baseLggr.Info("Simulator Initialized")
429+
simLogger.Info("Simulator Initialized")
432430
fmt.Println()
433431
close(initializedCh)
434432
},
@@ -650,8 +648,8 @@ func getLevel(verbosity bool, defaultLevel zapcore.Level) zapcore.Level {
650648
}
651649

652650
// setupCustomBeholder sets up beholder with our custom telemetry writer
653-
func setupCustomBeholder(lggr logger.Logger, verbosity bool) error {
654-
writer := &telemetryWriter{lggr: lggr, verbose: verbosity}
651+
func setupCustomBeholder(lggr logger.Logger, verbosity bool, simLogger *SimulationLogger) error {
652+
writer := &telemetryWriter{lggr: lggr, verbose: verbosity, simLogger: simLogger}
655653

656654
client, err := beholder.NewWriterClient(writer)
657655
if err != nil {

0 commit comments

Comments
 (0)