配置参考¶
此页面列出了 apache-airflow-providers-opensearch 提供程序的所有可用 Airflow 配置，这些配置可以在 airflow.cfg 文件中设置或通过环境变量进行设置。
注意
欲了解更多信息，请参阅 设置配置选项。
[opensearch]¶
end_of_log_mark¶
自 1.5.0 版起添加。
用于标记任务日志流结束的标记
- 类型：
字符串
- 默认值：
end_of_log- 环境变量：
AIRFLOW__OPENSEARCH__END_OF_LOG_MARK
host¶
自 1.5.0 版起添加。
Opensearch 主机
- 类型：
字符串
- 默认值：
''- 环境变量：
AIRFLOW__OPENSEARCH__HOST
host_field¶
自 1.5.0 版起添加。
存放主机名的字段（通常为 host 或 host.name）
- 类型：
字符串
- 默认值：
host- 环境变量：
AIRFLOW__OPENSEARCH__HOST_FIELD
index_patterns¶
自 1.5.0 版起添加。
用于搜索日志的索引模式的逗号分隔列表（默认：_all）。index_patterns_callable 的返回值优先于此设置。
- 类型：
字符串
- 默认值：
_all- 环境变量：
AIRFLOW__OPENSEARCH__INDEX_PATTERNS- 示例：
something-*
index_patterns_callable¶
自 1.5.0 版起添加。
一个字符串，表示指向 Python 可调用对象的完整路径，该对象接受 TI 对象并返回逗号分隔的索引模式列表。此设置的优先级高于 index_patterns。
- 类型：
字符串
- 默认值：
''- 环境变量：
AIRFLOW__OPENSEARCH__INDEX_PATTERNS_CALLABLE- 示例：
module.callable
json_fields¶
自 1.5.0 版起添加。
如果启用，附加到 JSON 输出的日志字段
- 类型：
字符串
- 默认值：
asctime, filename, lineno, levelname, message- 环境变量：
AIRFLOW__OPENSEARCH__JSON_FIELDS
json_format¶
自 1.5.0 版起添加。
使用 JSON 格式写入日志行（替代默认的日志格式化器）
- 类型：
字符串
- 默认值：
False- 环境变量：
AIRFLOW__OPENSEARCH__JSON_FORMAT
log_id_template¶
自 1.5.0 版起添加。
用于查询特定任务日志的 log_id 的格式
- 类型：
字符串
- 默认值：
{dag_id}-{task_id}-{run_id}-{map_index}-{try_number}- 环境变量：
AIRFLOW__OPENSEARCH__LOG_ID_TEMPLATE
offset_field¶
自 1.5.0 版起添加。
存放 offset 的字段（通常为 offset 或 log.offset）
- 类型：
字符串
- 默认值：
offset- 环境变量：
AIRFLOW__OPENSEARCH__OFFSET_FIELD
密码¶
自 1.5.0 版起添加。
连接 Opensearch 的密码
- 类型：
字符串
- 默认值：
''- 环境变量：
AIRFLOW__OPENSEARCH__PASSWORDAIRFLOW__OPENSEARCH__PASSWORD_CMDAIRFLOW__OPENSEARCH__PASSWORD_SECRET
端口¶
自 1.5.0 版起添加。
Opensearch 主机的端口号
- 类型：
整数
- 默认值：
''- 环境变量：
AIRFLOW__OPENSEARCH__PORT
target_index¶
自 1.9.0 版起添加。
启用直接 OpenSearch 日志写入时要写入的索引名称
- 类型：
字符串
- 默认值：
airflow-logs- 环境变量：
AIRFLOW__OPENSEARCH__TARGET_INDEX
用户名¶
自 1.5.0 版起添加。
连接 Opensearch 的用户名
- 类型：
字符串
- 默认值：
''- 环境变量：
AIRFLOW__OPENSEARCH__USERNAMEAIRFLOW__OPENSEARCH__USERNAME_CMDAIRFLOW__OPENSEARCH__USERNAME_SECRET
write_stdout¶
自 1.5.0 版起添加。
将任务日志写入工作节点的 stdout，而不是默认的文件
- 类型：
字符串
- 默认值：
False- 环境变量：
AIRFLOW__OPENSEARCH__WRITE_STDOUT
write_to_os¶
自 1.9.0 版起添加。
将任务日志直接写入 OpenSearch
- 类型：
字符串
- 默认值：
False- 环境变量：
AIRFLOW__OPENSEARCH__WRITE_TO_OS
[opensearch_configs]¶
ca_certs¶
自 1.5.0 版起添加。
- 类型：
字符串
- 默认值：
''- 环境变量：
AIRFLOW__OPENSEARCH_CONFIGS__CA_CERTS
http_compress¶
自 1.5.0 版起添加。
- 类型：
字符串
- 默认值：
False- 环境变量：
AIRFLOW__OPENSEARCH_CONFIGS__HTTP_COMPRESS
ssl_assert_hostname¶
自 1.5.0 版起添加。
- 类型：
字符串
- 默认值：
False- 环境变量：
AIRFLOW__OPENSEARCH_CONFIGS__SSL_ASSERT_HOSTNAME
ssl_show_warn¶
自 1.5.0 版起添加。
- 类型：
字符串
- 默认值：
False- 环境变量：
AIRFLOW__OPENSEARCH_CONFIGS__SSL_SHOW_WARN
use_ssl¶
自 1.5.0 版起添加。
- 类型：
字符串
- 默认值：
False- 环境变量：
AIRFLOW__OPENSEARCH_CONFIGS__USE_SSL
verify_certs¶
自 1.5.0 版起添加。
- 类型：
字符串
- 默认值：
False- 环境变量：
AIRFLOW__OPENSEARCH_CONFIGS__VERIFY_CERTS