Skip to content

Correct scheduled slots documentation and missing open telemetry span#41899

Merged
ferruzzi merged 2 commits intoapache:mainfrom
mattogburke:correct-scheduled_slots-documentation-and-span
Sep 3, 2024
Merged

Correct scheduled slots documentation and missing open telemetry span#41899
ferruzzi merged 2 commits intoapache:mainfrom
mattogburke:correct-scheduled_slots-documentation-and-span

Conversation

@mattogburke
Copy link
Copy Markdown
Contributor

The new pool.scheduled_slots metrics added in #38899 has incorrect documentation, calling the field pool.scheduled_tasks.

Additionally this field isn't exposed in the open telemetry span data unlike all the other related pool.{state}_slots metrics. I suspect this was missed in #40802


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

@boring-cyborg boring-cyborg bot added area:Scheduler including HA (high availability) scheduler kind:documentation labels Aug 30, 2024
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg bot commented Aug 30, 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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@mattogburke mattogburke changed the title Correct scheduled slots documentation and span Correct scheduled slots documentation and missing open telemetry span Aug 30, 2024
@mattogburke mattogburke force-pushed the correct-scheduled_slots-documentation-and-span branch from e2c84b4 to 29766fb Compare August 30, 2024 15:45
@potiuk
Copy link
Copy Markdown
Member

potiuk commented Sep 3, 2024

cc: @howardyoo @ferruzzi ?

@mattogburke mattogburke force-pushed the correct-scheduled_slots-documentation-and-span branch from 29766fb to 1ab269e Compare September 3, 2024 17:11
@howardyoo
Copy link
Copy Markdown
Contributor

cc: @howardyoo @ferruzzi ?

The change looks good to me. Thanks for adding these missing attributes to the span :-)

Copy link
Copy Markdown
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.

LGTM. The citations to the definitions in the code are a very nice touch, thanks for those.

@ferruzzi ferruzzi merged commit 0a816c6 into apache:main Sep 3, 2024
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg bot commented Sep 3, 2024

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

@jedcunningham
Copy link
Copy Markdown
Member

Thanks @mattogburke! Congrats on your first commit 🎉

jedcunningham pushed a commit to astronomer/airflow that referenced this pull request Sep 4, 2024
…apache#41899)

* Correct documentation for pool.scheduled_slots metrics

* Add missing pool.scheduled_slots telemetry span

(cherry picked from commit 0a816c6)
Lee-W pushed a commit that referenced this pull request Sep 4, 2024
…#41899) (#41985)

* Correct documentation for pool.scheduled_slots metrics

* Add missing pool.scheduled_slots telemetry span

(cherry picked from commit 0a816c6)

Co-authored-by: Matt Burke <84401060+mattogburke@users.noreply.github.com>
ephraimbuddy pushed a commit that referenced this pull request Sep 13, 2024
…#41899) (#41985)

* Correct documentation for pool.scheduled_slots metrics

* Add missing pool.scheduled_slots telemetry span

(cherry picked from commit 0a816c6)

Co-authored-by: Matt Burke <84401060+mattogburke@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:Scheduler including HA (high availability) scheduler kind:documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants