feat: adds data on action kind and queue length to logs #266
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
mwiebe
requested changes
Mar 27, 2024
Request: When looking at Agent Logs it is useful to know: 1. What kind of SessionAction is starting/ending. This helps understand the flow of the running Session(s) just from the agent log and can be a useful troubleshooting tool. 2. How many actions are queued up in a Session's internal pipeline. As with the above, this can be a useful troubleshooting datapoint, but can also be used to generate some statistics on scheduling behavior. Solution: This adds: 1. A 'kind' field to SessionActionLogEvents with values: TaskRun, EnvEnter, EnvExit, and JobAttachSyncInput. 2. A 'queue_length' field to SessionLogEvents of subtype Add and Remove. It also adds a warning message to the start of the Agent log to inform the customer about the expectations that they can have about log contents and formatting. This was added because not all customers will see the README on the GitHub repository. Signed-off-by: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
ddneilson
force-pushed
the
ddneilson/P95860983
branch
from
d5efd5e
to
ce2e954
Compare
AWS-Samuel
approved these changes
Mar 27, 2024
mwiebe
approved these changes
Mar 27, 2024
Merged
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.
What was the problem/requirement? (What/Why)
When looking at Agent Logs it is useful to know:
What was the solution? (How)
This adds:
It also adds a warning message to the start of the Agent log to inform the customer about the expectations that they can have about log contents and formatting. This was added because not all customers will see the README on the GitHub repository.
What is the impact of this change?
More useful data in the agent logs, and a message to clearly set customer expectations with respect to the log contents and format.
How was this change tested?
I've run the agent with the changes in place, and updated tests. Moreover, the way in which the change was made relied upon tooling to reduce risk:
SessionActionLogEventis a required keyword argument, so the linter picks up on every place that a required change is missed.kindtoSessionLogEventis only applicable to two subtypes, and each of those subtypes only occurs once in the codebase (outside of tests). This made is easy to do a global search to find all instances and be confident that none were missed.Was this change documented?
Yes, the README has been updated.
Is this a breaking change?
No, it is strictly additive to structured logs, and we do not consider changes to the unstructured logs to be breaking.