配置參考¶
本頁包含 apache-airflow-providers-opensearch Provider 所有可用的 Airflow 配置列表,這些配置可以在 airflow.cfg 檔案中或使用環境變數設定。
注意
提供程式中嵌入的配置從 Airflow 2.7.0 開始使用。之前,配置在 Airflow 核心包中描述和配置 - 因此如果您使用的 Airflow 版本低於 2.7.0,請查閱 Airflow 文件,瞭解 Airflow 核心中可用的配置選項列表。
注意
更多資訊請參閱 設定配置選項。
[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 或 log.offset)
- 型別:
字串
- 預設:
offset- 環境變數:
AIRFLOW__OPENSEARCH__OFFSET_FIELD
password¶
自版本 1.5.0 新增。
連線 Opensearch 的密碼
- 型別:
字串
- 預設:
''- 環境變數:
AIRFLOW__OPENSEARCH__PASSWORDAIRFLOW__OPENSEARCH__PASSWORD_CMDAIRFLOW__OPENSEARCH__PASSWORD_SECRET
port¶
自版本 1.5.0 新增。
Opensearch 主機的埠號
- 型別:
整數
- 預設:
''- 環境變數:
AIRFLOW__OPENSEARCH__PORT
username¶
自版本 1.5.0 新增。
連線 Opensearch 的使用者名稱
- 型別:
字串
- 預設:
''- 環境變數:
AIRFLOW__OPENSEARCH__USERNAMEAIRFLOW__OPENSEARCH__USERNAME_CMDAIRFLOW__OPENSEARCH__USERNAME_SECRET
write_stdout¶
自版本 1.5.0 新增。
將任務日誌寫入 worker 的標準輸出,而不是預設檔案
- 型別:
字串
- 預設:
False- 環境變數:
AIRFLOW__OPENSEARCH__WRITE_STDOUT
[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