Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate out advanced logging configuration #32131

Merged
merged 1 commit into from
Jun 30, 2023

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Jun 26, 2023

The "advanced logging configuration" applies not only to task logs but also to component logs and you can use it not only to configure custom way how task logs are created but also custom way how "regular" component logs are created.

This has been a source of confusion for those who wanted to configure (for example) elasticsearch or opensearch for the whole airflow deployment, because the "advanced configuration" and how to modify standard configuration chapter was a small section in "task logging".

This change extracts "advanced logging configuration" to separate page right under the "logging and monitoring" and directs the user from the "task" logging section to this page. It also adds a bit more explanation on how standard Python logging framework is leveraged here and links to Python logging documentation for those who never used it before, to understand more about Loggers, Handlers and Formatters.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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.

Copy link
Member

@pankajkoti pankajkoti left a comment

Choose a reason for hiding this comment

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

Looks helpful and more discoverable!

@pankajkoti
Copy link
Member

cc: @sunank200

@potiuk potiuk force-pushed the slightlty-restructure-logging-docs branch 2 times, most recently from 578af7a to 20ed43b Compare June 26, 2023 15:48
@potiuk potiuk requested a review from ashb as a code owner June 26, 2023 15:48
The "advanced logging configuration" applies not only to task
logs but also to component logs and you can use it not only to
configure custom way how task logs are created but also custom
way how "regular" component logs are created.

This has been a source of confusion for those who wanted
to configure (for example) elasticsearch or opensearch for the
whole airflow deployment, because the "advanced configuration"
and how to modify standard configuration chapter was a small
section in "task logging".

This change extracts "advanced logging configuration" to separate
page right under the "logging and monitoring" and directs the
user from the "task" logging section to this page. It also
adds a bit more explanation on how standard Python logging
framework is leveraged here and links to Python logging documentation
for those who never used it before, to understand more about
Loggers, Handlers and Formatters.

Co-authored-by: Akash Sharma <35839624+Adaverse@users.noreply.github.com>
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
@potiuk potiuk force-pushed the slightlty-restructure-logging-docs branch from 20ed43b to 0c7e0ef Compare June 26, 2023 16:02
@potiuk
Copy link
Member Author

potiuk commented Jun 27, 2023

:D Look for some approvals :)

@potiuk potiuk merged commit ead2530 into apache:main Jun 30, 2023
42 checks passed
@potiuk potiuk deleted the slightlty-restructure-logging-docs branch June 30, 2023 09:15
@potiuk potiuk added this to the Airlfow 2.6.3 milestone Jun 30, 2023
potiuk added a commit to potiuk/airflow that referenced this pull request Jun 30, 2023
The change apache#32131 restructured some of the code for documentation
and it broke references to apache-airlfow from "providers" doc
package - it has not been visible in selective PR (not sure the reason)
but this PR fixes it.
potiuk added a commit that referenced this pull request Jun 30, 2023
…2282)

The change #32131 restructured some of the code for documentation
and it broke references to apache-airlfow from "providers" doc
package - it has not been visible in selective PR (not sure the reason)
but this PR fixes it.
potiuk added a commit to potiuk/airflow that referenced this pull request Jun 30, 2023
When provider docs in "docs/apache-airflow-providers" changed, and
selective docs build was used, the "apache-airflow-providers" package
was not added to the filter - thus errors in those docs were not
checked. This caused  apache#32131 to fail the main build (fixed in
the apache#32282). Added logic to handle this case.
potiuk added a commit that referenced this pull request Jun 30, 2023
…32284)

When provider docs in "docs/apache-airflow-providers" changed, and
selective docs build was used, the "apache-airflow-providers" package
was not added to the filter - thus errors in those docs were not
checked. This caused  #32131 to fail the main build (fixed in
the #32282). Added logic to handle this case.
potiuk added a commit that referenced this pull request Jul 2, 2023
…32284)

When provider docs in "docs/apache-airflow-providers" changed, and
selective docs build was used, the "apache-airflow-providers" package
was not added to the filter - thus errors in those docs were not
checked. This caused  #32131 to fail the main build (fixed in
the #32282). Added logic to handle this case.

(cherry picked from commit ba05a1e)
potiuk added a commit that referenced this pull request Jul 2, 2023
The "advanced logging configuration" applies not only to task
logs but also to component logs and you can use it not only to
configure custom way how task logs are created but also custom
way how "regular" component logs are created.

This has been a source of confusion for those who wanted
to configure (for example) elasticsearch or opensearch for the
whole airflow deployment, because the "advanced configuration"
and how to modify standard configuration chapter was a small
section in "task logging".

This change extracts "advanced logging configuration" to separate
page right under the "logging and monitoring" and directs the
user from the "task" logging section to this page. It also
adds a bit more explanation on how standard Python logging
framework is leveraged here and links to Python logging documentation
for those who never used it before, to understand more about
Loggers, Handlers and Formatters.

Co-authored-by: Akash Sharma <35839624+Adaverse@users.noreply.github.com>
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
(cherry picked from commit ead2530)
potiuk added a commit that referenced this pull request Jul 2, 2023
…2282)

The change #32131 restructured some of the code for documentation
and it broke references to apache-airlfow from "providers" doc
package - it has not been visible in selective PR (not sure the reason)
but this PR fixes it.

(cherry picked from commit ef49e59)
@ephraimbuddy ephraimbuddy added the type:doc-only Changelog: Doc Only label Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants