kacpermuda opened a new pull request, #41217:
URL: https://github.com/apache/airflow/pull/41217
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
## Problem
Whenever we are trying to debug issues related to OpenLineage coming from
users, we usually require information about versions of other providers used in
the process, for reproducing purposes. It would be great to have that
information in the events already to reduce the time and effort needed for
debugging, but only when some flag is turned on explicitly on the user side
(f.e. airflow log level is set to debug). This PR adds a DebugRun facet to
Airflow, that contains information about all packages and their versions. In
the future, we could possibly extend that facet with other useful information.
### Questions:
- I'm not sure, if we should add this facet to all events (current
implementation), or only add it to some specific events (which?).
- Can we rely on the Airflow logging level when deciding whether or not to
attach this facet? I wanted to avoid creating another flag, that would
basically had to be set together with DEBUG logging level. (Whenever debugging
user issues, we are asking for debug logs anyway)
## Background:
Initially, I aimed to include package information in the producer field for
specific facets but wanted to keep it hassle-free for both users and
developers. I created some POC for each solution, but this debug facet seems
the best for now.
We could automatically track where a facet is created and assign the
producer, but the complexity and maintenance effort are not worth it for such a
simple feature.
I also considered resetting the producer for facets after creation using a
decorator or function in common.compat provider, but this would require
additional code from developers when adding OL support for operators. With hook
level lineage coming, it could become even more complex. This is something we
might revisit in the future, as having the producer field identify the actual
provider of the facet at all times is beneficial (regardless of OL
configuration, logging level, etc.).
For now, the simple debug facet should suffice.
Please let me know your thoughts.
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
