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

Fix documentation for cpu and memory usage metrics #42147

Merged
merged 1 commit into from
Sep 13, 2024

Conversation

lucasmo
Copy link
Contributor

@lucasmo lucasmo commented Sep 10, 2024

Fix incorrect documentation for metrics are reported in airflow/task/task_runner/standard_task_runner.py. The documentation suggests that "percent" is in the metric names when it is not.


^ 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.

These metrics are reported in airflow/task/task_runner/standard_task_runner.py without "percent"
Copy link

boring-cyborg bot commented Sep 10, 2024

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 Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.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.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

@shalberd
Copy link

@potiuk @thesuperzapper this seems like something very straight-forward and intuitive; can it not be reviewed, accepted, and merged?

@potiuk potiuk merged commit 3f6497b into apache:main Sep 13, 2024
41 checks passed
Copy link

boring-cyborg bot commented Sep 13, 2024

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

@potiuk potiuk added this to the Airflow 2.10.2 milestone Sep 13, 2024
@potiuk
Copy link
Member

potiuk commented Sep 13, 2024

Can you please create a backport as a (cherry-pick -x PR to v2-10-test if you want this released in 2.10 please ) @shalberd @lucasmo - otherwise it will only be released in Airflow 3 (and I am going for holidays now so I won't have time for it).

vincbeck pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Sep 16, 2024
These metrics are reported in airflow/task/task_runner/standard_task_runner.py without "percent"

(cherry picked from commit 3f6497b)
@vincbeck
Copy link
Contributor

Backport in v2-10-test: #42256

vincbeck added a commit that referenced this pull request Sep 16, 2024
These metrics are reported in airflow/task/task_runner/standard_task_runner.py without "percent"

(cherry picked from commit 3f6497b)

Co-authored-by: lucasmo <[email protected]>
@lucasmo lucasmo deleted the metrics-doc-fixes branch September 17, 2024 20:25
joaopamaral pushed a commit to joaopamaral/airflow that referenced this pull request Oct 21, 2024
These metrics are reported in airflow/task/task_runner/standard_task_runner.py without "percent"
@utkarsharma2 utkarsharma2 added the type:doc-only Changelog: Doc Only label Oct 23, 2024
utkarsharma2 pushed a commit that referenced this pull request Oct 23, 2024
These metrics are reported in airflow/task/task_runner/standard_task_runner.py without "percent"

(cherry picked from commit 3f6497b)

Co-authored-by: lucasmo <[email protected]>
utkarsharma2 pushed a commit that referenced this pull request Oct 24, 2024
These metrics are reported in airflow/task/task_runner/standard_task_runner.py without "percent"

(cherry picked from commit 3f6497b)

Co-authored-by: lucasmo <[email protected]>
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.

5 participants