配置参考¶

此页面包含所有可用的 Airflow 配置列表，您可以在 airflow.cfg 文件中或使用环境变量设置这些配置。

在所有 Airflow 组件中使用相同的配置。虽然每个组件不需要所有配置，但有些配置需要相同，否则它们将无法按预期工作。一个很好的例子是 secret_key，它在 Web 服务器和工作节点上应该相同，以便 Web 服务器能够从工作节点获取日志。

Web 服务器密钥还用于在检索日志时授权对 Celery 工作节点的请求。但是，使用密钥生成的令牌的到期时间很短 - 确保运行 Airflow 组件的所有机器上的时间同步（例如使用 ntpd），否则在访问日志时可能会收到“禁止”错误。

注意

更多信息请参阅设置配置选项。

特定于提供程序的配置选项¶

一些提供程序有自己的配置选项，您可以在提供程序的文档中找到它们的配置细节。

您可以在提供程序包特定的配置中找到所有提供程序配置

Airflow 配置选项¶

部分

[api]
[cli]
[core]
[database]
[debug]
[email]
[kerberos]
[lineage]
[logging]
[metrics]
[operators]
[scheduler]
[secrets]
[sensors]
[sentry]
[smtp]
[triggerer]
[webserver]

[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 错误请求错误。

类型: 布尔值
默认值: False
环境变量: AIRFLOW__API__ENABLE_XCOM_DESERIALIZE_SUPPORT

fallback_page_limit¶

2.0.0 版中的新功能。

当 limit 参数为零或未在 API 请求中提供时，用于设置默认页面限制。否则，如果在 API 请求中将正整数作为 limit 传递，则将用户给定的限制或最大页面限制中的较小者作为 limit。

类型: 整数
默认值: 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 请求的最大页面限制。如果作为参数传递的 limit 大于最大页面限制，则将忽略该 limit，并将最大页面限制值设置为 limit

类型: 整数
默认值: 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 将使用在 Web 服务器上运行的 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 版中的新功能。

反序列化期间可以导入哪些类。这是一个多行值。各个项目将被解析为正则表达式模式。这是[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 版中的新功能。

在每次 dag 运行时检查定义的 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 版中的新功能。

在守护程序模式（调度程序、工作程序等）下运行时，进程使用的默认 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 版中的新功能。

处理 dag 文件的 DagFileProcessor 超时之前的时间

类型: 字符串
默认值: 50
环境变量: AIRFLOW__CORE__DAG_FILE_PROCESSOR_TIMEOUT

dag_ignore_file_syntax¶

2.3.0 版中的新功能。

DAG 目录中的.airflowignore文件中使用的模式语法。有效值为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传递一些键值对，则这些键值对将覆盖 params 中现有的键值对。

类型: 字符串
默认值: 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 版中的新功能。

对于 dagbag 导入错误，是否应在 UI 中显示回溯，而不是仅显示异常消息

类型: 布尔值
默认值: 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 版中的新功能。

要提供给数据集管理器的关键字参数。

类型

字符串

默认值

无

环境变量

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的现有部署中不会产生任何影响。对于现有部署，用户可以使用 Web 服务器、API 或 CLI 更改槽数

类型: 字符串
默认值: 128
环境变量: AIRFLOW__CORE__DEFAULT_POOL_TASK_SLOT_COUNT

default_task_execution_timeout¶

2.3.0 版中的新功能。

运算符的默认任务 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 版中的新功能。

用于计算任务有效总优先级权重的加权方法

类型: 字符串
默认值: downstream
环境变量: 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¶

是否禁用 dags 的序列化

类型: 字符串
默认值: True
环境变量: AIRFLOW__CORE__DONOT_PICKLE

enable_xcom_pickling¶

是否为 xcom 启用序列化（请注意，这是不安全的，并且允许 RCE 漏洞利用）。

另请参阅

https://docs.pythonlang.cn/3/library/pickle.html#comparison-with-json

类型: 字符串
默认值: False
环境变量: AIRFLOW__CORE__ENABLE_XCOM_PICKLING

execute_tasks_new_python_interpreter¶

2.0.0 版中的新功能。

任务是否应该通过父进程的 fork 来执行

False：通过父进程的 fork 执行
True：生成一个新的 Python 进程，比 fork 慢，但这意味着插件更改会立即被任务获取

另请参阅

插件何时（重新）加载？

类型: 布尔值
默认值: 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_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 信号后清理的时间（以秒为单位），然后才会收到 SIGKILLED 信号

类型: 字符串
默认值: 60
环境变量: AIRFLOW__CORE__KILLED_TASK_CLEANUP_TIME

lazy_discover_providers¶

2.0.0 版中的新功能。

默认情况下，Airflow 提供程序是延迟发现的（仅在需要时才进行发现和导入）。如果希望在每次通过 cli 调用“airflow”或从模块加载“airflow”时都发现提供程序，请将其设置为 False。

类型: 布尔值
默认值: True
环境变量: AIRFLOW__CORE__LAZY_DISCOVER_PROVIDERS

lazy_load_plugins¶

2.0.0 版中的新功能。

默认情况下，Airflow 插件是延迟加载的（仅在需要时才加载）。如果希望在每次通过 cli 调用“airflow”或从模块加载“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，这意味着默认情况下 dags 永远不会暂停。

类型: 字符串
默认值: 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 都存储在数据库中。如果此数字太小，则在尝试查看较旧任务的任务实例视图中的 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 dags，如果定义了 dags，则返回 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

安全¶

要使用的安全模块（例如 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，则应引发异常。默认情况下，此配置为 false，这意味着 Airflow 2.x 仅警告用户。在 Airflow 3 中，默认情况下将启用此配置。

类型: 布尔值
默认值: False
环境变量: AIRFLOW__CORE__STRICT_DATASET_URI_VALIDATION

task_runner¶

用于在子进程中运行任务实例的类。选项包括 StandardTaskRunner、CgroupTaskRunner 或使用自定义任务运行器时类的完整导入路径。

类型: 字符串
默认值: StandardTaskRunner
环境变量: AIRFLOW__CORE__TASK_RUNNER

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

[数据库]¶

alembic_ini_file_path¶

2.7.0 版中的新功能。

alembic.ini 文件的路径。您可以提供相对于 Airflow 主目录的文件路径，如果它位于其他位置，则提供绝对路径。

类型: 字符串
默认值: alembic.ini
环境变量: AIRFLOW__DATABASE__ALEMBIC_INI_FILE_PATH

check_migrations¶

2.6.0 版中的新功能。

是否在 Airflow 启动期间运行 alembic 迁移。有时此操作可能很耗时，用户可以通过其他方式（例如，通过 Helm 图表）断言正确的版本。接受 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。如果数据库连接数曾经超过，则较低的配置值将允许系统更快地恢复。

类型: 字符串
默认值: 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_engine_collation_for_ids¶

2.3.0 版中的新功能。

如果 dag_id、task_id、key、external_executor_id 列具有不同的编码，则使用此排序规则。默认情况下，此排序规则与数据库排序规则相同，但是对于 mysql 和 mariadb，默认值为 utf8mb3_bin，以便在排序规则设置为 utf8mb4 变体时，索引键的索引大小不会超过允许的最大索引大小，有关更多详细信息，请参阅 GitHub 问题评论。

类型: 字符串
默认值: 无
环境变量: AIRFLOW__DATABASE__SQL_ENGINE_COLLATION_FOR_IDS

sql_engine_encoding¶

2.3.0 版中的新功能。

数据库的编码

类型: 字符串
默认值: utf-8
环境变量: AIRFLOW__DATABASE__SQL_ENGINE_ENCODING

[调试]¶

fail_fast¶

1.10.8 版中的新功能。

仅与 DebugExecutor 一起使用。如果设置为 True，DAG 将在第一个失败的任务时失败。有助于调试。

类型: 字符串
默认值: False
环境变量: AIRFLOW__DEBUG__FAIL_FAST

[电子邮件]¶

配置电子邮件后端以及是否在重试或失败时发送电子邮件警报

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 版新增。

将用作发件人地址的电子邮件地址。它可以是原始电子邮件，也可以是 发件人姓名 <[email protected]> 格式的完整地址

类型: 字符串
默认值: 无
环境变量: AIRFLOW__EMAIL__FROM_EMAIL
示例: Airflow <[email protected]>

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 上下文。默认情况下，上下文为“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，在 NATted Docker 主机后面使用令牌时很有用。

类型: 布尔值
默认值: True
环境变量: AIRFLOW__KERBEROS__INCLUDE_IP

keytab¶

指定 Airflow 用户的 Kerberos 密钥表文件的路径

类型: 字符串
默认值: 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¶

要使用的血缘后端

类型: 字符串
默认值: ''
环境变量: AIRFLOW__LINEAGE__BACKEND

[logging]¶

base_log_folder¶

2.0.0 版中的新功能。

airflow 应该存储其日志文件的文件夹。此路径必须是绝对路径。有一些现有配置假设将其设置为默认值。如果您选择覆盖此设置，则可能还需要更新 [logging] dag_processor_manager_log_location 和 [logging] child_process_log_directory 设置。

类型: 字符串
默认值: {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

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 解析器日志发送到哪里。如果为“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 Credential 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，该 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" 或 "^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" 或 "^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 版中的新功能。

指定 Airflow 向其发送指标和跟踪的 OpenTelemetry 收集器的主机名或 IP 地址。

类型: 字符串
默认值: localhost
环境变量: AIRFLOW__METRICS__OTEL_HOST

otel_interval_milliseconds¶

2.6.0 版中的新功能。

定义 Airflow 将指标和跟踪批次发送到已配置的 OpenTelemetry 收集器的间隔（以毫秒为单位）。

类型: 整数
默认值: 60000
环境变量: AIRFLOW__METRICS__OTEL_INTERVAL_MILLISECONDS

otel_on¶

2.6.0 版中的新功能。

启用将指标发送到 OpenTelemetry。

类型: 字符串
默认值: False
环境变量: AIRFLOW__METRICS__OTEL_ON

otel_port¶

2.6.0 版中的新功能。

指定 OpenTelemetry 收集器正在侦听的端口。

类型: 字符串
默认值: 8889
环境变量: AIRFLOW__METRICS__OTEL_PORT

otel_prefix¶

2.6.0 版中的新功能。

Airflow 指标的前缀。

类型: 字符串
默认值: airflow
环境变量: AIRFLOW__METRICS__OTEL_PREFIX

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.pythonlang.cn/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 守护程序（或服务器）运行所在的主机地址。

类型: 字符串
默认值: 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 守护程序（或服务器）正在侦听的端口。

类型: 字符串
默认值: 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 版中的新功能。

是否允许向 BaseOperator 操作器传递额外的/未使用的参数（args、kwargs）。如果设置为 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

[调度器]¶

allow_trigger_in_future¶

1.10.8 版中的新功能。

允许在将来执行日期外部触发 DagRuns，仅在 DAG 中的 schedule_interval 设置为 None 时生效。

类型: 布尔值
默认值: False
环境变量: AIRFLOW__SCHEDULER__ALLOW_TRIGGER_IN_FUTURE

allowed_run_id_pattern¶

2.6.3 版本新增。

用于验证用户在触发 DAG 时输入的 run_id 参数有效性的 run_id 模式。此模式不能更改调度器为计划的 DAG 运行或未更改 run_id 参数触发的 DAG 运行生成 run_id 所使用的模式。

类型: 字符串
默认值: ^[A-Za-z0-9_.~:+-]+$
环境变量: AIRFLOW__SCHEDULER__ALLOWED_RUN_ID_PATTERN

catchup_by_default¶

通过将此设置为 False 来关闭调度器追赶。默认行为不变，命令行回填仍然有效，但如果此设置为 False，调度器将不会进行调度器追赶，但是可以在 DAG 定义中针对每个 DAG 单独设置（catchup）。

类型: 布尔值
默认值: 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 字符串时，是否为 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 在此时间（以秒为单位）后被停用。

类型: 整数
默认值: 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 版中的新功能。

调度器在调度和排队任务时应检查（并锁定）多少个 DagRuns。

另请参阅

调度器配置选项

类型: 整数
默认值: 20
环境变量: AIRFLOW__SCHEDULER__MAX_DAGRUNS_PER_LOOP_TO_SCHEDULE

max_dagruns_to_create_per_loop¶

2.0.0 版中的新功能。

每个调度器循环要为其创建 DagRuns 的最大 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 文件后经过的秒数。每隔 [scheduler] min_file_process_interval 秒解析一次 DAG 文件。在此间隔后反映对 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 版中的新功能。

调度器检查孤立任务和 SchedulerJobs 的频率（以秒为单位）。

类型: 浮点数
默认值: 300.0
环境变量: AIRFLOW__SCHEDULER__ORPHANED_TASKS_CHECK_INTERVAL

parsing_cleanup_interval¶

2.5.0 版中的新功能。

检查应停用的过时 DAG（预期文件中不再存在的 DAG）以及不再被引用且应标记为孤立的数据集的频率（以秒为单位）。

类型: 整数
默认值: 60
环境变量: AIRFLOW__SCHEDULER__PARSING_CLEANUP_INTERVAL

parsing_pre_import_modules¶

2.6.0 版中的新功能。

调度器读取 dag 文件以提取将要使用的 airflow 模块，并提前导入它们以避免在每个解析过程中都重新执行此操作。可以将此标志设置为 False 以禁用此行为，以防需要每次都重新导入 airflow 模块（以增加 DAG 解析时间为代价）。

类型: 布尔值
默认值: True
环境变量: AIRFLOW__SCHEDULER__PARSING_PRE_IMPORT_MODULES

parsing_processes¶

1.10.14 版本新增。

调度器可以并行运行多个进程来解析 dag。这定义了将运行多少个进程。

类型: 整数
默认值: 2
环境变量: AIRFLOW__SCHEDULER__PARSING_PROCESSES

pool_metrics_interval¶

2.0.0 版中的新功能。

池使用情况统计信息发送到 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 会启动一个小型 Web 服务器子进程来在此主机上提供运行状况检查

类型: 字符串
默认值: 0.0.0.0
环境变量: AIRFLOW__SCHEDULER__SCHEDULER_HEALTH_CHECK_SERVER_HOST

scheduler_health_check_server_port¶

2.4.0 版中的新功能。

当您启动调度程序时，Airflow 会启动一个小型 Web 服务器子进程来在此端口上提供运行状况检查

类型: 整数
默认值: 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 中的 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 间隔的使用。在 Web 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 发送电子邮件通知时使用的默认“发件人”电子邮件地址。

类型: 字符串
默认值: [email protected]
环境变量: 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

[triggerer]¶

default_capacity¶

2.2.0 版中的新功能。

默认情况下，单个 Triggerer 一次运行的触发器数量。

类型: 字符串
默认值: 1000
环境变量: AIRFLOW__TRIGGERER__DEFAULT_CAPACITY

job_heartbeat_sec¶

2.6.3 版本新增。

Triggerer 作业发送心跳信号以确保其未被终止的频率。

类型: 浮点数
默认值: 5
环境变量: AIRFLOW__TRIGGERER__JOB_HEARTBEAT_SEC

triggerer_health_check_threshold¶

2.7.0 版中的新功能。

如果上次 triggerer 心跳信号发生在 [triggerer] triggerer_health_check_threshold 秒之前，则认为 triggerer 不健康。这由 /health 端点中的运行状况检查和 TriggererJob 的 airflow jobs check CLI 使用。

类型: 浮点数
默认值: 30
环境变量: AIRFLOW__TRIGGERER__TRIGGERER_HEALTH_CHECK_THRESHOLD

[webserver]¶

access_denied_message¶

2.7.0 版中的新功能。

当用户尝试执行超出其授权权限的操作时显示的消息。

类型: 字符串
默认值: 访问被拒绝
环境变量: AIRFLOW__WEBSERVER__ACCESS_DENIED_MESSAGE

access_logfile¶

gunicorn Web 服务器的日志文件。“-” 表示记录到 stderr。

类型: 字符串
默认值: -
环境变量: AIRFLOW__WEBSERVER__ACCESS_LOGFILE

access_logformat¶

2.0.0 版中的新功能。

gunicorn Web 服务器的访问日志格式。默认格式为 %%(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。在 Web UI 中显示 DAG 或触发器表单为 DAG 作者提供了将恶意代码注入客户端浏览器的可能性。为了确保 Web 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

auth_rate_limit¶

2.6.0 版中的新功能。

身份验证端点的速率限制。

自版本 2.9.0 起已弃用：此配置已移至 fab 提供程序。请使用 fab 提供程序中的配置。

类型: 字符串
默认值: 40 秒内 5 次
环境变量: AIRFLOW__WEBSERVER__AUTH_RATE_LIMIT

auth_rate_limited¶

2.6.0 版中的新功能。

用于在身份验证端点上启用速率限制的布尔值。

自版本 2.9.0 起已弃用：此配置已移至 fab 提供程序。请使用 fab 提供程序中的配置。

类型: 布尔值
默认值: True
环境变量: AIRFLOW__WEBSERVER__AUTH_RATE_LIMITED

auto_refresh_interval¶

2.2.0 版中的新功能。

启用自动刷新后，DAG 数据在图形或网格视图中自动刷新的频率（以秒为单位）

类型: 整数
默认值: 3
环境变量: AIRFLOW__WEBSERVER__AUTO_REFRESH_INTERVAL

base_url¶

您网站的基本 URL：Airflow 无法猜测您正在使用的域或 CNAME。这用于在“浏览 - 任务实例”菜单的“日志 URL”列中创建链接，以及在 Airflow 发送的包含指向您的 Web 服务器的链接的任何自动电子邮件中创建链接。

类型: 字符串
默认值: https://127.0.0.1:8080
环境变量: AIRFLOW__WEBSERVER__BASE_URL

caching_hash_method¶

2.6.0 版中的新功能。

Web 服务器使用的缓存算法。必须是有效的 hashlib 函数名称。

类型: 字符串
默认值: md5
环境变量: AIRFLOW__WEBSERVER__CACHING_HASH_METHOD
示例: sha256

config_file¶

2.7.0 版中的新功能。

用于配置 Web 服务器参数的 Web 服务器配置文件的路径

类型: 字符串
默认值: {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、系统时区或任何 IANA 时区字符串（例如 Europe/Amsterdam）。如果留空，则将使用 core/default_timezone 的默认值

类型: 字符串
默认值: UTC
环境变量: AIRFLOW__WEBSERVER__DEFAULT_UI_TIMEZONE
示例: America/New_York

default_wrap¶

版本 1.10.4 中的新增功能。

DAG 代码和 TI 日志视图上的换行切换的默认设置。

类型: 布尔值
默认值: False
环境变量: AIRFLOW__WEBSERVER__DEFAULT_WRAP

enable_proxy_fix¶

版本 1.10.1 中的新增功能。

为反向代理启用 werkzeug ProxyFix 中间件

类型: 布尔值
默认值: False
环境变量: AIRFLOW__WEBSERVER__ENABLE_PROXY_FIX

enable_swagger_ui¶

2.6.0 版中的新功能。

用于在 Web 服务器中运行 SwaggerUI 的布尔值。

类型: 布尔值
默认值: True
环境变量: AIRFLOW__WEBSERVER__ENABLE_SWAGGER_UI

error_logfile¶

gunicorn Web 服务器的日志文件。“-” 表示记录到 stderr。

类型: 字符串
默认值: -
环境变量: AIRFLOW__WEBSERVER__ERROR_LOGFILE

expose_config¶

在 Web 服务器中公开配置文件。设置为 non-sensitive-only 以显示除具有安全隐患的值之外的所有值。True 显示所有值。False 则完全隐藏配置。

类型: 字符串
默认值: False
环境变量: AIRFLOW__WEBSERVER__EXPOSE_CONFIG

expose_hostname¶

1.10.8 版中的新功能。

在 Web 服务器中公开主机名

类型: 字符串
默认值: False
环境变量: AIRFLOW__WEBSERVER__EXPOSE_HOSTNAME

expose_stacktrace¶

1.10.8 版中的新功能。

在 Web 服务器中公开堆栈跟踪

类型: 字符串
默认值: 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¶

默认情况下，Web 服务器会显示已暂停的 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¶

Web 服务器从其他工作机器获取日志时等待初始握手的超时时间（以秒为单位）

类型: 字符串
默认值: 5
环境变量: AIRFLOW__WEBSERVER__LOG_FETCH_TIMEOUT_SEC

num_recent_configurations_for_trigger¶

2.9.0 版中的新功能。

触发 Web 表单的选择器中最近 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 代理修复。

类型: 整数
默认值: 1
环境变量: AIRFLOW__WEBSERVER__PROXY_FIX_X_FOR

proxy_fix_x_host¶

1.10.7 版中的新功能。

X-Forwarded-Host 的信任值数量。有关更多详细信息，请参阅Werkzeug：X-Forwarded-For 代理修复。

类型: 整数
默认值: 1
环境变量: AIRFLOW__WEBSERVER__PROXY_FIX_X_HOST

proxy_fix_x_port¶

1.10.7 版中的新功能。

X-Forwarded-Port 的信任值数量。有关更多详细信息，请参阅Werkzeug：X-Forwarded-For 代理修复。

类型: 整数
默认值: 1
环境变量: AIRFLOW__WEBSERVER__PROXY_FIX_X_PORT

proxy_fix_x_prefix¶

1.10.7 版中的新功能。

X-Forwarded-Prefix 的信任值数量。有关更多详细信息，请参阅Werkzeug：X-Forwarded-For 代理修复。

类型: 整数
默认值: 1
环境变量: AIRFLOW__WEBSERVER__PROXY_FIX_X_PREFIX

proxy_fix_x_proto¶

1.10.7 版中的新功能。

X-Forwarded-Proto 的信任值数量。有关更多详细信息，请参阅Werkzeug：X-Forwarded-For 代理修复。

类型: 整数
默认值: 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 版中的新功能。

用于在 Web 服务器中运行内部 API 的布尔值。

类型: 布尔值
默认值: False
环境变量: AIRFLOW__WEBSERVER__RUN_INTERNAL_API

secret_key¶

用于运行 Flask 应用程序的密钥。它应该尽可能随机。但是，当运行多个 Web 服务器实例时，请确保它们都使用相同的 secret_key，否则其中一个实例会因“缺少 CSRF 会话令牌”而出错。Web 服务器密钥还用于在检索日志时授权对 Celery 工作程序的请求。但是，使用密钥生成的令牌的有效期很短 - 确保运行 Airflow 组件的所有机器上的时间同步（例如使用 ntpd），否则在访问日志时可能会收到“禁止”错误。

类型

字符串

默认值

{SECRET_KEY}

环境变量

AIRFLOW__WEBSERVER__SECRET_KEY

AIRFLOW__WEBSERVER__SECRET_KEY_CMD

AIRFLOW__WEBSERVER__SECRET_KEY_SECRET

session_backend¶

2.2.4 版新增。

用于存储 Web 会话数据的后端类型，可以是 database 或 securecookie。对于 database 后端，会话存储在数据库中，并且可以在那里进行管理（例如，当您重置用户的密码时，该用户的所有会话都将被删除）。对于 securecookie 后端，会话存储在客户端的加密 cookie 中。securecookie 机制比数据库后端“更轻”，但是当您重置用户的密码时，会话不会被删除，这意味着除了等待过期时间之外，使所有用户的会话无效的唯一方法是更改 secret_key 并重新启动 Web 服务器（这也将使所有其他用户的会话无效并注销）。

当您使用 database 后端时，请确保通过定期运行 airflow db clean --table session 命令来保持数据库会话表较小，尤其是在您有自动 API 调用时，这些调用将为每个调用创建一个新会话，而不是重用存储在浏览器 cookie 中的会话。

类型: 字符串
默认值: 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 版中的新功能。

如果设置，则“最近任务”统计信息将显示旧的 DagRuns

类型: 布尔值
默认值: 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

update_fab_perms¶

1.10.7 版中的新功能。

在 Web 服务器启动时更新 FAB 权限并同步安全管理器角色

自版本 2.9.0 起已弃用：此配置已移至 fab 提供程序。请使用 fab 提供程序中的配置。

类型: 字符串
默认值: True
环境变量: AIRFLOW__WEBSERVER__UPDATE_FAB_PERMS

warn_deployment_exposure¶

2.3.0 版中的新功能。

用于显示公开可见部署警告的布尔值

类型: 布尔值
默认值: True
环境变量: AIRFLOW__WEBSERVER__WARN_DEPLOYMENT_EXPOSURE

web_server_host¶

启动 Web 服务器时指定的 IP

类型: 字符串
默认值: 0.0.0.0
环境变量: AIRFLOW__WEBSERVER__WEB_SERVER_HOST

web_server_master_timeout¶

Web 服务器在终止无响应的 gunicorn 主进程之前等待的秒数

类型: 字符串
默认值: 120
环境变量: AIRFLOW__WEBSERVER__WEB_SERVER_MASTER_TIMEOUT

web_server_port¶

运行 Web 服务器的端口

类型: 字符串
默认值: 8080
环境变量: AIRFLOW__WEBSERVER__WEB_SERVER_PORT

web_server_ssl_cert¶

Web 服务器的 SSL 证书和密钥的路径。如果同时提供两者，则将启用 SSL。这不会更改 Web 服务器端口。

类型: 字符串
默认值: ''
环境变量: AIRFLOW__WEBSERVER__WEB_SERVER_SSL_CERT

web_server_ssl_key¶

Web 服务器的 SSL 证书和密钥的路径。如果同时提供两者，则将启用 SSL。这不会更改 Web 服务器端口。

类型: 字符串
默认值: ''
环境变量: AIRFLOW__WEBSERVER__WEB_SERVER_SSL_KEY

web_server_worker_timeout¶

gunicorn Web 服务器在工作进程超时之前等待的秒数

类型: 字符串
默认值: 120
环境变量: AIRFLOW__WEBSERVER__WEB_SERVER_WORKER_TIMEOUT

worker_class¶

gunicorn 应该使用的 worker 类。选项包括 sync（默认）、eventlet、gevent。

警告

使用 gevent 时，您可能还想将 _AIRFLOW_PATCH_GEVENT 环境变量设置为 "1"，以确保尽早完成 gevent 修补。

有关更多详细信息，请参阅相关的 Issue/PR

类型: 字符串
默认值: 同步
环境变量: AIRFLOW__WEBSERVER__WORKER_CLASS

worker_refresh_batch_size¶

每次刷新的工作进程数量。设置为 0 时，将禁用工作进程刷新。如果非零，Airflow 会通过启动新工作进程并终止旧工作进程来定期刷新 Web 服务器工作进程。

类型: 字符串
默认值: 1
环境变量: AIRFLOW__WEBSERVER__WORKER_REFRESH_BATCH_SIZE

worker_refresh_interval¶

刷新一批工作进程前的等待秒数。

类型: 字符串
默认值: 6000
环境变量: AIRFLOW__WEBSERVER__WORKER_REFRESH_INTERVAL

workers¶

运行 Gunicorn Web 服务器的工作进程数量

类型: 字符串
默认值: 4
环境变量: AIRFLOW__WEBSERVER__WORKERS

x_frame_enabled¶

1.10.8 版中的新功能。

允许在框架中渲染 UI

类型: 布尔值
默认值: True
环境变量: AIRFLOW__WEBSERVER__X_FRAME_ENABLED