組態參考¶

此頁面包含您可以在 airflow.cfg 檔案中設定或使用環境變數的所有可用 Airflow 組態列表。

在所有 Airflow 元件中使用相同的組態。雖然每個元件並非全部都需要，但某些組態需要相同，否則它們將無法如預期般運作。一個很好的例子是 secret_key，它在 Webserver 和 Worker 上應該是相同的，以允許 Webserver 從 Worker 取得日誌。

Webserver 金鑰也用於授權對 Celery Worker 的請求，以便在檢索日誌時使用。但是，使用 secret key 生成的令牌具有短暫的過期時間 - 請確保您在其上運行 Airflow 元件的所有機器上的時間都已同步（例如使用 ntpd），否則當日誌被訪問時，您可能會收到「forbidden」錯誤。

注意

如需更多資訊，請參閱設定組態選項。

供應商特定組態選項¶

某些供應商有自己的組態選項，您可以在供應商的文件中找到其組態的詳細資訊。

您可以在供應商套件特定的組態中找到所有供應商組態

Airflow 組態選項¶

章節

[api]¶

access_control_allow_headers¶

版本 2.1.0 新增。

用於回應預檢請求，以指示在發出實際請求時可以使用哪些 HTTP 標頭。此標頭是伺服器端對瀏覽器的 Access-Control-Request-Headers 標頭的回應。

類型: 字串
預設值: ''
環境變數: AIRFLOW__API__ACCESS_CONTROL_ALLOW_HEADERS

access_control_allow_methods¶

版本 2.1.0 新增。

指定存取資源時允許的方法。

類型: 字串
預設值: ''
環境變數: AIRFLOW__API__ACCESS_CONTROL_ALLOW_METHODS

access_control_allow_origins¶

版本 2.2.0 新增。

指示是否可以與來自給定來源的請求程式碼共享回應。用空格分隔 URL。

類型: 字串
預設值: ''
環境變數: AIRFLOW__API__ACCESS_CONTROL_ALLOW_ORIGINS

auth_backends¶

版本 2.3.0 新增。

用於驗證 API 使用者的逗號分隔的授權後端列表。有關可能的值，請參閱安全性：API。（「airflow.api.auth.backend.default」基於歷史原因允許所有請求）

類型: 字串
預設值: airflow.api.auth.backend.session
環境變數: AIRFLOW__API__AUTH_BACKENDS

enable_experimental_api¶

版本 2.0.0 新增。

啟用已棄用的實驗性 API。請注意，這些 API 端點沒有存取控制。經過身份驗證的使用者擁有完全存取權。

警告

此實驗性 REST API 自 2.0 版本起已棄用。請考慮使用穩定 REST API。有關遷移的更多資訊，請參閱RELEASE_NOTES.rst

類型: 布林值
預設值: False
環境變數: AIRFLOW__API__ENABLE_EXPERIMENTAL_API

enable_xcom_deserialize_support¶

版本 2.7.0 新增。

指示 xcomEntries 端點是否支援 deserialize 標誌。如果設定為 False，則在請求中設定此標誌將導致 400 Bad Request 錯誤。

類型: 布林值
預設值: False
環境變數: AIRFLOW__API__ENABLE_XCOM_DESERIALIZE_SUPPORT

fallback_page_limit¶

版本 2.0.0 新增。

用於在 API 請求中 limit 參數為零或未提供時設定預設頁面限制。否則，如果在 API 請求中傳遞正整數作為限制，則使用者給定限制或最大頁面限制的最小值將作為限制。

類型: 整數
預設值: 100
環境變數: AIRFLOW__API__FALLBACK_PAGE_LIMIT

google_key_path¶

版本 2.0.0 新增。

Google Cloud Service Account 金鑰檔案 (JSON) 的路徑。如果省略，將使用基於應用程式預設憑證的授權。

類型: 字串
預設值: ''
環境變數: AIRFLOW__API__GOOGLE_KEY_PATH
範例: /files/service-account-json

google_oauth2_audience¶

版本 2.0.0 新增。

用於授權的 JWT 令牌憑證的預期受眾。此值必須在用戶端和伺服器端匹配。如果為空，則不會測試受眾。

類型: 字串
預設值: ''
環境變數: AIRFLOW__API__GOOGLE_OAUTH2_AUDIENCE
範例: project-id-random-value.apps.googleusercontent.com

maximum_page_limit¶

版本 2.0.0 新增。

用於設定 API 請求的最大頁面限制。如果作為參數傳遞的限制大於最大頁面限制，則將忽略它，並將最大頁面限制值設定為限制

類型: 整數
預設值: 100
環境變數: AIRFLOW__API__MAXIMUM_PAGE_LIMIT

access_control_allow_origin (已棄用)¶

自版本 2.2.0 起已棄用：該選項已移至 api.access_control_allow_origins

auth_backend (已棄用)¶

自版本 2.3.0 起已棄用：該選項已移至 api.auth_backends

[cli]¶

api_client¶

cli 應以何種方式存取 API。LocalClient 將直接使用資料庫，而 json_client 將使用在 Webserver 上運行的 api

類型: 字串
預設值: airflow.api.client.local_client
環境變數: AIRFLOW__CLI__API_CLIENT

endpoint_url¶

如果您設定了 web_server_url_prefix，請不要忘記在此處附加它，例如：endpoint_url = https://127.0.0.1:8080/myroot 因此 api 將如下所示：https://127.0.0.1:8080/myroot/api/experimental/...

類型: 字串
預設值: https://127.0.0.1:8080
環境變數: AIRFLOW__CLI__ENDPOINT_URL

[core]¶

allowed_deserialization_classes¶

版本 2.5.0 新增。

在反序列化期間可以導入哪些類別。這是一個多行值。個別項目將被解析為 glob 函數的模式。Python 內建模組（如 dict）始終允許。

類型: 字串
預設值: airflow.*
環境變數: AIRFLOW__CORE__ALLOWED_DESERIALIZATION_CLASSES

allowed_deserialization_classes_regexp¶

版本 2.8.2 新增。

在反序列化期間可以導入哪些類別。這是一個多行值。個別項目將被解析為 regexp 模式。這是 [core] allowed_deserialization_classes 的輔助選項。

類型: 字串
預設值: ''
環境變數: AIRFLOW__CORE__ALLOWED_DESERIALIZATION_CLASSES_REGEXP

auth_manager¶

版本 2.7.0 新增。

Airflow 應使用的授權管理器類別。授權管理器類別的完整導入路徑。

類型: 字串
預設值: airflow.providers.fab.auth_manager.fab_auth_manager.FabAuthManager
環境變數: AIRFLOW__CORE__AUTH_MANAGER

check_slas¶

版本 1.10.8 新增。

在每個 dagrun 上檢查定義的 SLA

類型: 字串
預設值: True
環境變數: AIRFLOW__CORE__CHECK_SLAS

compress_serialized_dags¶

版本 2.3.0 新增。

如果 True，序列化的 DAG 將在寫入資料庫之前壓縮。

注意

這將停用 DAG 依賴關係視圖

類型: 字串
預設值: False
環境變數: AIRFLOW__CORE__COMPRESS_SERIALIZED_DAGS

daemon_umask¶

版本 2.3.4 新增。

在守護程序模式（排程器、Worker 等）下運行時，進程使用的預設 umask

這控制了檔案建立模式遮罩，該遮罩確定新建立檔案的檔案權限位的初始值。

此值被視為八進制整數。

類型: 字串
預設值: 0o077
環境變數: AIRFLOW__CORE__DAEMON_UMASK

dag_discovery_safe_mode¶

版本 1.10.3 新增。

如果啟用，Airflow 將僅掃描包含 DAG 和 airflow（不區分大小寫）的檔案。

類型: 字串
預設值: True
環境變數: AIRFLOW__CORE__DAG_DISCOVERY_SAFE_MODE

dag_file_processor_timeout¶

版本 1.10.6 新增。

DagFileProcessor 超時之前的時間長度，DagFileProcessor 處理 dag 檔案

類型: 字串
預設值: 50
環境變數: AIRFLOW__CORE__DAG_FILE_PROCESSOR_TIMEOUT

dag_ignore_file_syntax¶

版本 2.3.0 新增。

.airflowignore 檔案中 DAG 目錄中使用的模式語法。有效值為 regexp 或 glob。

類型: 字串
預設值: regexp
環境變數: AIRFLOW__CORE__DAG_IGNORE_FILE_SYNTAX

dag_run_conf_overrides_params¶

是否使用 dag_run.conf 覆蓋參數。如果您透過 airflow dags backfill -c 或 airflow dags trigger -c 傳遞一些鍵值對，則鍵值對將覆蓋參數中的現有鍵值對。

類型: 字串
預設值: True
環境變數: AIRFLOW__CORE__DAG_RUN_CONF_OVERRIDES_PARAMS

dagbag_import_error_traceback_depth¶

版本 2.0.0 新增。

如果顯示追溯，則應顯示追溯中的多少個條目

類型: 整數
預設值: 2
環境變數: AIRFLOW__CORE__DAGBAG_IMPORT_ERROR_TRACEBACK_DEPTH

dagbag_import_error_tracebacks¶

版本 2.0.0 新增。

是否應在 UI 中顯示 dagbag 導入錯誤的追溯，而不是僅顯示異常消息

類型: 布林值
預設值: True
環境變數: AIRFLOW__CORE__DAGBAG_IMPORT_ERROR_TRACEBACKS

dagbag_import_timeout¶

Python 檔案導入超時之前的時間長度

類型: 浮點數
預設值: 30.0
環境變數: AIRFLOW__CORE__DAGBAG_IMPORT_TIMEOUT

dags_are_paused_at_creation¶

DAG 在建立時是否預設為暫停

類型: 字串
預設值: True
環境變數: AIRFLOW__CORE__DAGS_ARE_PAUSED_AT_CREATION

dags_folder¶

您的 Airflow 管道所在的資料夾，很可能是程式碼儲存庫中的子資料夾。此路徑必須是絕對路徑。

類型: 字串
預設值: {AIRFLOW_HOME}/dags
環境變數: AIRFLOW__CORE__DAGS_FOLDER

database_access_isolation¶

版本 2.6.0 新增。

（實驗性）元件是否應使用 Airflow 內部 API 進行資料庫連線。

類型: 布林值
預設值: False
環境變數: AIRFLOW__CORE__DATABASE_ACCESS_ISOLATION

dataset_manager_class¶

版本 2.4.0 新增。

用作資料集管理器的類別。

類型: 字串
預設值: 無
環境變數: AIRFLOW__CORE__DATASET_MANAGER_CLASS
範例: airflow.datasets.manager.DatasetManager

dataset_manager_kwargs¶

版本 2.4.0 新增。

要提供給資料集管理器的 Kwargs。

類型

字串

預設值

無

環境變數

AIRFLOW__CORE__DATASET_MANAGER_KWARGS

AIRFLOW__CORE__DATASET_MANAGER_KWARGS_CMD

AIRFLOW__CORE__DATASET_MANAGER_KWARGS_SECRET

範例

{"some_param": "some_value"}

default_impersonation¶

如果設定，沒有 run_as_user 引數的任務將以該使用者身份運行。可用於在執行任務時降低運行 Airflow 的 sudo 使用者的權限

類型: 字串
預設值: ''
環境變數: AIRFLOW__CORE__DEFAULT_IMPERSONATION

default_pool_task_slot_count¶

版本 2.2.0 新增。

default_pool 的任務槽計數。此設定在已建立 default_pool 的現有部署中無效。對於現有部署，使用者可以使用 Webserver、API 或 CLI 更改槽的數量

類型: 字串
預設值: 128
環境變數: AIRFLOW__CORE__DEFAULT_POOL_TASK_SLOT_COUNT

default_task_execution_timeout¶

版本 2.3.0 新增。

運算子的預設 task execution_timeout 值。預期將整數值作為秒數傳遞到 timedelta 中。如果未指定，則該值被視為 None，表示運算子預設永遠不會超時。

類型: 整數
預設值: ''
環境變數: AIRFLOW__CORE__DEFAULT_TASK_EXECUTION_TIMEOUT

default_task_retries¶

版本 1.10.6 新增。

每個任務預設將要重試的次數。可以在 dag 或任務級別覆蓋。

類型: 字串
預設值: 0
環境變數: AIRFLOW__CORE__DEFAULT_TASK_RETRIES

default_task_retry_delay¶

版本 2.4.0 新增。

每個任務預設在重試之間等待的秒數。可以在 dag 或任務級別覆蓋。

類型: 整數
預設值: 300
環境變數: AIRFLOW__CORE__DEFAULT_TASK_RETRY_DELAY

default_task_weight_rule¶

版本 2.2.0 新增。

用於任務的有效總優先級權重的加權方法

類型: 字串
預設值: 下游
環境變數: AIRFLOW__CORE__DEFAULT_TASK_WEIGHT_RULE

default_timezone¶

如果提供的日期時間是簡單型別，則預設時區可以是 UTC (預設值)、system 或任何 IANA <https://www.iana.org/time-zones> 時區字串（例如 Europe/Amsterdam）

類型: 字串
預設值: utc
環境變數: AIRFLOW__CORE__DEFAULT_TIMEZONE

donot_pickle¶

是否停用 pickle dags

類型: 字串
預設值: True
環境變數: AIRFLOW__CORE__DONOT_PICKLE

enable_xcom_pickling¶

是否為 xcom 啟用 pickle (請注意，這是不安全的，並且允許 RCE 漏洞利用)。

另請參閱

https://docs.python.org/3/library/pickle.html#comparison-with-json

類型: 字串
預設值: False
環境變數: AIRFLOW__CORE__ENABLE_XCOM_PICKLING

execute_tasks_new_python_interpreter¶

版本 2.0.0 新增。

是否應透過分支父進程來執行任務

False：透過分支父進程執行
True：生成新的 python 進程，比分支慢，但意味著任務立即獲取插件更改

另請參閱

何時（重新）載入插件？

