Skip to content
This repository has been archived by the owner on Aug 4, 2023. It is now read-only.

Log last query_params hit before AirflowTaskTimeout #1058

Merged
merged 2 commits into from Mar 28, 2023

Conversation

stacimc
Copy link
Contributor

@stacimc stacimc commented Mar 23, 2023

Fixes

Description

The ProviderDataIngester includes error handling that, among other things, logs the last query_params reached by the DAG before an error is encountered during ingestion, which is helpful for debugging or resuming a failed DAG. AirflowExceptions are exempted from this custom handling, but that means we also don't get the query_param logging when a task is stopped by Airflow.

This PR changes nothing about the handling of those exceptions, but just adds a log for the last query params hit before raising. This is useful when a pull_data task times out, because we can see exactly where the DAG managed to get to and resume it at that point.

Testing Instructions

Update the pull_timeout for a provider ingester to something small. You can do this in the provider_workflows.py file or via the Airflow variable as described in #976. I updated the Metropolitan museum workflow to have a 1 minute pull timeout.

Then run the DAG locally and wait for the pull_data step to timeout. The task should raise an AirflowTaskTimeout as normal, but when you view the task logs you should be able to scroll up and see a log like:

[2023-03-23, 18:18:41 UTC] {provider_data_ingester.py:219} INFO - Last query_params used: {"metadataDate": "2016-09-04"}

Checklist

  • My pull request has a descriptive title (not a vague title like
    Update index.md).
  • My pull request targets the default branch of the repository (main) or
    a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible
    errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@stacimc stacimc added 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: catalog Related to the catalog and Airflow DAGs labels Mar 23, 2023
@stacimc stacimc self-assigned this Mar 23, 2023
@stacimc stacimc requested a review from a team as a code owner March 23, 2023 18:33
@openverse-bot openverse-bot added this to Needs review in Openverse PRs Mar 23, 2023
Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it - tested locally that this worked exactly as described!

Openverse PRs automation moved this from Needs review to Reviewer approved Mar 24, 2023
@stacimc stacimc merged commit 5c2d707 into main Mar 28, 2023
9 checks passed
Openverse PRs automation moved this from Reviewer approved to Merged! Mar 28, 2023
@stacimc stacimc deleted the add/log-final-query-params-on-timeout branch March 28, 2023 16:08
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: catalog Related to the catalog and Airflow DAGs
Projects
No open projects
Openverse PRs
  
Merged!
Development

Successfully merging this pull request may close these issues.

None yet

3 participants