Centralise structlog initialisation in BaseDagBundle#69859
Open
dabla wants to merge 2 commits into
Open
Conversation
1 task
dbb2de2 to
b6d4f1c
Compare
… versions can also benefit from the common log solution
b6d4f1c to
1b7170f
Compare
This file contains hidden or 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
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.
BaseDagBundlenow owns the structlog logger via a lazy_logproperty, so subclasses no longer need to construct and bind it themselves in their constructors. I saw all Dag bundles extending this class re-implemented the same logic regarding the structlog initialization when reviewing PR #67016, hence why I created this PR to make the code more DRY.What changed
BaseDagBundlegains a_loglazy property that creates a structloglogger on first access, bound with
bundle_name,version, andwhatever
_log_context()returns._log_context(self) -> dicttemplate-method hook (returns{}bydefault) lets each subclass declare its own extra log fields without
duplicating the boilerplate
structlog.get_logger(...).bind(...)call.GCSDagBundle,S3DagBundle, andGitDagBundleeach implement_log_context()and drop their manualself._log = log.bind(...)initblocks and the now-unused module-level / local
structlog.get_loggercalls.
LocalDagBundleneeds no change — the default_log_context()returns{}, which is the correct behaviour for a bundle with no extra context.Why lazy?
BaseDagBundle.__init__is called viasuper().__init__()before subclass-specific attributes (e.g.bucket_name,bare_repo_path) are set. Evaluating_log_context()at base-__init__time would therefore fail or produce incomplete context. The lazy property defers evaluation until first use, by which point all__init__work across the hierarchy is complete.Was generative AI tooling used to co-author this PR?
Claude Sonnet 4.6
{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.