HRQB 29 - Improve Quickbase upsert reporting #100
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
Why these changes are being introduced: Formerly, each QuickbaseUpsertTask would individually log how metrics about modified records. This made it difficult to quickly get a holistic picture of the run. The methods were also logging oriented vs data oriented, which made working with that data tricky. How this addresses that need: * Utilize luigi Events to pinpoint tasks only from the current run * Shift parsing up upsert results to QBClient * Add method HRQBPipelineTask.aggregate_upsert_results() to aggregate all upsert results, across all Load tasks that fired during the run By utilizing luigi Events, this also paves the way for better task data cleanup, if we want to only pinpoint tasks that ran during the last run (though not yet implemented). Side effects of this change: * All upsert results are written to logs in an aggregate form Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/HRQB-20
ghukill
commented
Jul 11, 2024
| for task, target in list(zip(self.deps(), self.input(), strict=True)) | ||
| } | ||
|
|
||
|
|
||
| @HRQBTask.event_handler(luigi.Event.SUCCESS) |
There was a problem hiding this comment.
This is an example of the Luigi Events/Callbacks. They allow registering on a particular task class, and then subscribing to particular events, in this case a successful run.
ehanson8
approved these changes
Jul 11, 2024
hrqb/base/task.py
Outdated
Comment on lines
216
to
221
| @property | ||
| def parse_upsert_counts(self) -> dict | None: | ||
| if self.target.exists(): | ||
| return QBClient.parse_upsert_results(self.target.read()) | ||
| return None | ||
|
|
There was a problem hiding this comment.
A docstring might help to clarify this property
jonavellecuerdo
approved these changes
Jul 12, 2024
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.
Purpose and background context
Formerly, each
QuickbaseUpsertTask(tasks that actually upsert data to Quickbase) would individually log metrics about modified records. This made it difficult to quickly get a holistic picture of the run; how many tables had how many updates. The methods were also logging oriented vs data oriented, which made working with that data in other contexts tricky.How this addresses that need:
QBClientHRQBPipelineTask.aggregate_upsert_results()to aggregate all upsert results, across all Load tasks that fired during the runBy utilizing luigi Events, this also paves the way for better task data cleanup, if we want to only pinpoint tasks that ran during the last run (though not yet implemented).
Includes new or updated dependencies?
NO
Changes expectations for external applications?
YES: updated logging structure
What are the relevant tickets?
Developer
Code Reviewer(s)