From 15a1475472bb5abf5a5430b4904a969d118e6d18 Mon Sep 17 00:00:00 2001 From: Tatiana Al-Chueyr Date: Mon, 30 Mar 2026 11:43:14 -0300 Subject: [PATCH] Document missing Cosmos Airflow config settings in cosmos-conf.rst Add entries for rich_logging, dbt_docs_index_file_name, enable_dataset_alias, enable_uri_xcom, and enable_telemetry, which were defined in settings.py but absent from the reference page. Also note the deprecated enable_dataset_airflow3_uri alias under use_dataset_airflow3_uri_standard, and fix the broken RST anchor on virtualenv_max_retries_lock so its cross-reference target works. Co-Authored-By: Claude Sonnet 4.6 --- docs/reference/configs/cosmos-conf.rst | 58 ++++++++++++++++++++++++-- 1 file changed, 55 insertions(+), 3 deletions(-) diff --git a/docs/reference/configs/cosmos-conf.rst b/docs/reference/configs/cosmos-conf.rst index 6f836ee4d6..6dd5f097e1 100644 --- a/docs/reference/configs/cosmos-conf.rst +++ b/docs/reference/configs/cosmos-conf.rst @@ -84,6 +84,15 @@ This page lists all available Airflow configurations that affect ``astronomer-co - Default: ``True`` - Environment Variable: ``AIRFLOW__COSMOS__PROPAGATE_LOGS`` +.. _rich_logging: + +`rich_logging`_: + Enable a custom logger implementation that adds ``(astronomer-cosmos)`` to each log message. + See :ref:`logging` for more details. + + - Default: ``False`` + - Environment Variable: ``AIRFLOW__COSMOS__RICH_LOGGING`` + .. _dbt_docs_projects: `dbt_docs_projects`_: @@ -127,6 +136,14 @@ This page lists all available Airflow configurations that affect ``astronomer-co - Default: ``None`` - Environment Variable: ``AIRFLOW__COSMOS__DBT_DOCS_CONN_ID`` +.. _dbt_docs_index_file_name: + +`dbt_docs_index_file_name`_: + (Applicable to Airflow 2): The filename of the dbt docs index file within ``dbt_docs_dir``. + + - Default: ``index.html`` + - Environment Variable: ``AIRFLOW__COSMOS__DBT_DOCS_INDEX_FILE_NAME`` + .. _default_copy_dbt_packages: `default_copy_dbt_packages`_: @@ -162,11 +179,13 @@ This page lists all available Airflow configurations that affect ``astronomer-co - Default: ``profile`` - Environment Variable: ``AIRFLOW__COSMOS__PROFILE_CACHE_DIR_NAME`` -.. `virtualenv_max_retries_lock`_: - When using ``ExecutionMode.VIRTUALENV`` and persisted virtualenv directories (`virtualenv_dir` argument), +.. _virtualenv_max_retries_lock: + +`virtualenv_max_retries_lock`_: + When using ``ExecutionMode.VIRTUALENV`` and persisted virtualenv directories (``virtualenv_dir`` argument), users can define how many seconds Cosmos waits for the lock to be released. - - Default: 120 + - Default: ``120`` - Environment Variable: ``AIRFLOW__COSMOS__VIRTUALENV_MAX_RETRIES_LOCK`` .. _remote_cache_dir: @@ -248,9 +267,31 @@ This page lists all available Airflow configurations that affect ``astronomer-co `use_dataset_airflow3_uri_standard`_: (Introduced in Cosmos 1.10.0): Changes Cosmos Dataset (Asset) URIs to be Airflow 3 compliant. Since this would be a breaking change, it is False by default in Cosmos 1.x. + + .. note:: + The deprecated key ``enable_dataset_airflow3_uri`` is also accepted and takes precedence if set. + - Default: ``False`` - Environment Variable: ``AIRFLOW__COSMOS__USE_DATASET_AIRFLOW3_URI_STANDARD`` +.. _enable_dataset_alias: + +`enable_dataset_alias`_: + Enable or disable Airflow Dataset alias support when emitting datasets from Cosmos operators. + Requires Airflow >= 2.10. When disabled on Airflow 3+, dataset emission will fail with an error. + + - Default: ``True`` + - Environment Variable: ``AIRFLOW__COSMOS__ENABLE_DATASET_ALIAS`` + +.. _enable_uri_xcom: + +`enable_uri_xcom`_: + When enabled, Cosmos operators push outlet dataset URIs to XCom under the key ``uri`` after each task run. + Useful for downstream tasks or external systems that need to know which datasets were produced. + + - Default: ``False`` + - Environment Variable: ``AIRFLOW__COSMOS__ENABLE_URI_XCOM`` + .. _enable_memory_optimised_imports: `enable_memory_optimised_imports`_: @@ -279,6 +320,17 @@ This page lists all available Airflow configurations that affect ``astronomer-co :start-after: [START cosmos_init_imports] :end-before: [END cosmos_init_imports] +.. _enable_telemetry: + +`enable_telemetry`_: + Enable or disable Cosmos anonymous usage telemetry. Telemetry data is used to understand how Cosmos is used + and to improve the project. No personally identifiable information is collected. Telemetry can also be + disabled by setting the ``DO_NOT_TRACK`` or ``SCARF_NO_ANALYTICS`` environment variables to a truthy value; + any of the three knobs being set will suppress telemetry. + + - Default: ``True`` + - Environment Variable: ``AIRFLOW__COSMOS__ENABLE_TELEMETRY`` + .. _enable_debug_mode: `enable_debug_mode`_: