apache/airflow

Five "otel_*" options appear twice in the "Configuration Reference"

Open

#43,366 opened on 2024年10月24日

GitHub で見る
 (7 comments) (0 reactions) (0 assignees)Python (16,781 forks)batch import
good first issuekind:bugkind:documentationneeds-triage

Repository metrics

Stars
 (44,809 stars)
PR merge metrics
 (平均マージ 7d 18h) (30d で 834 merged PRs)

説明

What do you see as an issue?

In https://github.com/apache/airflow/commit/ccf12026b44685f2d9917cd313676784e63c81af five configuration options have been moved from the "metrics" section to the "traces" section. Unfortunately, they have also been left in "metrics" untouched, and now they are effectively duplicated in the documentation. This is unfortunate, because users cannot easily tell what's the difference between them and which option should they prefer to use.

Here's a list of the duplicated options:

  • otel_debugging_on
  • otel_host
  • otel_on
  • otel_port
  • otel_ssl_active

If you search for them on this page: https://airflow.apache.org/docs/apache-airflow/2.10.2/configurations-ref.html, you'll see that each of them occurs twice.

Solving the problem

The problem can be solved by removing the [metrics] otel_* options from the airflow/config_templates/config.yml file (and keeping the [traces] otel_* options intact).

Anything else

The newer options also have descriptions that do not render as nicely as the old ones in the documentation (the markdown highlights are gone). It may be a good moment to fix this.

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

コントリビューターガイド