Doris Streamloader

概要

Doris Streamloaderは、Apache Dorisにデータを読み込むために設計されたクライアントツールです。curlを使用したシングルスレッド読み込みと比較して、並行読み込み機能により大きなデータセットの読み込み待機時間を短縮します。以下の機能を備えています：

• 並列読み込み: Stream Load方式のマルチスレッド読み込み。workersパラメータを使用して並列度を設定できます。
• マルチファイル読み込み: 複数のファイルとディレクトリを一度に同時読み込み。再帰的ファイル取得をサポートし、ワイルドカード文字でファイル名を指定できます。
• パストラバーサルサポート: ソースファイルがディレクトリにある場合のパストラバーサルをサポート
• 復旧性と継続性: 部分的な読み込み失敗の場合、失敗したポイントからデータ読み込みを再開できます。
• 自動リトライ機能: 読み込み失敗の場合、デフォルトの回数だけ自動的にリトライできます。読み込みが依然として失敗する場合、手動リトライのためのコマンドを出力します。

インストール

ソースコード: https://github.com/apache/doris-streamloader/ バイナリファイル: https://doris.apache.org/download

注記

得られる結果は実行可能バイナリです。

使用方法

doris-streamloader --source_file={FILE_LIST} --url={FE_OR_BE_SERVER_URL}:{PORT} --header={STREAMLOAD_HEADER} --db={TARGET_DATABASE} --table={TARGET_TABLE}

1. FILE_LIST サポート:

• 単一ファイル

  例：単一ファイルを読み込む

  
  doris-streamloader --source_file="dir" --url="http://localhost:8330" --header="column_separator:|?columns:col1,col2" --db="testdb" --table="testtbl"
  

• 単一ディレクトリ

  例：単一ディレクトリを読み込む

  doris-streamloader --source_file="dir" --url="http://localhost:8330" --header="column_separator:|?columns:col1,col2" --db="testdb" --table="testtbl"        

• ワイルドカード文字を含むファイル名（クォートで囲む）

  例：file0.csv、file1.csv、file2.csvを読み込む

  doris-streamloader --source_file="file*" --url="http://localhost:8330" --header="column_separator:|?columns:col1,col2" --db="testdb" --table="testtbl"

• カンマで区切られたファイルのリスト

  例：file0.csv、file1.csv、file2.csvを読み込む

   doris-streamloader --source_file="file0.csv,file1.csv,file2.csv" --url="http://localhost:8330" --header="column_separator:|?columns:col1,col2" --db="testdb" --table="testtbl"

• カンマで区切られたディレクトリのリスト

  例: dir1, dir2, dir3 をロードする

   doris-streamloader --source_file="dir1,dir2,dir3" --url="http://localhost:8330" --header="column_separator:|?columns:col1,col2" --db="testdb" --table="testtbl" 

2. STREAMLOAD_HEADER は、複数ある場合に '?' で区切られたすべてのstreamloadヘッダーをサポートします

例：

doris-streamloader --source_file="data.csv" --url="http://localhost:8330" --header="column_separator:|?columns:col1,col2" --db="testdb" --table="testtbl"

上記のパラメータは必須であり、以下のパラメータはオプションです：

Parameter	デスクリプション	デフォルト値	Suggestions
--u	データベースのユーザー名	root
--p	パスワード	empty string
--compress	HTTP送信時にデータを圧縮するかどうか	false	デフォルトのままにしてください。圧縮と解凍はDoris Streamloader側の負荷とDoris BE側のCPUリソースを増加させる可能性があるため、ネットワーク帯域幅が制限されている場合にのみ有効にすることをお勧めします。
--timeout	Dorisに送信されるHTTPリクエストのタイムアウト（秒）	60*60*10	デフォルトのままにしてください
--batch	ファイルのバッチ読み取りおよび送信の粒度（行）	4096	デフォルトのままにしてください
--batch_byte	ファイルのバッチ読み取りおよび送信の粒度（バイト）	943718400 (900MB)	デフォルトのままにしてください
--workers	データロードの並行レベル	0	"0"は自動モードを意味し、streamloadの速度はデータサイズとディスクスループットに基づきます。高性能クラスターの場合はこの値を上げることができますが、10以下に保つことをお勧めします。過度なメモリ使用量が観察される場合（ログのmemtracker経由）、この値を下げることができます。
--disk_throughput	ディスクスループット（MB/s）	800	通常はデフォルトのままにしてください。このパラメータはworkersの自動推定の基礎となります。より適切なworkersの値を得るために、ニーズに基づいてこれを調整できます。
--streamload_throughput	Streamloadスループット（MB/s）	100	通常はデフォルトのままにしてください。デフォルト値は、日次性能テスト環境で提供されるstreamloadスループットと予測性能から導出されます。より適切なworkersの値を得るために、測定されたstreamloadスループット（LoadBytes1000）/（LoadTimeMs1024*1024）に基づいてこれを設定できます。
--max_byte_per_task	各ロードタスクの最大データサイズ。このサイズを超えるデータセットについては、残りの部分が新しいロードタスクに分割されます。	107374182400 (100G)	ロードバージョンの数を減らすため、これは大きくすることをお勧めします。ただし、"body exceed max size"エラーが発生し、streaming_load_max_mbパラメータの調整（バックエンドの再起動が必要）を避けたい場合、または"-238 TOO MANY SEGMENT"エラーが発生した場合は、一時的にこの値を下げることができます。
--check_utf8	ロードされたデータのエンコーディングをチェックするかどうか： 1) false、チェックなしで生データを直接ロード； 2) true、非UTF-8文字を�で置換	true	デフォルトのままにしてください
--debug	デバッグログを出力	false	デフォルトのままにしてください
--auto_retry	自動再試行する失敗したworkersとタスクのリスト	empty string	これはロードが失敗した場合にのみ使用されます。失敗したworkersとタスクのシリアル番号が表示され、必要なのはコマンド全体をコピーして実行することです。例えば、--auto_retry="1,1;2,1"の場合、失敗したタスクには最初のworkerの最初のタスクと2番目のworkerの最初のタスクが含まれることを意味します。
--auto_retry_times	自動再試行回数	3	デフォルトのままにしてください。再試行が不要な場合は、これを0に設定できます。
--auto_retry_interval	自動再試行の間隔	60	デフォルトのままにしてください。ロード失敗がDorisのダウンタイムによって引き起こされた場合は、Dorisの再起動間隔に基づいてこのパラメータを設定することをお勧めします。
--log_filename	ログ保存のパス	""	ログはデフォルトでコンソールに出力されます。ログファイルに出力するには、--log_filename="/var/log"のようにパスを設定できます。

