Include update info in logging output #664
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dandavison
force-pushed
the
648-update-logging
branch
from
f4ed4c0
to
f94249e
Compare
cretz
reviewed
Oct 10, 2024
temporalio/workflow.py
Outdated
| @@ -500,6 +500,14 @@ class UpdateInfo: | |||
| name: str | |||
| """Update type name.""" | |||
|
|
|||
| @property | |||
| def logger_details(self) -> Mapping[str, Any]: | |||
There was a problem hiding this comment.
Suggested change
| def logger_details(self) -> Mapping[str, Any]: | |
| def _logger_details(self) -> Mapping[str, Any]: |
I don't think we should make this public (and have it then be stable API)
temporalio/workflow.py
Outdated
| update_info = current_update_info() | ||
| if update_info: | ||
| if self.update_info_on_extra: | ||
| extra["temporal_update"] = asdict(update_info) |
There was a problem hiding this comment.
Arguably update info is just more workflow info and doesn't need a separate top-level key. I think it can just have the extra fields be put into temporal_workflow section same as appending to the message does.
temporalio/workflow.py
Outdated
| @@ -1220,6 +1236,7 @@ def __init__( | |||
| super().__init__(logger, extra or {}) | |||
| self.workflow_info_on_message = True | |||
| self.workflow_info_on_extra = True | |||
| self.update_info_on_extra = True | |||
There was a problem hiding this comment.
Not sure this deserves a separate setting. I think these two pieces of update information can be considered workflow information (and we are considering them workflow information for purposes of appending to the message, might as well in the extra too consistently).
dandavison
force-pushed
the
648-update-logging
branch
from
173468b
to
09fcea6
Compare
cretz
approved these changes
Oct 10, 2024
dandavison
force-pushed
the
648-update-logging
branch
from
747db44
to
361df16
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #648: include update info in logging output when in the context of an update execution
Also changes behavior such that if user logging call uses one of our keys then their call has precedence; this is the behavior of
merge_extra=Trueadded in Python 3.13.How this was tested