類型: 布林值
預設值: False
環境變數: AIRFLOW__CORE__EXECUTE_TASKS_NEW_PYTHON_INTERPRETER

executor¶

Airflow 應使用的執行器類別。選項包括 SequentialExecutor、LocalExecutor、CeleryExecutor、KubernetesExecutor、CeleryKubernetesExecutor、LocalKubernetesExecutor 或使用自訂執行器時的類別的完整導入路徑。

類型: 字串
預設值: SequentialExecutor
環境變數: AIRFLOW__CORE__EXECUTOR

fernet_key¶

用於將連線密碼保存在資料庫中的密鑰

類型

字串

預設值

{FERNET_KEY}

環境變數

AIRFLOW__CORE__FERNET_KEY

AIRFLOW__CORE__FERNET_KEY_CMD

AIRFLOW__CORE__FERNET_KEY_SECRET

hide_sensitive_var_conn_fields¶

版本 2.1.0 新增。

當設定為 True 時，從 UI 和任務日誌中隱藏敏感的變數或 連線額外 json 鍵

注意

連線密碼始終隱藏在日誌中

類型: 布林值
預設值: True
環境變數: AIRFLOW__CORE__HIDE_SENSITIVE_VAR_CONN_FIELDS

hostname_callable¶

透過提供可調用路徑來指定主機名稱，該路徑將解析主機名稱。格式為「package.function」。

例如，預設值 airflow.utils.net.getfqdn 表示來自 socket.getfqdn() 修補版本的結果，請參閱相關的 CPython 問題。

指定函數中不應需要引數。如果首選使用 IP 位址作為主機名稱，請使用值 airflow.utils.net.get_host_ip_address

類型: 字串
預設值: airflow.utils.net.getfqdn
環境變數: AIRFLOW__CORE__HOSTNAME_CALLABLE

internal_api_secret_key¶

版本 2.10.0 新增。

用於驗證內部 API 用戶端與核心的密鑰。它應該盡可能隨機。但是，當運行多個 Webserver / 內部 API 服務實例時，請確保它們都使用相同的 secret_key，否則呼叫將在身份驗證時失敗。使用 secret key 生成的身份驗證令牌具有短暫的過期時間 - 請確保您在其上運行 Airflow 元件的所有機器上的時間都已同步（例如使用 ntpd），否則當日誌被訪問時，您可能會收到「forbidden」錯誤。

類型

字串

預設值

{SECRET_KEY}

環境變數

AIRFLOW__CORE__INTERNAL_API_SECRET_KEY

AIRFLOW__CORE__INTERNAL_API_SECRET_KEY_CMD

AIRFLOW__CORE__INTERNAL_API_SECRET_KEY_SECRET

internal_api_url¶

版本 2.6.0 新增。

（實驗性）Airflow 內部 API URL。僅當 [core] database_access_isolation 為 True 時使用。

類型: 字串
預設值: 無
環境變數: AIRFLOW__CORE__INTERNAL_API_URL
範例: https://127.0.0.1:8080

killed_task_cleanup_time¶

當強制終止任務時，這是任務在收到 SIGTERM 後有時間清理的時間量（以秒為單位），然後再被 SIGKILL

類型: 字串
預設值: 60
環境變數: AIRFLOW__CORE__KILLED_TASK_CLEANUP_TIME

lazy_discover_providers¶

版本 2.0.0 新增。

預設情況下，Airflow 提供者是延遲探索的（僅在需要時進行探索和導入）。如果您希望在每次透過 CLI 呼叫 'airflow' 或從模組載入時探索提供者，請將其設定為 False。

類型: 布林值
預設值: True
環境變數: AIRFLOW__CORE__LAZY_DISCOVER_PROVIDERS

lazy_load_plugins¶

版本 2.0.0 新增。

預設情況下，Airflow 外掛程式是延遲載入的（僅在需要時載入）。如果您希望在每次透過 CLI 呼叫 'airflow' 或從模組載入時載入外掛程式，請將其設定為 False。

類型: 布林值
預設值: True
環境變數: AIRFLOW__CORE__LAZY_LOAD_PLUGINS

load_examples¶

是否載入 Airflow 隨附的 DAG 範例。這對於入門很好，但在生產環境中，您可能希望將其設定為 False。

類型: 字串
預設值: True
環境變數: AIRFLOW__CORE__LOAD_EXAMPLES

max_active_runs_per_dag¶

每個 DAG 的最大活動 DAG 執行次數。如果達到限制，排程器將不會建立更多 DAG 執行。這可以在 DAG 層級使用 max_active_runs 進行配置，預設值為 [core] max_active_runs_per_dag。

類型: 字串
預設值: 16
環境變數: AIRFLOW__CORE__MAX_ACTIVE_RUNS_PER_DAG

max_active_tasks_per_dag¶

版本 2.2.0 新增。

每個 DAG 中允許同時執行的最大任務實例數。若要計算 DAG 同時執行的任務數，請將 DAG 所有 DAG 執行的執行中任務數加總。這可以在 DAG 層級使用 max_active_tasks 進行配置，預設值為 [core] max_active_tasks_per_dag。

當您想要阻止具有較早開始日期的新 DAG 佔用叢集中所有執行器插槽時，此功能會很有用。

類型: 字串
預設值: 16
環境變數: AIRFLOW__CORE__MAX_ACTIVE_TASKS_PER_DAG

max_consecutive_failed_dag_runs_per_dag¶

版本 2.9.0 新增功能。

(實驗性) DAG 自動暫停前的最大連續 DAG 失敗次數。這也可以在 DAG 層級使用 max_consecutive_failed_dag_runs 進行配置，預設值為 [core] max_consecutive_failed_dag_runs_per_dag。如果未指定，則該值視為 0，表示 DAG 預設永遠不會暫停。

類型: 字串
預設值: 0
環境變數: AIRFLOW__CORE__MAX_CONSECUTIVE_FAILED_DAG_RUNS_PER_DAG

max_map_length¶

版本 2.3.0 新增。

XCom 可以推送以觸發任務映射的最大列表/字典長度。如果推送的列表/字典長度超過此值，推送 XCom 的任務將自動失敗，以防止映射的任務阻塞排程器。

類型: 整數
預設值: 1024
環境變數: AIRFLOW__CORE__MAX_MAP_LENGTH

max_num_rendered_ti_fields_per_task¶

版本 1.10.10 新增功能。

每個任務要儲存在資料庫中的最大呈現任務實例欄位（範本欄位）數量。每個任務實例的所有 template_fields 都儲存在資料庫中。保持此數字較小可能會導致錯誤，當您嘗試在舊任務的 TaskInstance 視圖中查看 Rendered 標籤時。

類型: 整數
預設值: 30
環境變數: AIRFLOW__CORE__MAX_NUM_RENDERED_TI_FIELDS_PER_TASK

max_task_retry_delay¶

版本 2.6.0 新增。

每個任務在重試之間預設等待的最大延遲時間（以秒為單位）。這是一個全域設定，無法在任務或 DAG 層級覆寫。

類型: 整數
預設值: 86400
環境變數: AIRFLOW__CORE__MAX_TASK_RETRY_DELAY

max_templated_field_length¶

版本 2.9.0 新增功能。

呈現的範本欄位的最大長度。如果要在呈現的範本欄位中的值超過此大小，則會被編輯。

類型: 整數
預設值: 4096
環境變數: AIRFLOW__CORE__MAX_TEMPLATED_FIELD_LENGTH

might_contain_dag_callable¶

版本 2.6.0 新增。

一個可呼叫物件，用於檢查 Python 檔案是否已定義 Airflow DAG，如果已定義 DAG，則應傳回 True，否則傳回 False。如果未提供此物件，Airflow 將使用其自身的啟發式規則。

該函式應具有以下簽章

def func_name(file_path: str, zip_file: zipfile.ZipFile | None = None) -> bool: ...

類型: 字串
預設值: airflow.utils.file.might_contain_dag_via_default_heuristic
環境變數: AIRFLOW__CORE__MIGHT_CONTAIN_DAG_CALLABLE

min_serialized_dag_fetch_interval¶

版本 1.10.12 新增功能。

抓取序列化 DAG 的速度不能快於最小間隔，以降低資料庫讀取速率。此設定控制您的 DAG 在 Web 伺服器中更新的時間。

類型: 字串
預設值: 10
環境變數: AIRFLOW__CORE__MIN_SERIALIZED_DAG_FETCH_INTERVAL

min_serialized_dag_update_interval¶

版本 1.10.7 新增功能。

更新序列化 DAG 的速度不能快於最小間隔，以降低資料庫寫入速率。

類型: 字串
預設值: 30
環境變數: AIRFLOW__CORE__MIN_SERIALIZED_DAG_UPDATE_INTERVAL

mp_start_method¶

版本 2.0.0 新增。

用於透過 multiprocessing 模組啟動 Python 程序的方法名稱。這直接對應於 Python 文件中提供的選項：multiprocessing.set_start_method 必須是 multiprocessing.get_all_start_methods() 傳回的值之一。

類型: 字串
預設值: 無
環境變數: AIRFLOW__CORE__MP_START_METHOD
範例: fork

parallelism¶

這定義了在 Airflow 中每個排程器可以同時執行的最大任務實例數，無論工作程式數量為何。一般而言，此值乘以叢集中排程器的數量，就是中繼資料庫中處於執行狀態的最大任務實例數。將此值設定為零可允許無限並行。

類型: 字串
預設值: 32
環境變數: AIRFLOW__CORE__PARALLELISM

plugins_folder¶

包含 Airflow 外掛程式的資料夾路徑

類型: 字串
預設值: {AIRFLOW_HOME}/plugins
環境變數: AIRFLOW__CORE__PLUGINS_FOLDER

security¶

要使用的安全性模組（例如 Kerberos）

類型: 字串
預設值: ''
環境變數: AIRFLOW__CORE__SECURITY

sensitive_var_conn_names¶

版本 2.1.0 新增。

以逗號分隔的額外敏感關鍵字列表，用於在變數名稱或連線的額外 JSON 中尋找。

類型: 字串
預設值: ''
環境變數: AIRFLOW__CORE__SENSITIVE_VAR_CONN_NAMES

strict_dataset_uri_validation¶

版本 2.9.2 新增功能。

如果資料集 URI 不符合 AIP-60，則資料集 URI 驗證應引發例外。預設情況下，此配置為 false，表示 Airflow 2.x 僅警告使用者。在 Airflow 3 中，此配置將被移除，無條件啟用嚴格驗證。

類型: 布林值
預設值: False
環境變數: AIRFLOW__CORE__STRICT_DATASET_URI_VALIDATION

task_runner¶

用於在子程序中執行任務實例的類別。選項包括 StandardTaskRunner、CgroupTaskRunner 或使用自訂任務執行器時的類別完整導入路徑。

類型: 字串
預設值: StandardTaskRunner
環境變數: AIRFLOW__CORE__TASK_RUNNER

task_success_overtime¶

版本 2.10.0 新增。

任務標記為成功後，任務可用於執行輔助程序（例如監聽器、迷你排程器...）的最大可能時間（以秒為單位）。

類型: 整數
預設值: 20
環境變數: AIRFLOW__CORE__TASK_SUCCESS_OVERTIME

test_connection¶

版本 2.7.0 新增。

允許跨 Airflow UI、API 和 CLI 測試連線的功能。支援的選項：Disabled、Enabled、Hidden。預設值：Disabled。 Disabled - 停用測試連線功能並停用 UI 中的「測試連線」按鈕。 Enabled - 啟用測試連線功能並在 UI 中顯示「測試連線」按鈕。 Hidden - 停用測試連線功能並隱藏 UI 中的「測試連線」按鈕。在將其設定為 Enabled 之前，請確保您審查能夠新增/編輯連線的使用者，並確保他們是受信任的。連線測試可能會被惡意執行，導致不良和不安全的結果。有關更多詳細資訊，請參閱 Airflow 安全模型：已驗證 UI 使用者的功能。

類型: 字串
預設值: Disabled
環境變數: AIRFLOW__CORE__TEST_CONNECTION

unit_test_mode¶

開啟單元測試模式（在執行時使用測試值覆寫許多組態選項）

類型: 字串
預設值: False
環境變數: AIRFLOW__CORE__UNIT_TEST_MODE

xcom_backend¶

版本 1.10.12 新增功能。

自訂 XCom 類別的路徑，該類別將用於儲存和解析運算子結果

類型: 字串
預設值: airflow.models.xcom.BaseXCom
環境變數: AIRFLOW__CORE__XCOM_BACKEND
範例: path.to.CustomXCom

