temporalio / features

Behavior and history compatibility testing for Temporal SDKs
13 stars 16 forks source link

Stack traces with source mappings in the UI #439

Open josh-berry opened 5 months ago

josh-berry commented 5 months ago

Is your feature request related to a problem? Please describe.

Users want to be able to relate the events they are seeing in workflow histories back to the source code for their workflow, not only on failures, but also for successful events. This will help them debug issues in their workflows more easily.

Describe the solution you'd like

It would be nice if we could provide enough info from an active workflow to enable users to see where in the code the workflow was when each event was generated, including references back to the source code (and showing the code itself if available).

Additional context

Sushisource commented 5 months ago

TS already has this in the form of "enhanced stack traces" as defined here: https://github.com/temporalio/sdk-typescript/blob/b38c70c2a5656a0e5fd2b3891cf2cc65b425e315/packages/workflow/src/interfaces.ts#L418

New language implementations should adhere to that same interface when serving the query.

cretz commented 5 months ago

:+1: Though I think this task is more for like a query that will give a stack trace for every command upon replay (or every task complete or something). This needs to be discussed and a more proper proposal needs to be made to understand exactly what's wanted and will be done.

(ideally for specific data types we want to return from certain queries, we should add them as protos in the SDK package of the API repo, and we should document the query name and discuss how it may affect actions)