Enhance workflow logs #7222

shivamkm07 · 2023-11-21T13:50:44Z

Description

This PR adds more logs to runtime for better debugging.

Issue reference

Please reference the issue this PR will close: #7065

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

Code compiles correctly
Created/updated tests
Unit tests passing
End-to-end tests passing
Extended the documentation / Created issue in the https://github.com/dapr/docs/ repo: dapr/docs#[issue number]
Specification has been updated / Created issue in the https://github.com/dapr/docs/ repo: dapr/docs#[issue number]
Provided sample for the feature / Created issue in the https://github.com/dapr/docs/ repo: dapr/docs#[issue number]

Signed-off-by: Shivam Kumar <shivamkm07@gmail.com>

halspang

Mostly small suggestions, overall looks good.

pkg/runtime/wfengine/component.go

halspang · 2023-11-21T15:51:01Z

pkg/runtime/wfengine/wfengine.go

@@ -58,7 +58,7 @@ const (

 var (
 	wfLogger            = logger.NewLogger("dapr.runtime.wfengine")
-	wfBackendLogger     = logger.NewLogger("wfengine.backend")
+	wfBackendLogger     = logger.NewLogger("wfengine.durabletask.backend")


Does this change the anything about the logs? Like will customers who have setup scrapes/scans of the logs be broken by this change?

Our logs aren't stable so it's probably ok.

However, I don't know if exposing an internal thing (that it uses durable task library) adds anything compared to what it is today.

I added the change just to differentiate that these logs coming from DurableTask library and not Dapr runtime, as mentioned here: #7065 (comment) But if it breaks anything, I can remove it as well.

pkg/runtime/wfengine/workflow.go

pkg/runtime/wfengine/activity.go

pkg/runtime/wfengine/workflow.go

Signed-off-by: Shivam Kumar <shivamkm07@gmail.com>

codecov · 2023-11-23T13:12:07Z

Codecov Report

Attention: 24 lines in your changes are missing coverage. Please review.

Comparison is base (9189949) 64.56% compared to head (3d9c128) 64.57%.
Report is 30 commits behind head on master.

❗ Current head 3d9c128 differs from pull request most recent head 8bb09d4. Consider uploading reports for the commit 8bb09d4 to get more accurate results

Files	Patch %	Lines
pkg/runtime/wfengine/workflow.go	53.33%	11 Missing and 3 partials ⚠️
pkg/runtime/wfengine/activity.go	46.66%	8 Missing ⚠️
pkg/runtime/wfengine/component.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #7222   +/-   ##
=======================================
  Coverage   64.56%   64.57%           
=======================================
  Files         225      225           
  Lines       21050    21037   -13     
=======================================
- Hits        13591    13584    -7     
+ Misses       6297     6290    -7     
- Partials     1162     1163    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mukundansundar

@shivamkm07 small change

pkg/runtime/wfengine/activity.go

JoshVanL · 2023-11-30T09:17:33Z

@mukundansundar a reminder that we are blocking workflow PRs until #7241

* Adding more logs for workflow executions Signed-off-by: Shivam Kumar <shivamkm07@gmail.com> * fix typo Signed-off-by: Shivam Kumar <shivamkm07@gmail.com> * Adding quotes to be consistent Signed-off-by: Shivam Kumar <shivamkm07@gmail.com> * capitalizing log start Signed-off-by: Shivam Kumar <shivamkm07@gmail.com> --------- Signed-off-by: Shivam Kumar <shivamkm07@gmail.com> Co-authored-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com> Co-authored-by: Loong Dai <long.dai@intel.com>

shivamkm07 added 2 commits November 21, 2023 18:50

Adding more logs for workflow executions

21a25e3

Signed-off-by: Shivam Kumar <shivamkm07@gmail.com>

fix typo

7482fbb

Signed-off-by: Shivam Kumar <shivamkm07@gmail.com>

shivamkm07 requested review from a team as code owners November 21, 2023 13:50

halspang reviewed Nov 21, 2023

View reviewed changes