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

Improve Description of dag_processing.processes Metric in Docs #30891

Merged
merged 3 commits into from
May 4, 2023

Conversation

dvfeinblum-betterment
Copy link
Contributor


Hey folks; this is a very very small proposal regarding the description of the dag_processing.processes metric emitted by airflow. It is a delta value, not the absolute value, and that can lead to very difficult interpretation of what this metric actually means.

If you look at the data this metric emits, it's sometimes negative (which doesn't seem to make a huge amount of sense since it's the "count" of dag processing processes spun off by processor.py). I don't claim this change to be the best rephrasing, but I thought it'd make sense to have a convo on this pull itself to figure out the best solution.

@boring-cyborg
Copy link

boring-cyborg bot commented Apr 26, 2023

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@dvfeinblum-betterment
Copy link
Contributor Author

Also a note for maintainers, I based my understanding of this metric off a discussion here

apache/skywalking#10341

since, again, the documentation about this metric is incredible sparse from the official docs.

@dvfeinblum-betterment
Copy link
Contributor Author

Oh also; one question for maintainers. It just dawned on me that this metric (the number of active dag processor processes) is kinda calculable by just looking at airflow.dag_processing.last_duration.count, rendering this metric maybe not super useful? Just sorta thinking out loud. I'll stop bumping this pull now.

@potiuk
Copy link
Member

potiuk commented May 2, 2023

I think @ferruzzi - this might be something that you can drag your attention to while refreshing/updating metrcs.

@ferruzzi
Copy link
Contributor

ferruzzi commented May 3, 2023

Very sorry for the delay. Yeah, thanks for updating that. A lot of the metrics are not particularly well documented and I am working on that right now. Your new description looks good to me.

You may also be interested in joining the discussion over here. After I finish adding OpenTelemetry support, we want to make a pass and help clean up things like this and a couple that either don't work at all or don't work as the description might indicate. 👍

Copy link
Contributor

@ferruzzi ferruzzi left a comment

Choose a reason for hiding this comment

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

I like it.

@potiuk potiuk merged commit 9637170 into apache:main May 4, 2023
42 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented May 4, 2023

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@dvfeinblum-betterment dvfeinblum-betterment deleted the patch-1 branch May 4, 2023 13:25
@dvfeinblum-betterment
Copy link
Contributor Author

Hey folks; appreciate the quick turn around! I'll be sure to take a peek at the other documentation work going on. I'm a bit of a wordsmith and would be happy to make additiona contributions. Cheers 🎉

@ferruzzi
Copy link
Contributor

ferruzzi commented May 4, 2023

We can always use more eyes on the documentation helping clarify stuff. 👍 I might tap you when it comes time to looking at that page.

@ephraimbuddy ephraimbuddy added the type:doc-only Changelog: Doc Only label May 8, 2023
@ephraimbuddy ephraimbuddy added this to the Airflow 2.6.1 milestone May 8, 2023
ephraimbuddy pushed a commit that referenced this pull request May 8, 2023
* improve description of dag_processing.processes

* clarifying meaning of "relative"

* typo

(cherry picked from commit 9637170)
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

4 participants