ignore_errors パラメーター
ignore_errors パラメーターは、すべての Robot で Step レベルで使用できます。ワークフローでファイルごとの特定のエラーを許容できる場合に、Assemblyの処理を継続できます。
どのような場合に役立つか
ignore_errors は、全体が失敗するよりも一部が成功するほうが望ましい場合に役立ちます。代表的な例は次のとおりです。
- 一部のファイルが不正な形式、または未対応の形式であることを想定したバッチ処理
- メタデータの抽出が必須ではないパイプライン
- ファイルの欠落や一時的な取得不能によって、ほかのすべてのファイルの処理を停止させたくない大規模なインポート
使用できる値
すべての Robot で meta と execute を使用できます。インポート用 Robot では、さらに import も使用できます。
| 値 | 動作 |
|---|---|
(省略)、false、または [] | デフォルトの動作:エラーを無視しません。 |
true | その Robot で対応しているすべてのフェーズのエラーを無視します。 |
["meta"] | メタデータ抽出エラーを無視します。 |
["execute"] | 実行/トランスコードエラーを無視します。 |
["meta", "execute"] | メタデータエラーと実行エラーの両方を無視します。 |
["import"] | インポート用 Robot のみ:インポート/取得エラーを無視します。 |
["meta", "import", "execute"] | インポート用 Robot のみ:対応しているすべてのフェーズのエラーを無視します。 |
使用例
画像のサイズ変更を行うステップでメタデータ抽出エラーを無視する例です。
{
"steps": {
":original": {
"robot": "/upload/handle"
},
"resized": {
"use": ":original",
"robot": "/image/resize",
"width": 1200,
"ignore_errors": ["meta"]
}
}
}
インポートを行うステップでインポートエラーを無視する例です。
{
"steps": {
"imported": {
"robot": "/s3/import",
"credentials": "YOUR_S3_CREDENTIALS",
"path": "/incoming/",
"ignore_errors": ["import"]
},
"encoded": {
"use": "imported",
"robot": "/video/encode",
"preset": "ipad-high"
}
}
}
対応しているすべてのフェーズのエラーを無視する例です。
{
"steps": {
"imported": {
"robot": "/http/import",
"url": "https://example.com/multi-file-feed.json",
"ignore_errors": true
}
}
}
注意事項とベストプラクティス
ignore_errorsは、目的を明確にして使用してください。耐障害性は向上しますが、多用すると問題を見逃すおそれがあります。- 可能な限り、
trueを使うよりも、対象を絞った配列を使用してください(たとえば["meta"]のみ)。 - Assembly Statusを監視し、無視された失敗を確認してください。無視されたエラーは、
ignored_errorsやignored_error_countなどのフィールドで報告されます。 - 一部のインポート処理で、メタデータ関連の問題が発生してもファイルを出力する必要がある場合は、🤖/http/import の
import_on_errorsなど、Robot 固有のオプションも確認してください。