base_log_folder (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.base_log_folder

colored_console_log (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.colored_console_log

colored_formatter_class (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.colored_formatter_class

colored_log_format (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.colored_log_format

dag_concurrency (已棄用)¶

自 2.2.0 版本起已棄用：此選項已移至 core.max_active_tasks_per_dag

dag_processor_manager_log_location (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.dag_processor_manager_log_location

encrypt_s3_logs (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.encrypt_s3_logs

fab_logging_level (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.fab_logging_level

interleave_timestamp_parser (已棄用)¶

自 2.6.1 版本起已棄用：此選項已移至 logging.interleave_timestamp_parser

load_default_connections (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.load_default_connections

log_filename_template (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.log_filename_template

log_format (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.log_format

log_processor_filename_template (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.log_processor_filename_template

logging_config_class (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.logging_config_class

logging_level (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.logging_level

max_db_retries (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.max_db_retries

non_pooled_task_slot_count (已棄用)¶

自 1.10.4 版本起已棄用：此選項已移至 core.default_pool_task_slot_count

remote_base_log_folder (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.remote_base_log_folder

remote_log_conn_id (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.remote_log_conn_id

remote_logging (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.remote_logging

simple_log_format (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.simple_log_format

sql_alchemy_conn (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_alchemy_conn

sql_alchemy_connect_args (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_alchemy_connect_args

sql_alchemy_max_overflow (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_alchemy_max_overflow

sql_alchemy_pool_enabled (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_alchemy_pool_enabled

sql_alchemy_pool_pre_ping (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_alchemy_pool_pre_ping

sql_alchemy_pool_recycle (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_alchemy_pool_recycle

sql_alchemy_pool_size (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_alchemy_pool_size

sql_alchemy_schema (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_alchemy_schema

sql_engine_collation_for_ids (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_engine_collation_for_ids

sql_engine_encoding (已棄用)¶

自 2.3.0 版本起已棄用：此選項已移至 database.sql_engine_encoding

task_log_prefix_template (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.task_log_prefix_template

task_log_reader (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 logging.task_log_reader

worker_precheck (已棄用)¶

自 2.0.0 版本起已棄用：此選項已移至 celery.worker_precheck

[database]¶

alembic_ini_file_path¶

版本 2.7.0 新增。

alembic.ini` 檔案的路徑。您可以提供相對於 Airflow Home 目錄的檔案路徑，或者如果檔案位於其他位置，則提供絕對路徑。

類型: 字串
預設值: alembic.ini
環境變數: AIRFLOW__DATABASE__ALEMBIC_INI_FILE_PATH

check_migrations¶

版本 2.6.0 新增。

是否在 Airflow 啟動期間執行 Alembic 遷移。有時此操作可能很耗費資源，使用者可以透過其他方式（例如透過 Helm Chart）斷言正確的版本。接受 True 或 False。

類型: 字串
預設值: True
環境變數: AIRFLOW__DATABASE__CHECK_MIGRATIONS

load_default_connections¶

版本 2.3.0 新增。

當呼叫 airflow db init` 時，是否載入 Airflow 隨附的預設連線。這對於入門很好，但在生產環境中，您可能希望將其設定為 False。

自 2.7.0 版本起已棄用：此選項僅由已棄用的 “airflow db init” 命令使用。在先前版本的 Airflow 中，此選項用於判斷是否使用 `airflow db init` 命令載入預設連線。此命令已被棄用，並由兩個獨立的命令 `airflow db migrate` 和 `airflow connections create-default-connections` 取代，且 `load_default_connections` 不再被這些命令使用。

類型: 字串
預設值: True
環境變數: AIRFLOW__DATABASE__LOAD_DEFAULT_CONNECTIONS

max_db_retries¶

版本 2.3.0 新增。

在發生資料庫操作錯誤時，程式碼應重試的次數。並非所有交易都會重試，因為這可能會導致不想要的狀態。目前僅在 `DagFileProcessor.process_file` 中使用，以重試 `dagbag.sync_to_db`。

類型: 整數
預設值: 3
環境變數: AIRFLOW__DATABASE__MAX_DB_RETRIES

sql_alchemy_conn¶

版本 2.3.0 新增。

連接到中繼資料庫的 SQLAlchemy 連線字串。SQLAlchemy 支援許多不同的資料庫引擎。有關更多詳細資訊，請參閱：設定資料庫後端：資料庫 URI。

類型

字串

預設值

sqlite:///{AIRFLOW_HOME}/airflow.db

環境變數

AIRFLOW__DATABASE__SQL_ALCHEMY_CONN

AIRFLOW__DATABASE__SQL_ALCHEMY_CONN_CMD

AIRFLOW__DATABASE__SQL_ALCHEMY_CONN_SECRET

sql_alchemy_connect_args¶

版本 2.3.0 新增。

SQLAlchemy 中連線引數的匯入路徑。預設為空字典。當您想要配置 SQLAlchemy 無法在連線字串中解析的資料庫引擎引數時，這很有用。可以透過傳遞包含建立引擎參數的字典來設定。有關在 Postgres 資料庫後端中傳遞建立引擎參數（keepalives 變數、逾時等）的更多詳細資訊，請參閱設定 PostgreSQL 資料庫，例如 `connect_args={"timeout":30}` 可以在 `airflow_local_settings.py` 中定義，並且可以如下所示匯入

類型: 字串
預設值: 無
環境變數: AIRFLOW__DATABASE__SQL_ALCHEMY_CONNECT_ARGS
範例: airflow_local_settings.connect_args

sql_alchemy_engine_args¶

版本 2.3.0 新增。

傳遞給 SQLAlchemy create_engine 的額外引擎特定關鍵字引數，作為 JSON 編碼值

類型

字串

預設值

無

環境變數

AIRFLOW__DATABASE__SQL_ALCHEMY_ENGINE_ARGS

AIRFLOW__DATABASE__SQL_ALCHEMY_ENGINE_ARGS_CMD

AIRFLOW__DATABASE__SQL_ALCHEMY_ENGINE_ARGS_SECRET

範例

{"arg1": true}

sql_alchemy_max_overflow¶

版本 2.3.0 新增。

連線池的最大溢位大小。當已檢查出的連線數達到 pool_size 中設定的大小時，將傳回額外連線，直到達到此限制。當這些額外連線傳回連線池時，它們會斷開連線並捨棄。因此，連線池將允許的同時連線總數為 **pool_size** + **max_overflow**，而連線池將允許的「閒置」連線總數為 pool_size。 max_overflow 可以設定為 -1` 以表示沒有溢位限制；對並行連線總數沒有限制。預設值為 10。

類型: 字串
預設值: 10
環境變數: AIRFLOW__DATABASE__SQL_ALCHEMY_MAX_OVERFLOW

sql_alchemy_pool_enabled¶

版本 2.3.0 新增。

是否應由 SQLAlchemy 管理資料庫連線池。

類型: 字串
預設值: True
環境變數: AIRFLOW__DATABASE__SQL_ALCHEMY_POOL_ENABLED

sql_alchemy_pool_pre_ping¶

版本 2.3.0 新增。

在每次連線池簽出開始時檢查連線。通常，這是一個簡單的語句，例如 “SELECT 1”。有關更多詳細資訊，請參閱 SQLAlchemy 連線池：斷線處理 - 悲觀。

類型: 字串
預設值: True
環境變數: AIRFLOW__DATABASE__SQL_ALCHEMY_POOL_PRE_PING

sql_alchemy_pool_recycle¶

版本 2.3.0 新增。

SQLAlchemy 連線池回收是在連線池中連線閒置多少秒後失效的秒數。此設定不適用於 sqlite。如果 DB 連線數超過限制，較低的配置值將允許系統更快地恢復。

類型: 字串
預設值: 1800
環境變數: AIRFLOW__DATABASE__SQL_ALCHEMY_POOL_RECYCLE

sql_alchemy_pool_size¶

版本 2.3.0 新增。

SQLAlchemy 連線池大小是連線池中資料庫連線的最大數量。0 表示沒有限制。

類型: 字串
預設值: 5
環境變數: AIRFLOW__DATABASE__SQL_ALCHEMY_POOL_SIZE

sql_alchemy_schema¶

版本 2.3.0 新增。

用於中繼資料庫的結構描述。SQLAlchemy 支援具有多個結構描述概念的資料庫。

類型: 字串
預設值: ''
環境變數: AIRFLOW__DATABASE__SQL_ALCHEMY_SCHEMA

sql_alchemy_session_maker¶

版本 2.9.4 新增功能。

重要警告：強烈建議不要使用 sql_alchemy_session_maker。傳回 ‘sqlalchemy.orm.sessionmaker’ 的函式的匯入路徑。不當配置 sql_alchemy_session_maker 可能會導致嚴重的問題，包括資料損壞、無法復原的應用程式崩潰。請查閱 SQLAlchemy 文件，以取得有關正確配置和最佳實務的詳細指南。

類型: 字串
預設值: 無
環境變數: AIRFLOW__DATABASE__SQL_ALCHEMY_SESSION_MAKER
範例: airflow_local_settings._sessionmaker

sql_engine_collation_for_ids¶

版本 2.3.0 新增。

針對 dag_id、task_id、key、external_executor_id 欄位進行排序，以防它們具有不同的編碼。預設情況下，此定序與資料庫定序相同，但是對於 mysql 和 mariadb，預設值為 utf8mb3_bin，這樣我們的索引鍵的索引大小將不會超過當定序設定為 utf8mb4 變體時允許的最大索引大小，詳情請參閱 GitHub Issue Comment。

類型: 字串
預設值: 無
環境變數: AIRFLOW__DATABASE__SQL_ENGINE_COLLATION_FOR_IDS

sql_engine_encoding¶

版本 2.3.0 新增。

資料庫的編碼

類型: 字串
預設值: utf-8
環境變數: AIRFLOW__DATABASE__SQL_ENGINE_ENCODING

[debug]¶

fail_fast¶

版本 1.10.8 新增。

僅與 DebugExecutor 一起使用。如果設定為 True，DAG 將在第一個失敗的任務時失敗。有助於除錯目的。

類型: 字串
預設值: False
環境變數: AIRFLOW__DEBUG__FAIL_FAST

[email]¶

設定電子郵件後端以及是否在重試或失敗時發送電子郵件警報

default_email_on_failure¶

版本 2.0.0 新增。

當任務失敗時是否應發送電子郵件警報

類型: 布林值
預設值: True
環境變數: AIRFLOW__EMAIL__DEFAULT_EMAIL_ON_FAILURE

default_email_on_retry¶

版本 2.0.0 新增。

當任務重試時是否應發送電子郵件警報

類型: 布林值
預設值: True
環境變數: AIRFLOW__EMAIL__DEFAULT_EMAIL_ON_RETRY

email_backend¶

要使用的電子郵件後端

類型: 字串
預設值: airflow.utils.email.send_email_smtp
環境變數: AIRFLOW__EMAIL__EMAIL_BACKEND

email_conn_id¶

版本 2.1.0 新增。

要使用的電子郵件連線

類型: 字串
預設值: smtp_default
環境變數: AIRFLOW__EMAIL__EMAIL_CONN_ID

from_email¶

2.2.4 版本的新功能。

將用作寄件者地址的電子郵件地址。它可以是原始電子郵件，也可以是 Sender Name <sender@email.com> 格式的完整地址

類型: 字串
預設值: 無
環境變數: AIRFLOW__EMAIL__FROM_EMAIL
範例: Airflow <airflow@example.com>

html_content_template¶

2.0.1 版本的新功能。

將用作電子郵件內容範本的檔案（將使用 Jinja2 渲染）。如果未設定，Airflow 將使用基本範本。

另請參閱

電子郵件設定

類型: 字串
預設值: 無
環境變數: AIRFLOW__EMAIL__HTML_CONTENT_TEMPLATE
範例: /path/to/my_html_content_template_file

ssl_context¶

版本 2.7.0 新增。

使用 SMTP 和 IMAP SSL 連線時要使用的 ssl context。預設情況下，context 為「default」，會將其設定為 ssl.create_default_context()，這在相容性和安全性之間取得適當的平衡，但是它要求您作業系統中的憑證已更新，並且您的 SMTP/IMAP 伺服器具有有效的憑證，這些憑證已在您的機器上安裝了對應的公開金鑰。如果您想停用憑證檢查，可以將其切換為「none」，但不建議這樣做，因為如果您的基礎架構安全性不足，這會允許 MITM（中間人）攻擊。只有在您修復憑證設定時才應暫時設定它。這通常可以透過升級到您執行 Airflow 元件的作業系統的較新版本、透過升級/刷新作業系統中的正確憑證或透過更新郵件伺服器的憑證來完成。

類型: 字串
預設值: default
環境變數: AIRFLOW__EMAIL__SSL_CONTEXT
範例: default

subject_template¶

2.0.1 版本的新功能。

將用作電子郵件主旨範本的檔案（將使用 Jinja2 渲染）。如果未設定，Airflow 將使用基本範本。

另請參閱

電子郵件設定

類型: 字串
預設值: 無
環境變數: AIRFLOW__EMAIL__SUBJECT_TEMPLATE
範例: /path/to/my_subject_template_file

[kerberos]¶

ccache¶

執行 kinit 後，您的 ccache 檔案的位置。

類型: 字串
預設值: /tmp/airflow_krb5_ccache
環境變數: AIRFLOW__KERBEROS__CCACHE

forwardable¶

版本 2.2.0 新增。

允許停用票證轉發功能。

類型: 布林值
預設值: True
環境變數: AIRFLOW__KERBEROS__FORWARDABLE

include_ip¶

版本 2.2.0 新增。

允許從權杖中移除來源 IP，當在 NAT Docker 主機後方使用權杖時很有用。

類型: 布林值
預設值: True
環境變數: AIRFLOW__KERBEROS__INCLUDE_IP

keytab¶

指定 Airflow 使用者的 Kerberos keytab 檔案的路徑

類型: 字串
預設值: airflow.keytab
環境變數: AIRFLOW__KERBEROS__KEYTAB

kinit_path¶

kinit 可執行檔的路徑

類型: 字串
預設值: kinit
環境變數: AIRFLOW__KERBEROS__KINIT_PATH

principal¶

會以 fqdn 擴充

類型: 字串
預設值: airflow
環境變數: AIRFLOW__KERBEROS__PRINCIPAL

reinit_frequency¶

決定初始化或重新初始化程序發生的頻率。

類型: 字串
預設值: 3600
環境變數: AIRFLOW__KERBEROS__REINIT_FREQUENCY

[lineage]¶

backend¶

要使用的 lineage 後端

類型: 字串
預設值: ''
環境變數: AIRFLOW__LINEAGE__BACKEND

[logging]¶

base_log_folder¶

版本 2.0.0 新增。

Airflow 應儲存其日誌檔案的資料夾。此路徑必須是絕對路徑。有一些現有的設定假設已將其設定為預設值。如果您選擇覆寫此設定，您可能還需要更新 [logging] dag_processor_manager_log_location 和 [logging] child_process_log_directory settings 設定。

類型: 字串
預設值: {AIRFLOW_HOME}/logs
環境變數: AIRFLOW__LOGGING__BASE_LOG_FOLDER

celery_logging_level¶

版本 2.3.0 新增。

Celery 的日誌記錄層級。如果未設定，則使用 logging_level 的值

支援的值：CRITICAL、ERROR、WARNING、INFO、DEBUG。

類型: 字串
預設值: ''
環境變數: AIRFLOW__LOGGING__CELERY_LOGGING_LEVEL

celery_stdout_stderr_separation¶

版本 2.7.0 新增。

預設情況下，Celery 會將所有日誌傳送到 stderr。如果啟用，任何先前的日誌記錄處理常式都將被移除。使用此選項，Airflow 將建立新的處理常式，並將低層級日誌（如 INFO 和 WARNING）傳送到 stdout，同時將較高嚴重性層級的日誌傳送到 stderr。

類型: 布林值
預設值: False
環境變數: AIRFLOW__LOGGING__CELERY_STDOUT_STDERR_SEPARATION

color_log_error_keywords¶

版本 2.10.0 新增。

以逗號分隔的與錯誤相關的關鍵字清單，這些關鍵字的出現應在 UI 中以紅色顯示該行

類型: 字串
預設值: error,exception
環境變數: AIRFLOW__LOGGING__COLOR_LOG_ERROR_KEYWORDS

color_log_warning_keywords¶

版本 2.10.0 新增。

以逗號分隔的與警告相關的關鍵字清單，這些關鍵字的出現應在 UI 中以黃色顯示該行

類型: 字串
預設值: warn
環境變數: AIRFLOW__LOGGING__COLOR_LOG_WARNING_KEYWORDS

colored_console_log¶

版本 2.0.0 新增。

啟用/停用主控台中的彩色日誌的旗標。當控制終端是 TTY 時，為日誌著色。

類型: 字串
預設值: True
環境變數: AIRFLOW__LOGGING__COLORED_CONSOLE_LOG

colored_formatter_class¶

版本 2.0.0 新增。

指定 Airflow 用於實作彩色日誌記錄的類別

類型: 字串
預設值: airflow.utils.log.colored_log.CustomTTYColoredFormatter
環境變數: AIRFLOW__LOGGING__COLORED_FORMATTER_CLASS

colored_log_format¶

版本 2.0.0 新增。

啟用彩色日誌時的日誌格式

類型: 字串
預設值: [%%(blue)s%%(asctime)s%%(reset)s] {%%(blue)s%%(filename)s:%%(reset)s%%(lineno)d} %%(log_color)s%%(levelname)s%%(reset)s - %%(log_color)s%%(message)s%%(reset)s
環境變數: AIRFLOW__LOGGING__COLORED_LOG_FORMAT

dag_processor_log_format¶

版本 2.4.0 新增。

Dag 處理器日誌行的格式

類型: 字串
預設值: [%%(asctime)s] [SOURCE:DAG_PROCESSOR] {%%(filename)s:%%(lineno)d} %%(levelname)s - %%(message)s
環境變數: AIRFLOW__LOGGING__DAG_PROCESSOR_LOG_FORMAT

dag_processor_log_target¶

版本 2.4.0 新增。

將 dag parser 日誌傳送到何處。如果為「file」，則日誌會傳送到 child_process_log_directory 定義的日誌檔案。

類型: 字串
預設值: file
環境變數: AIRFLOW__LOGGING__DAG_PROCESSOR_LOG_TARGET

dag_processor_manager_log_location¶

版本 2.0.0 新增。

dag_processor_manager 日誌檔案的完整路徑。

類型: 字串
預設值: {AIRFLOW_HOME}/logs/dag_processor_manager/dag_processor_manager.log
環境變數: AIRFLOW__LOGGING__DAG_PROCESSOR_MANAGER_LOG_LOCATION

dag_processor_manager_log_stdout¶

版本 2.9.0 新增功能。

DAG 處理器管理員是否會將日誌寫入 stdout

類型: 布林值
預設值: False
環境變數: AIRFLOW__LOGGING__DAG_PROCESSOR_MANAGER_LOG_STDOUT

delete_local_logs¶

版本 2.6.0 新增。

是否應在將 GCS、S3、WASB 和 OSS 遠端日誌記錄的本機日誌檔案上傳到遠端位置後將其刪除。

類型: 字串
預設值: False
環境變數: AIRFLOW__LOGGING__DELETE_LOCAL_LOGS

enable_task_context_logger¶

2.8.0 版本的新功能。

如果啟用，Airflow 可以從任務執行環境之外（例如，從排程器、執行器或回呼執行環境）將訊息傳送到任務日誌。這在某些情況下很有幫助，例如當有東西阻礙任務執行並且通常可能根本沒有任務日誌時。預設情況下，此設定為 True。如果您遇到此功能的問題（例如，排程器效能問題），可以停用它。

類型: 布林值
預設值: True
環境變數: AIRFLOW__LOGGING__ENABLE_TASK_CONTEXT_LOGGER

encrypt_s3_logs¶

版本 2.0.0 新增。

對儲存在 S3 中的日誌使用伺服器端加密

類型: 字串
預設值: False
環境變數: AIRFLOW__LOGGING__ENCRYPT_S3_LOGS

extra_logger_names¶

版本 2.0.0 新增。

以逗號分隔的協力廠商記錄器名稱清單，這些記錄器將設定為將訊息列印到主控台。

類型: 字串
預設值: ''
環境變數: AIRFLOW__LOGGING__EXTRA_LOGGER_NAMES
範例: connexion,sqlalchemy

fab_logging_level¶

版本 2.0.0 新增。

Flask-appbuilder UI 的日誌記錄層級。

支援的值：CRITICAL、ERROR、WARNING、INFO、DEBUG。

類型: 字串
預設值: WARNING
環境變數: AIRFLOW__LOGGING__FAB_LOGGING_LEVEL

file_task_handler_new_file_permissions¶

版本 2.6.0 新增。

以 chmod 理解的八進位字串形式表示的權限。當您使用模擬時，權限很重要，此時日誌是由與 airflow 不同的使用者寫入的。在這種情況下，最安全的設定方式是將兩個使用者新增到同一個群組，並使其成為兩個使用者的預設群組。群組可寫入的日誌是 airflow 中的預設值，但您可能會認為您可以接受日誌是其他使用者可寫入的，在這種情況下，您應該將其設定為 0o666。如果您不使用模擬並將其變更為 0o644 使其僅為擁有者可寫入，則您可能會決定新增更多安全性。如果您的所有日誌存取（讀取/寫入）都來自同一個使用者，您也可以將其變更為 0o600 使其僅為擁有者可讀取。

類型: 字串
預設值: 0o664
環境變數: AIRFLOW__LOGGING__FILE_TASK_HANDLER_NEW_FILE_PERMISSIONS
範例: 0o664

file_task_handler_new_folder_permissions¶

版本 2.6.0 新增。

以 chmod 理解的八進位字串形式表示的權限。當您使用模擬時，權限很重要，此時日誌是由與 airflow 不同的使用者寫入的。在這種情況下，最安全的設定方式是將兩個使用者新增到同一個群組，並使其成為兩個使用者的預設群組。群組可寫入的日誌是 airflow 中的預設值，但您可能會認為您可以接受日誌是其他使用者可寫入的，在這種情況下，您應該將其設定為 0o777。如果您不使用模擬並將其變更為 0o755 使其僅為擁有者可寫入，則您可能會決定新增更多安全性。如果您的所有日誌存取（讀取/寫入）都來自同一個使用者，您也可以將其變更為 0o700 使其僅為擁有者可讀取。

類型: 字串
預設值: 0o775
環境變數: AIRFLOW__LOGGING__FILE_TASK_HANDLER_NEW_FOLDER_PERMISSIONS
範例: 0o775

google_key_path¶

版本 2.0.0 新增。

Google 憑證 JSON 檔案的路徑。如果省略，將使用基於應用程式預設憑證的授權。

類型: 字串
預設值: ''
環境變數: AIRFLOW__LOGGING__GOOGLE_KEY_PATH

interleave_timestamp_parser¶

版本 2.6.0 新增。

我們必須剖析時間戳記，才能在觸發器和任務之間交錯日誌。為此，我們需要剖析日誌檔案中的時間戳記。如果您的日誌格式是非標準的，您可以提供可呼叫物件的匯入路徑，該物件接受字串日誌行並傳回時間戳記（與 datetime.datetime 相容）。

類型: 字串
預設值: 無
環境變數: AIRFLOW__LOGGING__INTERLEAVE_TIMESTAMP_PARSER
範例: path.to.my_func

log_filename_template¶

版本 2.0.0 新增。

Airflow 如何為每個任務執行產生檔案名稱/路徑的格式。

類型: 字串
預設值: dag_id={ ti.dag_id }/run_id={ ti.run_id }/task_id={ ti.task_id }/{%% if ti.map_index >= 0 %%}map_index={ ti.map_index }/{%% endif %%}attempt={ try_number }.log
環境變數: AIRFLOW__LOGGING__LOG_FILENAME_TEMPLATE

log_format¶

版本 2.0.0 新增。

日誌行的格式

類型: 字串
預設值: [%%(asctime)s] {%%(filename)s:%%(lineno)d} %%(levelname)s - %%(message)s
環境變數: AIRFLOW__LOGGING__LOG_FORMAT

log_formatter_class¶

版本 2.3.4 新增。

決定 Airflow 用於建構其日誌訊息的格式器類別。預設格式器類別可感知時區，這表示附加到日誌項目的時間戳記將會調整以反映 Airflow 執行個體的本地時區

類型: 字串
預設值: airflow.utils.log.timezone_aware.TimezoneAware
環境變數: AIRFLOW__LOGGING__LOG_FORMATTER_CLASS

log_processor_filename_template¶

版本 2.0.0 新增。

Airflow 如何產生日誌檔案名稱的格式

類型: 字串
預設值: { filename }.log
環境變數: AIRFLOW__LOGGING__LOG_PROCESSOR_FILENAME_TEMPLATE

logging_config_class¶

版本 2.0.0 新增。

日誌記錄類別。指定將指定日誌記錄設定的類別。此類別必須位於 python 類別路徑上

類型: 字串
預設值: ''
環境變數: AIRFLOW__LOGGING__LOGGING_CONFIG_CLASS
範例: my.path.default_local_settings.LOGGING_CONFIG

logging_level¶

版本 2.0.0 新增。

日誌記錄層級。

支援的值：CRITICAL、ERROR、WARNING、INFO、DEBUG。

類型: 字串
預設值: INFO
環境變數: AIRFLOW__LOGGING__LOGGING_LEVEL

remote_base_log_folder¶

版本 2.0.0 新增。

用於遠端日誌記錄的儲存貯體 URL。S3 貯體應以 s3:// 開頭。Cloudwatch 日誌群組應以 cloudwatch:// 開頭。GCS 貯體應以 gs:// 開頭。WASB 貯體應以 wasb 開頭，以協助 Airflow 選取正確的處理常式。Stackdriver 日誌應以 stackdriver:// 開頭

類型: 字串
預設值: ''
環境變數: AIRFLOW__LOGGING__REMOTE_BASE_LOG_FOLDER

remote_log_conn_id¶

版本 2.0.0 新增。

使用者必須提供 Airflow 連線 ID，以提供對儲存位置的存取權。根據您的遠端日誌記錄服務，這可能僅用於讀取日誌，而不適用於寫入日誌。

類型: 字串
預設值: ''
環境變數: AIRFLOW__LOGGING__REMOTE_LOG_CONN_ID

remote_logging¶

版本 2.0.0 新增。

Airflow 可以將日誌遠端儲存在 AWS S3、Google Cloud Storage 或 Elastic Search 中。如果您想啟用遠端日誌記錄，請將此設定為 True。

類型: 字串
預設值: False
環境變數: AIRFLOW__LOGGING__REMOTE_LOGGING

remote_task_handler_kwargs¶

版本 2.6.0 新增。

remote_task_handler_kwargs 參數會載入到字典中，並傳遞到遠端任務處理常式的 __init__，並且它會覆寫 Airflow 設定提供的值。例如，如果您設定 delete_local_logs=False 並且您提供 {"delete_local_copy": true}，則本機日誌檔案將在它們上傳到遠端位置後被刪除。

類型

字串

預設值

''

環境變數

AIRFLOW__LOGGING__REMOTE_TASK_HANDLER_KWARGS

AIRFLOW__LOGGING__REMOTE_TASK_HANDLER_KWARGS_CMD

AIRFLOW__LOGGING__REMOTE_TASK_HANDLER_KWARGS_SECRET

範例

{"delete_local_copy": true}

secret_mask_adapter¶

版本 2.6.0 新增。

匯入路徑到一個函數，以新增使用 airflow.utils.log.secrets_masker.mask_secret 新增的每個密碼的改編版本，以便在日誌訊息中遮罩。給定的函數預期需要一個參數：要改編的密碼。它可以傳回密碼的單一改編版本，也可以傳回要遮罩為密碼的每個改編版本的可迭代物件。原始密碼以及傳回的任何改編版本都將被遮罩。

類型: 字串
預設值: ''
環境變數: AIRFLOW__LOGGING__SECRET_MASK_ADAPTER
範例: urllib.parse.quote

simple_log_format¶

版本 2.0.0 新增。

定義簡單日誌記錄設定的日誌訊息格式

類型: 字串
預設值: %%(asctime)s %%(levelname)s - %%(message)s
環境變數: AIRFLOW__LOGGING__SIMPLE_LOG_FORMAT

task_log_prefix_template¶

版本 2.0.0 新增。

指定如下所述的前綴模式，搭配串流處理常式 TaskHandlerWithCustomFormatter

類型: 字串
預設值: ''
環境變數: AIRFLOW__LOGGING__TASK_LOG_PREFIX_TEMPLATE
範例: {ti.dag_id}-{ti.task_id}-{execution_date}-{ti.try_number}

task_log_reader¶

版本 2.0.0 新增。

用於讀取任務執行個體日誌的處理常式名稱。預設為使用 task 處理常式。

類型: 字串
預設值: task
環境變數: AIRFLOW__LOGGING__TASK_LOG_READER

trigger_log_server_port¶

版本 2.6.0 新增。

用於從觸發器提供日誌的埠。請參閱 [logging] worker_log_server_port 說明以取得更多資訊。

類型: 字串
預設值: 8794
環境變數: AIRFLOW__LOGGING__TRIGGER_LOG_SERVER_PORT

worker_log_server_port¶

版本 2.2.0 新增。

當您啟動 Airflow 工作程式時，Airflow 會啟動一個小型 Web 伺服器子程序，以將工作程式的本機日誌檔案提供給 airflow 主要 Web 伺服器，然後由後者建置頁面並將其傳送給使用者。這定義了提供日誌的埠。它必須是未使用的，並且從主要 Web 伺服器到工作程式的連線必須是開啟且可見的。

類型: 字串
預設值: 8793
環境變數: AIRFLOW__LOGGING__WORKER_LOG_SERVER_PORT

[metrics]¶

StatsD 整合設定。

metrics_allow_list¶

版本 2.6.0 新增。

設定允許清單（逗號分隔字串）以僅傳送某些指標。如果 [metrics] metrics_use_pattern_match 為 false，則僅比對完全相同的指標名稱前綴。如果 [metrics] metrics_use_pattern_match 為 true，則提供正則表達式模式以進行比對。

類型: 字串
預設值: ''
環境變數: AIRFLOW__METRICS__METRICS_ALLOW_LIST
範例: "scheduler,executor,dagrun,pool,triggerer,celery" or "^scheduler,^executor,heartbeat|timeout"

metrics_block_list¶

版本 2.6.0 新增。

設定封鎖清單（逗號分隔字串）以封鎖發出某些指標。如果同時設定了 [metrics] metrics_allow_list 和 [metrics] metrics_block_list，則會忽略 [metrics] metrics_block_list。

如果 [metrics] metrics_use_pattern_match 為 false，則僅比對完全相同的指標名稱前綴。

如果 [metrics] metrics_use_pattern_match 為 true，則提供正則表達式模式以進行比對。

類型: 字串
預設值: ''
環境變數: AIRFLOW__METRICS__METRICS_BLOCK_LIST
範例: "scheduler,executor,dagrun,pool,triggerer,celery" or "^scheduler,^executor,heartbeat|timeout"

metrics_use_pattern_match¶

版本 2.9.0 新增功能。

如果為 true，[metrics] metrics_allow_list 和 [metrics] metrics_block_list 將在指標名稱內的任何位置使用正則表達式模式比對，而不是僅在名稱開頭進行前綴比對。

類型: 布林值
預設值: False
環境變數: AIRFLOW__METRICS__METRICS_USE_PATTERN_MATCH

otel_debugging_on¶

版本 2.7.0 新增。

如果 True，所有指標也會發送到主控台。預設為 False。

類型: 字串
預設值: False
環境變數: AIRFLOW__METRICS__OTEL_DEBUGGING_ON

otel_host¶

版本 2.6.0 新增。

指定 OpenTelemetry Collector 的主機名稱或 IP 位址，Airflow 會將指標和追蹤傳送到該收集器。

類型: 字串
預設值: localhost
環境變數: AIRFLOW__METRICS__OTEL_HOST

otel_interval_milliseconds¶

版本 2.6.0 新增。

定義 Airflow 將成批的指標和追蹤傳送到已設定的 OpenTelemetry Collector 的間隔（以毫秒為單位）。

類型: 整數
預設值: 60000
環境變數: AIRFLOW__METRICS__OTEL_INTERVAL_MILLISECONDS

otel_on¶

版本 2.6.0 新增。

啟用將指標傳送到 OpenTelemetry。

類型: 字串
預設值: False
環境變數: AIRFLOW__METRICS__OTEL_ON

otel_port¶

版本 2.6.0 新增。

指定正在接聽的 OpenTelemetry Collector 的埠。

類型: 字串
預設值: 8889
環境變數: AIRFLOW__METRICS__OTEL_PORT

otel_prefix¶

版本 2.6.0 新增。

Airflow 指標的前綴。

類型: 字串
預設值: airflow
環境變數: AIRFLOW__METRICS__OTEL_PREFIX

otel_service¶

2.10.3 版本的新功能。

追蹤的預設服務名稱。

類型: 字串
預設值: Airflow
環境變數: AIRFLOW__METRICS__OTEL_SERVICE

otel_ssl_active¶

版本 2.7.0 新增。

如果 True，則將啟用 SSL。預設為 False。若要建立與 OpenTelemetry 收集器的 HTTPS 連線，您需要在 OpenTelemetry 收集器的 config.yml 檔案中設定 SSL 憑證和金鑰。

類型: 字串
預設值: False
環境變數: AIRFLOW__METRICS__OTEL_SSL_ACTIVE

stat_name_handler¶

版本 2.0.0 新增。

一個函數，用於驗證 StatsD 統計名稱、在必要時對統計名稱套用變更，並傳回轉換後的統計名稱。

該函式應具有以下簽章

def func_name(stat_name: str) -> str: ...

類型: 字串
預設值: ''
環境變數: AIRFLOW__METRICS__STAT_NAME_HANDLER

statsd_custom_client_path¶

版本 2.0.0 新增。

如果您想使用自己的自訂 StatsD 用戶端，請在下方設定相關的模組路徑。注意：模組路徑必須存在於您的 PYTHONPATH <https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH> 上，Airflow 才能選取它

類型: 字串
預設值: 無
環境變數: AIRFLOW__METRICS__STATSD_CUSTOM_CLIENT_PATH

statsd_datadog_enabled¶

版本 2.0.0 新增。

啟用 datadog 整合以傳送 airflow 指標。

類型: 字串
預設值: False
環境變數: AIRFLOW__METRICS__STATSD_DATADOG_ENABLED

statsd_datadog_metrics_tags¶

版本 2.6.0 新增。

設定為 False 以停用某些發出的指標的中繼資料標籤

類型: 布林值
預設值: True
環境變數: AIRFLOW__METRICS__STATSD_DATADOG_METRICS_TAGS

statsd_datadog_tags¶

版本 2.0.0 新增。

附加到所有指標的 datadog 標籤清單（例如：key1:value1,key2:value2）

類型: 字串
預設值: ''
環境變數: AIRFLOW__METRICS__STATSD_DATADOG_TAGS

statsd_disabled_tags¶

版本 2.6.0 新增。

如果您想避免將所有可用的指標標籤傳送到 StatsD，您可以設定前綴的封鎖清單（逗號分隔），以篩選掉以清單元素開頭的指標標籤（例如：job_id,run_id）

類型: 字串
預設值: job_id,run_id
環境變數: AIRFLOW__METRICS__STATSD_DISABLED_TAGS
範例: job_id,run_id,dag_id,task_id

statsd_host¶

版本 2.0.0 新增。

指定 StatsD daemon（或伺服器）正在執行的主機位址

類型: 字串
預設值: localhost
環境變數: AIRFLOW__METRICS__STATSD_HOST

statsd_influxdb_enabled¶

版本 2.6.0 新增。

啟用使用 StatsD-Influxdb 標記慣例傳送 Airflow 指標。

類型: 布林值
預設值: False
環境變數: AIRFLOW__METRICS__STATSD_INFLUXDB_ENABLED

statsd_on¶

版本 2.0.0 新增。

啟用將指標傳送到 StatsD。

類型: 字串
預設值: False
環境變數: AIRFLOW__METRICS__STATSD_ON

statsd_port¶

版本 2.0.0 新增。

指定 StatsD daemon（或伺服器）正在接聽的埠

類型: 字串
預設值: 8125
環境變數: AIRFLOW__METRICS__STATSD_PORT

statsd_prefix¶

版本 2.0.0 新增。

定義從 Airflow 傳送到 StatsD 的所有指標的命名空間

類型: 字串
預設值: airflow
環境變數: AIRFLOW__METRICS__STATSD_PREFIX

statsd_allow_list (已停用)¶

已於 2.6.0 版本停用: 此選項已移至 metrics.metrics_allow_list

statsd_block_list (已停用)¶

已於 2.6.0 版本停用: 此選項已移至 metrics.metrics_block_list

[operators]¶

allow_illegal_arguments¶

版本 2.0.0 新增。

是否允許將額外/未使用的引數 (args, kwargs) 傳遞至 BaseOperator 運算子。如果設定為 False，將會擲回例外狀況，否則只會顯示主控台訊息。

類型: 字串
預設值: False
環境變數: AIRFLOW__OPERATORS__ALLOW_ILLEGAL_ARGUMENTS

default_cpus¶

指示在運算子的組態中未指定特定 CPU 請求時，配置給每個運算子的預設 CPU 單位數

類型: 字串
預設值: 1
環境變數: AIRFLOW__OPERATORS__DEFAULT_CPUS

default_deferrable¶

版本 2.7.0 新增。

運算子和感測器中屬性「deferrable」的預設值。

類型: 布林值
預設值: false
環境變數: AIRFLOW__OPERATORS__DEFAULT_DEFERRABLE

default_disk¶

指示在運算子的組態中未指定特定磁碟請求時，配置給每個運算子的預設磁碟儲存空間

類型: 字串
預設值: 512
環境變數: AIRFLOW__OPERATORS__DEFAULT_DISK

default_gpus¶

指示在運算子的組態中未指定特定 GPU 請求時，配置給每個運算子的預設 GPU 數

類型: 字串
預設值: 0
環境變數: AIRFLOW__OPERATORS__DEFAULT_GPUS

default_owner¶

除非明確提供或透過 default_args 傳遞，否則指派給每個新運算子的預設擁有者

類型: 字串
預設值: airflow
環境變數: AIRFLOW__OPERATORS__DEFAULT_OWNER

default_queue¶

版本 2.1.0 新增。

任務指派到的預設佇列，以及工作程式接聽的佇列。

類型: 字串
預設值: default
環境變數: AIRFLOW__OPERATORS__DEFAULT_QUEUE

default_ram¶

指示在運算子的組態中未指定特定 RAM 請求時，配置給每個運算子的預設 RAM

類型: 字串
預設值: 512
環境變數: AIRFLOW__OPERATORS__DEFAULT_RAM

[scheduler]¶

allow_trigger_in_future¶

版本 1.10.8 新增。

允許未來執行日期的外部觸發 DagRun。僅在 DAG 中將 schedule_interval 設定為 None 時才有效

類型: 布林值
預設值: False
環境變數: AIRFLOW__SCHEDULER__ALLOW_TRIGGER_IN_FUTURE

allowed_run_id_pattern¶

2.6.3 版本的新功能。

run_id 模式，用於驗證使用者輸入到觸發 DAG 時的 run_id 參數的有效性。此模式無法變更排程器用於為排程的 DAG 執行或在不變更 run_id 參數的情況下觸發的 DAG 執行產生 run_id 的模式。

類型: 字串
預設值: ^[A-Za-z0-9_.~:+-]+$
環境變數: AIRFLOW__SCHEDULER__ALLOWED_RUN_ID_PATTERN

catchup_by_default¶

將此設定為 False 以關閉排程器補追。預設行為保持不變，命令列回填仍然有效，但如果此設定為 False，排程器將不會執行排程器補追，但是可以在 DAG 定義 (catchup) 中針對每個 DAG 設定它

類型: 布林值
預設值: True
環境變數: AIRFLOW__SCHEDULER__CATCHUP_BY_DEFAULT

child_process_log_directory¶

決定將儲存排程器子程序的日誌的目錄

類型: 字串
預設值: {AIRFLOW_HOME}/logs/scheduler
環境變數: AIRFLOW__SCHEDULER__CHILD_PROCESS_LOG_DIRECTORY

create_cron_data_intervals¶

版本 2.9.0 新增功能。

當為 DAG 的 schedule 引數提供 cron 字串時，是否為跨越間隔的 DAG 執行建立 DAG 執行，還是為 cron 排程中的單個時間點建立 DAG 執行。

True：使用 CronDataIntervalTimetable，它適用於具有明確定義的資料間隔的 DAG。您可以從上一個間隔的結尾到排程的日期時間取得連續的間隔。
False：使用 CronTriggerTimetable，它更接近 cron 本身的行為。

值得注意的是，對於 CronTriggerTimetable，邏輯日期與 DAG 執行將嘗試排程的時間相同，而對於 CronDataIntervalTimetable，邏輯日期是資料間隔的開始，但 DAG 執行將嘗試在資料間隔的結尾進行排程。

另請參閱

兩個 cron 時間表的差異

類型: 布林值
預設值: True
環境變數: AIRFLOW__SCHEDULER__CREATE_CRON_DATA_INTERVALS

dag_dir_list_interval¶

掃描 DAG 目錄以尋找新檔案的頻率（以秒為單位）。預設為 5 分鐘。

類型: 整數
預設值: 300
環境變數: AIRFLOW__SCHEDULER__DAG_DIR_LIST_INTERVAL

dag_stale_not_seen_duration¶

版本 2.4.0 新增。

僅在 [scheduler] standalone_dag_processor 為 true 時適用。在 DAG 處理器未更新 DAG 後停用 DAG 的時間（以秒為單位）。

類型: 整數
預設值: 600
環境變數: AIRFLOW__SCHEDULER__DAG_STALE_NOT_SEEN_DURATION

enable_health_check¶

版本 2.4.0 新增。

當您啟動排程器時，如果此設定為 True，airflow 會啟動一個小型 Web 伺服器子程序來提供健康情況檢查

類型: 布林值
預設值: False
環境變數: AIRFLOW__SCHEDULER__ENABLE_HEALTH_CHECK

file_parsing_sort_mode¶

版本 2.1.0 新增。

其中之一 modified_time、random_seeded_by_host 和 alphabetical。排程器將列出 DAG 檔案並排序，以決定解析順序。

modified_time：依檔案的修改時間排序。這在大型規模上很有用，可以優先解析最近修改的 DAG。
random_seeded_by_host：跨多個排程器隨機排序，但在同一主機上順序相同。當在 HA 模式下使用排程器執行時，這很有用，因為每個排程器可以解析不同的 DAG 檔案。
alphabetical：依檔案名稱排序

類型: 字串
預設值: modified_time
環境變數: AIRFLOW__SCHEDULER__FILE_PARSING_SORT_MODE

ignore_first_depends_on_past_by_default¶

版本 2.3.0 新增。

將此設定為 True 將使任務的首次任務實例忽略 depends_on_past 設定。當資料庫中沒有執行日期早於它的任務實例時，任務實例將被視為任務的首次任務實例，也就是說，新加入的任務不需要手動標記成功即可排程。

類型: 布林值
預設值: True
環境變數: AIRFLOW__SCHEDULER__IGNORE_FIRST_DEPENDS_ON_PAST_BY_DEFAULT

job_heartbeat_sec¶

任務實例會監聽外部終止訊號（當您從 CLI 或 UI 清除任務時），這定義了它們應該監聽的頻率（以秒為單位）。

類型: 浮點數
預設值: 5
環境變數: AIRFLOW__SCHEDULER__JOB_HEARTBEAT_SEC

local_task_job_heartbeat_sec¶

版本 2.7.0 新增。

LocalTaskJob 應將心跳訊號發送到排程器的頻率（以秒為單位），以通知它仍然存活。如果此值設定為 0，則心跳間隔將預設為 [scheduler] scheduler_zombie_task_threshold 的值。

類型: 整數
預設值: 0
環境變數: AIRFLOW__SCHEDULER__LOCAL_TASK_JOB_HEARTBEAT_SEC

max_callbacks_per_loop¶

版本 2.3.0 新增。

僅當 [scheduler] standalone_dag_processor 為 true 且回呼儲存在資料庫中時適用。包含單個迴圈中提取的回呼最大數量。

類型: 整數
預設值: 20
環境變數: AIRFLOW__SCHEDULER__MAX_CALLBACKS_PER_LOOP

max_dagruns_per_loop_to_schedule¶

版本 2.0.0 新增。

排程器在排程和佇列任務時應檢查（和鎖定）多少個 DagRun。

另請參閱

排程器配置選項

類型: 整數
預設值: 20
環境變數: AIRFLOW__SCHEDULER__MAX_DAGRUNS_PER_LOOP_TO_SCHEDULE

max_dagruns_to_create_per_loop¶

版本 2.0.0 新增。

每個排程器迴圈要為其建立 DagRun 的 DAG 最大數量。

另請參閱

排程器配置選項

類型: 整數
預設值: 10
環境變數: AIRFLOW__SCHEDULER__MAX_DAGRUNS_TO_CREATE_PER_LOOP

max_tis_per_query¶

這會變更排程主迴圈中查詢的批次大小。這不應大於 [core] parallelism。如果此值太高，SQL 查詢效能可能會受到查詢述詞的複雜性和/或過度鎖定的影響。此外，您可能會達到資料庫允許的最大查詢長度。將此設定為 0 以使用 [core] parallelism 的值

類型: 整數
預設值: 16
環境變數: AIRFLOW__SCHEDULER__MAX_TIS_PER_QUERY

min_file_process_interval¶

解析 DAG 檔案後的秒數。DAG 檔案每隔 [scheduler] min_file_process_interval 秒解析一次。DAG 的更新會在此間隔後反映。保持此數字較低會增加 CPU 使用率。

類型: 整數
預設值: 30
環境變數: AIRFLOW__SCHEDULER__MIN_FILE_PROCESS_INTERVAL

num_runs¶

版本 1.10.6 新增。

嘗試排程每個 DAG 檔案的次數，-1 表示不限次數

類型: 整數
預設值: -1
環境變數: AIRFLOW__SCHEDULER__NUM_RUNS

orphaned_tasks_check_interval¶

版本 2.0.0 新增。

排程器應多久檢查一次孤立任務和 SchedulerJob（以秒為單位）

類型: 浮點數
預設值: 300.0
環境變數: AIRFLOW__SCHEDULER__ORPHANED_TASKS_CHECK_INTERVAL

parsing_cleanup_interval¶

版本 2.5.0 新增。

多久檢查一次過時的 DAG（不再存在於預期檔案中的 DAG）（以秒為單位），這些 DAG 應停用，以及不再被參考且應標記為孤立的資料集。

類型: 整數
預設值: 60
環境變數: AIRFLOW__SCHEDULER__PARSING_CLEANUP_INTERVAL

parsing_pre_import_modules¶

版本 2.6.0 新增。

排程器讀取 dag 檔案以提取將要使用的 airflow 模組，並提前匯入它們，以避免在每個解析程序中都重新執行此操作。如果每次都需要重新匯入 airflow 模組（以增加 DAG 解析時間為代價），則可以將此標誌設定為 False 以停用此行為。

類型: 布林值
預設值: True
環境變數: AIRFLOW__SCHEDULER__PARSING_PRE_IMPORT_MODULES

parsing_processes¶

版本 1.10.14 新增。

排程器可以並行執行多個程序來解析 dag。這定義了將執行的程序數量。

類型: 整數
預設值: 2
環境變數: AIRFLOW__SCHEDULER__PARSING_PROCESSES

pool_metrics_interval¶

版本 2.0.0 新增。

應多久將 Pool 使用率統計資料傳送到 StatsD（如果 statsd_on 已啟用）（以秒為單位）

類型: 浮點數
預設值: 5.0
環境變數: AIRFLOW__SCHEDULER__POOL_METRICS_INTERVAL

print_stats_interval¶

應多久將統計資料列印到日誌中。設定為 0 將停用列印統計資料

類型: 整數
預設值: 30
環境變數: AIRFLOW__SCHEDULER__PRINT_STATS_INTERVAL

schedule_after_task_execution¶

版本 2.0.0 新增。

任務監督程序是否應執行「迷你排程器」以嘗試排程同一 DAG 的更多任務。保持此設定開啟表示同一 DAG 中的任務執行速度更快，但在某些情況下可能會使其他 dag 處於飢餓狀態

類型: 布林值
預設值: True
環境變數: AIRFLOW__SCHEDULER__SCHEDULE_AFTER_TASK_EXECUTION

scheduler_health_check_server_host¶

2.8.0 版本的新功能。

當您啟動排程器時，airflow 會啟動一個小型網頁伺服器子程序，以在此主機上提供健康檢查

類型: 字串
預設值: 0.0.0.0
環境變數: AIRFLOW__SCHEDULER__SCHEDULER_HEALTH_CHECK_SERVER_HOST

scheduler_health_check_server_port¶

版本 2.4.0 新增。

當您啟動排程器時，airflow 會啟動一個小型網頁伺服器子程序，以在此埠上提供健康檢查

類型: 整數
預設值: 8974
環境變數: AIRFLOW__SCHEDULER__SCHEDULER_HEALTH_CHECK_SERVER_PORT

scheduler_health_check_threshold¶

版本 1.10.2 新增。

如果上次排程器心跳發生在超過 [scheduler] scheduler_health_check_threshold 前（以秒為單位），則排程器被視為不健康。這由 /health 端點中的健康檢查和 airflow jobs check CLI for SchedulerJob 使用。

類型: 整數
預設值: 30
環境變數: AIRFLOW__SCHEDULER__SCHEDULER_HEALTH_CHECK_THRESHOLD

scheduler_heartbeat_sec¶

排程器不斷嘗試觸發新任務（有關更多資訊，請參閱文件中的排程器章節）。這定義了排程器應多久執行一次（以秒為單位）。

類型: 整數
預設值: 5
環境變數: AIRFLOW__SCHEDULER__SCHEDULER_HEARTBEAT_SEC

scheduler_idle_sleep_time¶

版本 2.2.0 新增。

控制排程器在迴圈之間休眠多久，但前提是迴圈中沒有任何事情要做。也就是說，如果它排程了某些東西，則它將立即開始下一個迴圈迭代。

類型: 浮點數
預設值: 1
環境變數: AIRFLOW__SCHEDULER__SCHEDULER_IDLE_SLEEP_TIME

scheduler_zombie_task_threshold¶

本機任務作業會定期向資料庫發送心跳訊號。如果作業在此秒數內沒有發送心跳訊號，排程器將把關聯的任務實例標記為失敗，並重新排程任務。

類型: 整數
預設值: 300
環境變數: AIRFLOW__SCHEDULER__SCHEDULER_ZOMBIE_TASK_THRESHOLD

stale_dag_threshold¶

版本 2.6.0 新增。

在我們重新解析 DAG 檔案後，等待多久（以秒為單位）才停用過時的 DAG（不再存在於預期檔案中的 DAG）。我們需要此閾值的原因是為了考慮檔案解析和 DAG 載入之間的時間。這可能花費的絕對最大時間是 [core] dag_file_processor_timeout，但是當您配置了較長的逾時時間時，會導致停用過時 dag 的時間顯著延遲。

類型: 整數
預設值: 50
環境變數: AIRFLOW__SCHEDULER__STALE_DAG_THRESHOLD

standalone_dag_processor¶

版本 2.3.0 新增。

dag 處理器是以獨立程序執行，還是作為排程器作業的子程序執行。

類型: 布林值
預設值: False
環境變數: AIRFLOW__SCHEDULER__STANDALONE_DAG_PROCESSOR

task_queued_timeout¶

版本 2.6.0 新增。

任務可以處於佇列狀態的時間長度，超過此時間後將重試或設定為失敗。

類型: 浮點數
預設值: 600.0
環境變數: AIRFLOW__SCHEDULER__TASK_QUEUED_TIMEOUT

task_queued_timeout_check_interval¶

版本 2.6.0 新增。

多久檢查一次處於佇列狀態的時間超過 [scheduler] task_queued_timeout 的任務。

類型: 浮點數
預設值: 120.0
環境變數: AIRFLOW__SCHEDULER__TASK_QUEUED_TIMEOUT_CHECK_INTERVAL

trigger_timeout_check_interval¶

版本 2.2.0 新增。

多久檢查一次尚未運行的過期觸發請求。

類型: 浮點數
預設值: 15
環境變數: AIRFLOW__SCHEDULER__TRIGGER_TIMEOUT_CHECK_INTERVAL

use_job_schedule¶

版本 1.10.2 新增。

將此設定為 False 以關閉排程器對 cron 間隔的使用。在網頁 UI 中或使用 trigger_dag 手動提交的 DAG 仍將運行。

類型: 布林值
預設值: True
環境變數: AIRFLOW__SCHEDULER__USE_JOB_SCHEDULE

use_row_level_locking¶

版本 2.0.0 新增。

排程器是否應在相關查詢中發出 SELECT ... FOR UPDATE。如果將此設定為 False，則您不應同時運行多個排程器

類型: 布林值
預設值: True
環境變數: AIRFLOW__SCHEDULER__USE_ROW_LEVEL_LOCKING

zombie_detection_interval¶

版本 2.3.0 新增。

排程器應多久檢查一次殭屍任務（以秒為單位）。

類型: 浮點數
預設值: 10.0
環境變數: AIRFLOW__SCHEDULER__ZOMBIE_DETECTION_INTERVAL

deactivate_stale_dags_interval (已棄用)¶

版本 2.5.0 開始棄用：此選項已移至 scheduler.parsing_cleanup_interval

max_threads (已棄用)¶

版本 1.10.14 開始棄用：此選項已移至 scheduler.parsing_processes

processor_poll_interval (已棄用)¶

版本 2.2.0 開始棄用：此選項已移至 scheduler.scheduler_idle_sleep_time

stat_name_handler (已棄用)¶

版本 2.0.0 開始棄用：此選項已移至 metrics.stat_name_handler

statsd_allow_list (已棄用)¶

版本 2.0.0 開始棄用：此選項已移至 metrics.statsd_allow_list

statsd_custom_client_path (已棄用)¶

版本 2.0.0 開始棄用：此選項已移至 metrics.statsd_custom_client_path

statsd_datadog_enabled (已棄用)¶

版本 2.0.0 開始棄用：此選項已移至 metrics.statsd_datadog_enabled

statsd_datadog_metrics_tags (已棄用)¶

版本 2.6.0 開始棄用：此選項已移至 metrics.statsd_datadog_metrics_tags

statsd_datadog_tags (已棄用)¶

版本 2.0.0 開始棄用：此選項已移至 metrics.statsd_datadog_tags

statsd_host (已棄用)¶

版本 2.0.0 開始棄用：此選項已移至 metrics.statsd_host

statsd_on (已棄用)¶

版本 2.0.0 開始棄用：此選項已移至 metrics.statsd_on

statsd_port (已棄用)¶

版本 2.0.0 開始棄用：此選項已移至 metrics.statsd_port

statsd_prefix (已棄用)¶

版本 2.0.0 開始棄用：此選項已移至 metrics.statsd_prefix

[secrets]¶

backend¶

版本 1.10.10 新增功能。

要啟用的密碼後端的完整類別名稱（在搜尋路徑中將優先於環境變數和中繼資料儲存庫）

類型: 字串
預設值: ''
環境變數: AIRFLOW__SECRETS__BACKEND
範例: airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend

backend_kwargs¶

版本 1.10.10 新增功能。

backend_kwargs 參數會載入到字典中，並傳遞到密碼後端類別的 __init__。請參閱您正在使用的密碼後端的說明文件。預期為 JSON 格式。

AWS Systems Manager ParameterStore 的範例：{"connections_prefix": "/airflow/connections", "profile_name": "default"}

類型

字串

預設值

''

環境變數

AIRFLOW__SECRETS__BACKEND_KWARGS

AIRFLOW__SECRETS__BACKEND_KWARGS_CMD

AIRFLOW__SECRETS__BACKEND_KWARGS_SECRET

cache_ttl_seconds¶

版本 2.7.0 新增。

注意

這是一個實驗性功能。

當快取啟用時，這是我們認為快取中條目有效的持續時間。如果條目早於此秒數，則會重新整理條目。這表示當快取啟用時，這是您需要等待看到變數變更生效的最長時間。

類型: 整數
預設值: 900
環境變數: AIRFLOW__SECRETS__CACHE_TTL_SECONDS

use_cache¶

版本 2.7.0 新增。

注意

這是一個實驗性功能。

僅在解析 DAG 時啟用變數的本機快取。如果變數在最上層程式碼中使用，則使用此選項可以加快 dag 解析速度，但代價是變更的傳播時間更長。請注意，此快取僅與 DAG 解析步驟有關。當 DAG 任務執行時，不會進行快取。

類型: 布林值
預設值: False
環境變數: AIRFLOW__SECRETS__USE_CACHE

[sensors]¶

default_timeout¶

版本 2.3.0 新增。

感測器預設逾時時間，預設為 7 天 (7 * 24 * 60 * 60)。

類型: 浮點數
預設值: 604800
環境變數: AIRFLOW__SENSORS__DEFAULT_TIMEOUT

[sentry]¶

Sentry 整合。您可以在此處根據 Python 平台提供其他配置選項。有關更多詳細資訊，請參閱 Python / 配置 / 基本選項。不支援的選項：integrations、in_app_include、in_app_exclude、ignore_errors、before_breadcrumb、transport。

before_send¶

版本 2.2.0 新增。

sentry SDK 應配置為使用的 before_send 函數的點狀路徑。

類型: 字串
預設值: 無
環境變數: AIRFLOW__SENTRY__BEFORE_SEND

sentry_dsn¶

版本 1.10.6 新增。

類型

字串

預設值

''

環境變數

AIRFLOW__SENTRY__SENTRY_DSN

AIRFLOW__SENTRY__SENTRY_DSN_CMD

AIRFLOW__SENTRY__SENTRY_DSN_SECRET

sentry_on¶

版本 2.0.0 新增。

啟用向 Sentry 報告錯誤

類型: 字串
預設值: false
環境變數: AIRFLOW__SENTRY__SENTRY_ON

[smtp]¶

如果您希望 airflow 在重試、失敗時傳送電子郵件，並且您想要使用 airflow.utils.email.send_email_smtp 函數，則必須在此處配置 smtp 伺服器

smtp_host¶

指定 Airflow 在透過 SMTP 傳送電子郵件通知時使用的主機伺服器位址。

類型: 字串
預設值: localhost
環境變數: AIRFLOW__SMTP__SMTP_HOST

smtp_mail_from¶

指定 Airflow 傳送電子郵件通知時使用的預設 from 電子郵件地址。

類型: 字串
預設值: airflow@example.com
環境變數: AIRFLOW__SMTP__SMTP_MAIL_FROM

smtp_password¶

連線到 smtp 伺服器時用於驗證的身分驗證密碼。

類型

字串

預設值

無

環境變數

AIRFLOW__SMTP__SMTP_PASSWORD

AIRFLOW__SMTP__SMTP_PASSWORD_CMD

AIRFLOW__SMTP__SMTP_PASSWORD_SECRET

範例

airflow

smtp_port¶

定義 Airflow 連線到 SMTP 伺服器以傳送電子郵件通知的埠號。

類型: 字串
預設值: 25
環境變數: AIRFLOW__SMTP__SMTP_PORT

smtp_retry_limit¶

版本 2.0.0 新增。

定義 Airflow 嘗試連線到 SMTP 伺服器的最大次數。

類型: 整數
預設值: 5
環境變數: AIRFLOW__SMTP__SMTP_RETRY_LIMIT

smtp_ssl¶

決定在與 SMTP 伺服器通訊時是否使用 SSL 連線。

類型: 字串
預設值: False
環境變數: AIRFLOW__SMTP__SMTP_SSL

smtp_starttls¶

決定連線到 SMTP 伺服器時是否使用 STARTTLS 命令。

類型: 字串
預設值: True
環境變數: AIRFLOW__SMTP__SMTP_STARTTLS

smtp_timeout¶

版本 2.0.0 新增。

決定 Apache Airflow 系統等待建立與 SMTP 伺服器的連線的最長時間（以秒為單位）。

類型: 整數
預設值: 30
環境變數: AIRFLOW__SMTP__SMTP_TIMEOUT

smtp_user¶

連線到 smtp 伺服器時用於驗證的身分驗證使用者名稱。

類型: 字串
預設值: 無
環境變數: AIRFLOW__SMTP__SMTP_USER
範例: airflow

[traces]¶

分散式追蹤整合設定。

otel_debugging_on¶

版本 2.10.0 新增。

如果為 True，則所有追蹤也會發送到主控台。預設為 False。

類型: 字串
預設值: False
環境變數: AIRFLOW__TRACES__OTEL_DEBUGGING_ON

otel_host¶

版本 2.10.0 新增。

指定 Airflow 將追蹤發送到的 OpenTelemetry 收集器的主機名稱或 IP 位址。

類型: 字串
預設值: localhost
環境變數: AIRFLOW__TRACES__OTEL_HOST

otel_on¶

版本 2.10.0 新增。

啟用將追蹤發送到 OpenTelemetry。

類型: 字串
預設值: False
環境變數: AIRFLOW__TRACES__OTEL_ON

otel_port¶

版本 2.10.0 新增。

指定正在接聽的 OpenTelemetry Collector 的埠。

類型: 字串
預設值: 8889
環境變數: AIRFLOW__TRACES__OTEL_PORT

otel_service¶

版本 2.10.0 新增。

追蹤的預設服務名稱。

類型: 字串
預設值: Airflow
環境變數: AIRFLOW__TRACES__OTEL_SERVICE

otel_ssl_active¶

版本 2.10.0 新增。

如果為 True，則會啟用 SSL。預設為 False。若要建立與 OpenTelemetry 收集器的 HTTPS 連線，您需要在 OpenTelemetry 收集器的 config.yml 檔案中配置 SSL 憑證和金鑰。

類型: 字串
預設值: False
環境變數: AIRFLOW__TRACES__OTEL_SSL_ACTIVE

otel_task_log_event¶

版本 2.10.0 新增。

如果為 True，則在任務完成後，完整的任務日誌訊息將作為 span 事件新增，並以 64k 大小分塊。預設為 False。

類型: 字串
預設值: False
環境變數: AIRFLOW__TRACES__OTEL_TASK_LOG_EVENT

[triggerer]¶

default_capacity¶

版本 2.2.0 新增。

預設情況下，單個觸發器將一次運行的觸發器數量。

類型: 字串
預設值: 1000
環境變數: AIRFLOW__TRIGGERER__DEFAULT_CAPACITY

job_heartbeat_sec¶

2.6.3 版本的新功能。

觸發器作業應多久發送一次心跳訊號，以確保它沒有被終止。

類型: 浮點數
預設值: 5
環境變數: AIRFLOW__TRIGGERER__JOB_HEARTBEAT_SEC

triggerer_health_check_threshold¶

版本 2.7.0 新增。

如果上次觸發器心跳發生在超過 [triggerer] triggerer_health_check_threshold 前（以秒為單位），則觸發器被視為不健康。這由 /health 端點中的健康檢查和 airflow jobs check CLI for TriggererJob 使用。

類型: 浮點數
預設值: 30
環境變數: AIRFLOW__TRIGGERER__TRIGGERER_HEALTH_CHECK_THRESHOLD

[usage_data_collection]¶

Airflow 整合 Scarf 以在運作期間收集基本平台和使用情況資料。此資料協助 Airflow 維護人員更好地瞭解 Airflow 的使用方式。從此遙測獲得的見解對於確定修補程式、次要版本和安全性修復的優先順序至關重要。此外，此資訊還支援與開發藍圖相關的關鍵決策。查看 FAQ 文件以瞭解有關收集哪些資料的更多資訊。

部署可以透過將 enabled 選項設定為 False 或 SCARF_ANALYTICS=false 環境變數來選擇退出分析。個別使用者可以透過 Scarf Do Not Track 文件中記錄的各種方式輕鬆選擇退出分析。

enabled¶

版本 2.10.0 新增。

啟用或停用使用情況資料收集和傳送。

另請參閱

使用情況資料收集常見問題

類型: 布林值
預設值: True
環境變數: AIRFLOW__USAGE_DATA_COLLECTION__ENABLED

[webserver]¶

access_denied_message¶

版本 2.7.0 新增。

當使用者嘗試執行超出其授權權限的操作時顯示的訊息。

類型: 字串
預設值: 存取被拒絕
環境變數: AIRFLOW__WEBSERVER__ACCESS_DENIED_MESSAGE

access_logfile¶

gunicorn 網頁伺服器的日誌檔。'-' 表示記錄到 stderr。

類型: 字串
預設值: -
環境變數: AIRFLOW__WEBSERVER__ACCESS_LOGFILE

access_logformat¶

版本 2.0.0 新增。

gunicorn 網頁伺服器的存取日誌格式。預設格式為 %%(h)s %%(l)s %%(u)s %%(t)s "%%(r)s" %%(s)s %%(b)s "%%(f)s" "%%(a)s" 有關更多詳細資訊，請參閱 Gunicorn 設定：「access_log_format」參考

類型: 字串
預設值: ''
環境變數: AIRFLOW__WEBSERVER__ACCESS_LOGFORMAT

allow_raw_html_descriptions¶

2.8.0 版本的新功能。

DAG 作者能夠在 doc_md 或參數描述 description_md 中提供任何原始 HTML 以進行文字格式設定。這包括潛在不安全的 javascript。在網頁 UI 中顯示 DAG 或觸發表單，DAG 作者有可能將惡意程式碼注入到用戶端瀏覽器中。為了確保網頁 UI 預設是安全的，預設情況下會停用原始 HTML。如果您信任您的 DAG 作者，則可以透過將此選項設定為 True 來啟用 markdown 中的 HTML 支援。

此參數也會啟用 DAG 參數中已棄用的欄位 description_html 和 custom_html_form，直到該功能在未來版本中移除。

類型: 布林值
預設值: False
環境變數: AIRFLOW__WEBSERVER__ALLOW_RAW_HTML_DESCRIPTIONS
範例: False

allowed_payload_size¶

版本 2.8.1 新增。

可以傳送的請求酬載的最大大小（以 MB 為單位）。

類型: 浮點數
預設值: 1.0
環境變數: AIRFLOW__WEBSERVER__ALLOWED_PAYLOAD_SIZE

analytics_id¶

版本 1.10.5 新增。

您在分析工具中帳戶的唯一 ID

類型: 字串
預設值: 無
環境變數: AIRFLOW__WEBSERVER__ANALYTICS_ID

analytics_tool¶

將匿名使用者活動傳送到您的分析工具，請從 google_analytics、segment、metarouter 或 matomo 中選擇

類型: 字串
預設值: 無
環境變數: AIRFLOW__WEBSERVER__ANALYTICS_TOOL

analytics_url¶

版本 2.9.0 新增功能。

您的執行個體 URL，僅適用於 Matomo。

類型: 字串
預設值: 無
環境變數: AIRFLOW__WEBSERVER__ANALYTICS_URL
範例: https://your.matomo.instance.com/

audit_view_excluded_events¶

版本 2.3.0 新增。

要從 dag 稽核視圖中排除的視圖事件的逗號分隔字串。所有其他事件都將新增，減去此處傳遞的事件。資料庫中的稽核日誌將不受此參數的影響。

類型: 字串
預設值: 無
環境變數: AIRFLOW__WEBSERVER__AUDIT_VIEW_EXCLUDED_EVENTS
範例: cli_task_run,running,success

audit_view_included_events¶

版本 2.3.0 新增。

要包含在 dag 稽核視圖中的視圖事件的逗號分隔字串。如果傳遞，則只有這些事件會填入 dag 稽核視圖。資料庫中的稽核日誌將不受此參數的影響。

類型: 字串
預設值: 無
環境變數: AIRFLOW__WEBSERVER__AUDIT_VIEW_INCLUDED_EVENTS
範例: dagrun_cleared,failed

auto_refresh_interval¶

版本 2.2.0 新增。

當自動重新整理開啟時，DAG 資料在圖表或網格視圖中自動重新整理的頻率（以秒為單位）

類型: 整數
預設值: 3
環境變數: AIRFLOW__WEBSERVER__AUTO_REFRESH_INTERVAL

base_url¶

您網站的基本 URL：Airflow 無法猜測您正在使用的網域或 CNAME。這用於在「瀏覽 - 任務實例」選單中的「日誌 URL」欄以及 Airflow 傳送的任何包含網頁伺服器連結的自動電子郵件中建立連結。

類型: 字串
預設值: https://127.0.0.1:8080
環境變數: AIRFLOW__WEBSERVER__BASE_URL

caching_hash_method¶

版本 2.6.0 新增。

網頁伺服器使用的快取演算法。必須是有效的 hashlib 函數名稱。

類型: 字串
預設值: md5
環境變數: AIRFLOW__WEBSERVER__CACHING_HASH_METHOD
範例: sha256

config_file¶

版本 2.7.0 新增。

用於配置網頁伺服器參數的網頁伺服器配置檔案路徑

類型: 字串
預設值: {AIRFLOW_HOME}/webserver_config.py
環境變數: AIRFLOW__WEBSERVER__CONFIG_FILE

dag_default_view¶

預設 DAG 檢視。有效值為：grid、graph、duration、gantt、landing_times

類型: 字串
預設值: grid
環境變數: AIRFLOW__WEBSERVER__DAG_DEFAULT_VIEW

dag_orientation¶

預設 DAG 方向。有效值為：LR (由左至右)、TB (由上至下)、RL (由右至左)、BT (由下至上)

類型: 字串
預設值: LR
環境變數: AIRFLOW__WEBSERVER__DAG_ORIENTATION

default_dag_run_display_number¶

在 UI 中顯示的預設 Dagrun 數量

類型: 字串
預設值: 25
環境變數: AIRFLOW__WEBSERVER__DEFAULT_DAG_RUN_DISPLAY_NUMBER

default_ui_timezone¶

版本 1.10.10 新增功能。

在 UI 中顯示所有日期的預設時區，可以是 UTC、system 或任何 IANA 時區字串 (例如 Europe/Amsterdam)。如果留空，將使用 core/default_timezone 的預設值

類型: 字串
預設值: UTC
環境變數: AIRFLOW__WEBSERVER__DEFAULT_UI_TIMEZONE
範例: America/New_York

default_wrap¶

版本 1.10.4 新增。

DAG 程式碼和 TI 記錄檢視中 wrap 切換的預設設定。

類型: 布林值
預設值: False
環境變數: AIRFLOW__WEBSERVER__DEFAULT_WRAP

enable_proxy_fix¶

版本 1.10.1 新增。

為反向 Proxy 啟用 werkzeug ProxyFix 中介軟體

類型: 布林值
預設值: False
環境變數: AIRFLOW__WEBSERVER__ENABLE_PROXY_FIX

enable_swagger_ui¶

版本 2.6.0 新增。

在 webserver 中執行 SwaggerUI 的布林值。

類型: 布林值
預設值: True
環境變數: AIRFLOW__WEBSERVER__ENABLE_SWAGGER_UI

error_logfile¶

gunicorn 網頁伺服器的日誌檔。'-' 表示記錄到 stderr。

類型: 字串
預設值: -
環境變數: AIRFLOW__WEBSERVER__ERROR_LOGFILE

expose_config¶

在網頁伺服器中公開組態檔。設定為 non-sensitive-only 以顯示除了具有安全性意涵之外的所有值。True 顯示所有值。False 完全隱藏組態。

類型: 字串
預設值: False
環境變數: AIRFLOW__WEBSERVER__EXPOSE_CONFIG

expose_hostname¶

版本 1.10.8 新增。

在網頁伺服器中公開主機名稱

類型: 字串
預設值: False
環境變數: AIRFLOW__WEBSERVER__EXPOSE_HOSTNAME

expose_stacktrace¶

版本 1.10.8 新增。

在網頁伺服器中公開堆疊追蹤

類型: 字串
預設值: False
環境變數: AIRFLOW__WEBSERVER__EXPOSE_STACKTRACE

grid_view_sorting_order¶

版本 2.7.0 新增。

網格檢視中的排序順序。有效值為：topological、hierarchical_alphabetical

類型: 字串
預設值: topological
環境變數: AIRFLOW__WEBSERVER__GRID_VIEW_SORTING_ORDER

hide_paused_dags_by_default¶

預設情況下，網頁伺服器會顯示已暫停的 DAG。切換此選項以預設隱藏已暫停的 DAG

類型: 字串
預設值: False
環境變數: AIRFLOW__WEBSERVER__HIDE_PAUSED_DAGS_BY_DEFAULT

instance_name¶

版本 2.1.0 新增。

為 DAG 概觀頁面設定自訂頁面標題，並為所有頁面設定網站標題

類型: 字串
預設值: 無
環境變數: AIRFLOW__WEBSERVER__INSTANCE_NAME

instance_name_has_markup¶

版本 2.3.0 新增。

DAG 概觀頁面的自訂頁面標題是否包含任何標記語言

類型: 布林值
預設值: False
環境變數: AIRFLOW__WEBSERVER__INSTANCE_NAME_HAS_MARKUP

log_animation_speed¶

版本 1.10.8 新增。

自動追蹤記錄顯示的動畫速度。

類型: 整數
預設值: 1000
環境變數: AIRFLOW__WEBSERVER__LOG_ANIMATION_SPEED

log_auto_tailing_offset¶

版本 1.10.8 新增。

啟用自動追蹤的頁面底部距離。

類型: 整數
預設值: 30
環境變數: AIRFLOW__WEBSERVER__LOG_AUTO_TAILING_OFFSET

log_fetch_delay_sec¶

版本 1.10.8 新增。

等待下一次記錄擷取的時間間隔 (秒)。

類型: 整數
預設值: 2
環境變數: AIRFLOW__WEBSERVER__LOG_FETCH_DELAY_SEC

log_fetch_timeout_sec¶

網頁伺服器在從其他 Worker 機器擷取記錄時，等待初始交握的時間量 (秒)

類型: 字串
預設值: 5
環境變數: AIRFLOW__WEBSERVER__LOG_FETCH_TIMEOUT_SEC

num_recent_configurations_for_trigger¶

版本 2.9.0 新增功能。

觸發網頁表單上選取器中最近 DAG 執行組態的數量。

類型: 整數
預設值: 5
環境變數: AIRFLOW__WEBSERVER__NUM_RECENT_CONFIGURATIONS_FOR_TRIGGER
範例: 10

page_size¶

UI 中所有清單檢視的一致頁面大小

類型: 字串
預設值: 100
環境變數: AIRFLOW__WEBSERVER__PAGE_SIZE

proxy_fix_x_for¶

版本 1.10.7 新增功能。

要信任 X-Forwarded-For 的值數量。請參閱 Werkzeug: X-Forwarded-For Proxy Fix 以取得更多詳細資訊。

類型: 整數
預設值: 1
環境變數: AIRFLOW__WEBSERVER__PROXY_FIX_X_FOR

proxy_fix_x_host¶

版本 1.10.7 新增功能。

要信任 X-Forwarded-Host 的值數量。請參閱 Werkzeug: X-Forwarded-For Proxy Fix 以取得更多詳細資訊。

類型: 整數
預設值: 1
環境變數: AIRFLOW__WEBSERVER__PROXY_FIX_X_HOST

proxy_fix_x_port¶

版本 1.10.7 新增功能。

要信任 X-Forwarded-Port 的值數量。請參閱 Werkzeug: X-Forwarded-For Proxy Fix 以取得更多詳細資訊。

類型: 整數
預設值: 1
環境變數: AIRFLOW__WEBSERVER__PROXY_FIX_X_PORT

proxy_fix_x_prefix¶

版本 1.10.7 新增功能。

要信任 X-Forwarded-Prefix 的值數量。請參閱 Werkzeug: X-Forwarded-For Proxy Fix 以取得更多詳細資訊。

類型: 整數
預設值: 1
環境變數: AIRFLOW__WEBSERVER__PROXY_FIX_X_PREFIX

proxy_fix_x_proto¶

版本 1.10.7 新增功能。

要信任 X-Forwarded-Proto 的值數量。請參閱 Werkzeug: X-Forwarded-For Proxy Fix 以取得更多詳細資訊。

類型: 整數
預設值: 1
環境變數: AIRFLOW__WEBSERVER__PROXY_FIX_X_PROTO

reload_on_plugin_change¶

版本 1.10.11 新增。

如果設定為 True，Airflow 將追蹤 plugins_folder 目錄中的檔案。當偵測到變更時，重新載入 gunicorn。如果設定為 True，gunicorn 將在不預先載入的情況下啟動，速度較慢、使用更多記憶體，並可能導致競爭狀況。避免在生產環境中將此設定為 True。

類型: 布林值
預設值: False
環境變數: AIRFLOW__WEBSERVER__RELOAD_ON_PLUGIN_CHANGE

require_confirmation_dag_change¶

版本 2.9.0 新增功能。

在 Web UI 中變更 DAG 時需要確認。這是為了防止意外變更可能在生產等敏感環境中執行的 DAG。當設定為 True 時，當使用者嘗試暫停/取消暫停、觸發 DAG 時，將顯示確認對話方塊

類型: 布林值
預設值: False
環境變數: AIRFLOW__WEBSERVER__REQUIRE_CONFIRMATION_DAG_CHANGE

run_internal_api¶

版本 2.6.0 新增。

在 webserver 中執行內部 API 的布林值。

類型: 布林值
預設值: False
環境變數: AIRFLOW__WEBSERVER__RUN_INTERNAL_API

secret_key¶

用於執行 flask 應用程式的密鑰。它應盡可能隨機。但是，當執行多個 webserver 執行個體時，請確保它們都使用相同的 secret_key，否則其中一個將會出現「CSRF session token is missing」錯誤。網頁伺服器金鑰也用於授權對 Celery Worker 的請求，以便在擷取記錄時使用。使用密鑰產生的 Token 有一個短暫的到期時間 - 請確保您執行 Airflow 元件的所有機器上的時間都已同步 (例如使用 ntpd)，否則當存取記錄時，您可能會收到「forbidden」錯誤。

類型

字串

預設值

{SECRET_KEY}

環境變數

AIRFLOW__WEBSERVER__SECRET_KEY

AIRFLOW__WEBSERVER__SECRET_KEY_CMD

AIRFLOW__WEBSERVER__SECRET_KEY_SECRET

session_backend¶

2.2.4 版本的新功能。

用於儲存 Web Session 資料的後端類型，可以是 database 或 securecookie。對於 database 後端，Session 會儲存在資料庫中，並且可以在那裡管理 (例如，當您重設使用者的密碼時，該使用者的所有 Session 都會被刪除)。對於 securecookie 後端，Session 會儲存在用戶端加密的 Cookie 中。securecookie 機制比資料庫後端「更輕量」，但是當您重設使用者的密碼時，Session 不會被刪除，這表示除了等待到期時間之外，使使用者的所有 Session 失效的唯一方法是變更 secret_key 並重新啟動 Web Server (這也會使所有其他使用者的 Session 失效並登出)。

當您使用 database 後端時，請務必定期執行 airflow db clean --table session 命令，以保持您的資料庫 Session 表格小巧，特別是如果您有自動化的 API 呼叫，每次呼叫都會建立新的 Session，而不是重複使用儲存在瀏覽器 Cookie 中的 Session。

類型: 字串
預設值: database
環境變數: AIRFLOW__WEBSERVER__SESSION_BACKEND
範例: securecookie

session_lifetime_minutes¶

版本 1.10.13 新增。

UI Cookie 的生命週期 (分鐘)。使用者在非活動 [webserver] session_lifetime_minutes 分鐘後將從 UI 登出

類型: 整數
預設值: 43200
環境變數: AIRFLOW__WEBSERVER__SESSION_LIFETIME_MINUTES

show_recent_stats_for_completed_runs¶

版本 2.0.0 新增。

如果設定，則「最近任務」統計資訊將顯示舊的 DagRun

類型: 布林值
預設值: True
環境變數: AIRFLOW__WEBSERVER__SHOW_RECENT_STATS_FOR_COMPLETED_RUNS

show_trigger_form_if_no_params¶

版本 2.7.0 新增。

沒有參數的 DAG 的觸發 DAG 執行按鈕的行為。False 跳過並觸發，而不顯示新增 dag_run.conf 的表單，True 始終顯示表單。如果定義了參數，則始終顯示表單。

類型: 布林值
預設值: False
環境變數: AIRFLOW__WEBSERVER__SHOW_TRIGGER_FORM_IF_NO_PARAMS

warn_deployment_exposure¶

版本 2.3.0 新增。

用於顯示公開可檢視部署的警告的布林值

類型: 布林值
預設值: True
環境變數: AIRFLOW__WEBSERVER__WARN_DEPLOYMENT_EXPOSURE

web_server_host¶

啟動網頁伺服器時指定的 IP

類型: 字串
預設值: 0.0.0.0
環境變數: AIRFLOW__WEBSERVER__WEB_SERVER_HOST

web_server_master_timeout¶

網頁伺服器在終止沒有回應的 gunicorn Master 之前等待的秒數

類型: 字串
預設值: 120
環境變數: AIRFLOW__WEBSERVER__WEB_SERVER_MASTER_TIMEOUT

web_server_port¶

執行網頁伺服器的連接埠

類型: 字串
預設值: 8080
環境變數: AIRFLOW__WEBSERVER__WEB_SERVER_PORT

web_server_ssl_cert¶

網頁伺服器的 SSL 憑證和金鑰路徑。當兩者都提供時，將啟用 SSL。這不會變更網頁伺服器連接埠。

類型: 字串
預設值: ''
環境變數: AIRFLOW__WEBSERVER__WEB_SERVER_SSL_CERT

web_server_ssl_key¶

網頁伺服器的 SSL 憑證和金鑰路徑。當兩者都提供時，將啟用 SSL。這不會變更網頁伺服器連接埠。

類型: 字串
預設值: ''
環境變數: AIRFLOW__WEBSERVER__WEB_SERVER_SSL_KEY

web_server_worker_timeout¶

gunicorn 網頁伺服器在 Worker 超時之前等待的秒數

類型: 字串
預設值: 120
環境變數: AIRFLOW__WEBSERVER__WEB_SERVER_WORKER_TIMEOUT

worker_class¶

gunicorn 應使用的 Worker 類別。選項包括 sync (預設)、eventlet、gevent。

警告

當使用 gevent 時，您可能也想要將 _AIRFLOW_PATCH_GEVENT 環境變數設定為 "1"，以確保盡早完成 gevent 修補。

請小心僅在網頁伺服器上設定 _AIRFLOW_PATCH_GEVENT，因為 gevent 修補可能會透過 multiprocessing sockets 模組影響排程器行為，並導致崩潰。

請參閱相關的 Issue / PR 以取得更多詳細資訊

類型: 字串
預設值: sync
環境變數: AIRFLOW__WEBSERVER__WORKER_CLASS

worker_refresh_batch_size¶

一次重新整理的 Worker 數量。當設定為 0 時，會停用 Worker 重新整理。當為非零時，Airflow 會定期重新整理網頁伺服器 Worker，方法是啟動新的 Worker 並終止舊的 Worker。

類型: 字串
預設值: 1
環境變數: AIRFLOW__WEBSERVER__WORKER_REFRESH_BATCH_SIZE

worker_refresh_interval¶

等待重新整理一批 Worker 的秒數。

類型: 字串
預設值: 6000
環境變數: AIRFLOW__WEBSERVER__WORKER_REFRESH_INTERVAL

workers¶

執行 Gunicorn 網頁伺服器的 Worker 數量

類型: 字串
預設值: 4
環境變數: AIRFLOW__WEBSERVER__WORKERS

x_frame_enabled¶

版本 1.10.8 新增。

允許 UI 在框架中呈現

類型: 布林值
預設值: True
環境變數: AIRFLOW__WEBSERVER__X_FRAME_ENABLED

auth_rate_limit (已停用)¶

版本 2.9.0 已停用：此選項已移至 fab.auth_rate_limit

auth_rate_limited (已停用)¶

版本 2.9.0 已停用：此選項已移至 fab.auth_rate_limited

update_fab_perms (已停用)¶

版本 2.9.0 已停用：此選項已移至 fab.update_fab_perms