結果の説明

データロードが成功または失敗に関わらず、結果が返されます。

Parameter	デスクリプション
Status	ロード成功または失敗
TotalRows	総行数
FailLoadRows	ロードに失敗した行数
LoadedRows	ロードされた行数
FilteredRows	フィルタリングされた行数
UnselectedRows	選択されなかった行数
LoadBytes	ロードされたバイト数
LoadTimeMs	実際のロード時間
LoadFiles	ロードされたファイルのリスト

例：

• ロードが成功した場合、次のような結果が表示されます：

  Load Result: {
          "Status": "Success",
          "TotalRows": 120,
          "FailLoadRows": 0,
          "LoadedRows": 120,
          "FilteredRows": 0,
          "UnselectedRows": 0,
          "LoadBytes": 40632,
          "LoadTimeMs": 971,
          "LoadFiles": [
                  "basic.csv",
                  "basic_data1.csv",
                  "basic_data2.csv",
                  "dir1/basic_data.csv",
                  "dir1/basic_data.csv.1",
                  "dir1/basic_data1.csv"
          ]
  }

• 読み込みが失敗した場合（または部分的に失敗した場合）、再試行メッセージが表示されます：

  load has some error and auto retry failed, you can retry by : 
  ./doris-streamloader --source_file /mnt/disk1/laihui/doris/tools/tpch-tools/bin/tpch-data/lineitem.tbl.1  --url="http://127.0.0.1:8239" --header="column_separator:|?columns: l_orderkey, l_partkey, l_suppkey, l_linenumber, l_quantity, l_extendedprice, l_discount, l_tax, l_returnflag,l_linestatus, l_shipdate,l_commitdate,l_receiptdate,l_shipinstruct,l_shipmode,l_comment,temp" --db="db" --table="lineitem1" -u root -p "" --compress=false --timeout=36000 --workers=3 --batch=4096 --batch_byte=943718400 --max_byte_per_task=1073741824 --check_utf8=true --report_duration=1 --auto_retry="2,1;1,1;0,1" --auto_retry_times=0 --auto_retry_interval=60

コマンドをコピーして実行できます。失敗メッセージも提供されます：

Load Result: {
      "Status": "Failed",
      "TotalRows": 1,
      "FailLoadRows": 1,
      "LoadedRows": 0,
      "FilteredRows": 0,
      "UnselectedRows": 0,
      "LoadBytes": 0,
      "LoadTimeMs": 104,
      "LoadFiles": [
              "/mnt/disk1/laihui/doris/tools/tpch-tools/bin/tpch-data/lineitem.tbl.1"
      ]
}

ベストプラクティス

パラメータの推奨事項

1. 必須パラメータ：

--source_file=FILE_LIST --url=FE_OR_BE_SERVER_URL_WITH_PORT --header=STREAMLOAD_HEADER --db=TARGET_DATABASE --table=TARGET_TABLE If you need to load multiple files, you should configure all of them at a time in source_file.

2. The default value of workers is the number of CPU cores. When that is large, for example, 96 cores, the value of workers should be dialed down. The recommended value for most cases is 8.

3. max_byte_per_task is recommended to be large in order to reduce the number of load versions. However, if you encounter a "body exceed max size" and try to avoid adjusting the streaming_load_max_mb parameter (which requires restarting the backend), or if you encounter a -238 TOO MANY SEGMENT error, you can temporarily dial this down. For most cases, this can remain as default.

Two parameters that impacts the number of versions:

• workers: The more workers, the higher concurrency level, and thus the more versions. The recommended value for most cases is 8.
• max_byte_per_task: The larger max_byte_per_task , the larger data size in one single version, and thus the less versions. However, if this is excessively high, it could easily cause an -238 TOO MANY SEGMENT error. For most cases, this can remain as default.

Recommended commands

In most cases, you only need to set the required parameters and workers.

./doris-streamloader --source_file="demo.csv,demoFile*.csv,demoDir" --url="http://127.0.0.1:8030" --header="column_separator:," --db="demo" --table="test_load" --u="root" --workers=8

FAQ

• Before resumable loading was available, to fix any partial failures in loading would require deleting the current table and starting over. In this case, Doris Streamloader would retry automatically. If the retry fails, a retry command will be printed so you can copy and execute it.

• The default maximum data loading size for Doris Streamloader is limited by BE config streaming_load_max_mb (default: 100GB). If you don't want to restart BE, you can also dial down max_byte_per_task.

  To show current streaming_load_max_mb:

curl "http://127.0.0.1:8040/api/show_config"

- If you encounter an `-238 TOO MANY SEGMENT ` error, you can dial down `max_byte_per_task`.