ベストプラクティス
Transloadit を、セキュリティ、信頼性、パフォーマンスの各面で最大限活用します。
セキュリティ
Template の利用
Template を使うと、Assembly Instructions を当社側に保存できます。保存時は暗号化されます。API リクエストでは、template_id でTemplateを参照します。毎回完全な処理設定を送るより安全で、特に処理設定にサードパーティーの認証情報が含まれる場合に有効です。
Template の利用は、運用面の改善にもつながります。
- アプリを再デプロイせずに、処理の動作を変更できます。
- Template を Assembly Notificationsや Assembly Replaysと組み合わせられます。
- 必要に応じて、特定の値だけを実行時に上書きできます。
詳細はこちらです。
ブラウザー向けリクエストへの署名
クライアントサイドでリクエストを生成できる場合は、Auth Key が見える可能性がある前提で設計してください。Signature Authenticationと、HTTPS エンドポイント(https://api2.transloadit.com)を使用します。
これにより、リクエストの完全性を保護し、不正利用の防止にも役立ちます。
同じことはモバイルアプリにも当てはまります。Android アプリや iOS アプリに Auth Secret を絶対に同梱しないでください。バイナリーから抽出できるためです。代わりに、Android SDKおよび iOS 向け TransloaditKitで示しているように、各リクエストはバックエンドで署名してください。
最小権限の認証情報の利用
ストレージアクセス(たとえば S3)を付与する場合は、必要最小限の操作とパスに認証情報を限定してください。たとえば、書き込み専用のエクスポート用認証情報で十分なことがよくあり、🤖/s3/storeでもその構成で対応できます。
信頼性
非同期処理を優先
ユーザーが処理完了を待たないと次に進めない場合、キュー時間は UX に直接影響します。
よりよいパターンは次のとおりです。
- 先にアップロードまたはインポートします。
- 処理はそのまま非同期で継続させます。
- Assemblyの完了時に Assembly Notificationsでバックエンドを更新します。
これにより、UI の応答性を保ち、変換完了待ちによるユーザーの待機を避けられます。
詳細はこちらです。Webhook と Notification
結果の並び順に依存しない
結果配列は、Step 間で同じ位置に揃うことが保証されません。処理後のファイルを元のファイルに対応付ける必要がある場合は、ID で照合してください。
uploads[*].idresults[*].original_id
Assembly ごとの入力ファイル数を制限
1 つのAssemblyに非常に多くの入力を含めると、かえって問題になることがあります。
- 利用可能な priority job slot を超える可能性があります。
- Assembly の最大実行時間である 8 時間に達するリスクが高まります。
実用的な目安として、アップロードまたはインポートする入力ファイルは、各ファイルの処理量に応じて、Assembly あたり約 500 ~ 1000 ファイルに抑えることをおすすめします。
ignore_errors の意図的な利用
ignore_errors Step パラメーターを使うと、ファイル単位の一部のエラーを許容できる場合でもAssemblyの処理を継続できます。バッチジョブや、任意のメタデータ抽出では特に有用です。一方で、失敗が見えにくくもなるため、用途を明確にしたうえで使ってください。
trueよりも["meta"]のような対象を絞った配列を優先してください。これにより、許容する想定のフェーズだけを無視できます。- Assembly Statusの
ignored_errorsとignored_error_countを監視し、表面化しにくい失敗もチームで把握できるようにしてください。
詳細はこちらです。ignore_errors パラメーター
各 Robot のドキュメントを確認
デモは出発点として有用ですが、本番環境での挙動は Robot ごとに文書化されたオプション、エッジケース、制限事項に左右されることがよくあります。
展開前に、実際のフローが該当する Robot のドキュメントに適合しているか確認してください。
パフォーマンスとコスト
Smart CDN 経由で配信
処理済みアセットをエンドユーザーに配信する場合は、Transloadit Smart CDNを利用してください。
主な利点は次のとおりです。
- エッジ配信によりレイテンシーを低減できます。
- 高負荷時の信頼性が向上します。
- キャッシュにより、繰り返し処理とオリジンサーバーへのトラフィックを削減できます。
ベストプラクティスは次のとおりです。
- 🤖/file/serveでキャッシュ動作を設定します。
- 適している場合は、URL ベースの変換を優先します。
- キャッシュキーは安定的かつ明示的に保ちます。
詳細はこちらです。コンテンツ配信
ファイルをまとめて Assembly 数を減らす
Assemblyは、個々のファイル操作よりも負荷が高くなります。より少ない Assembly にファイルをまとめることで、特に大規模なインポートでは、スループットの向上とオーバーヘッドの削減が見込めます。
インポートでは、再試行しやすさと運用上の安全性を考慮して、バッチ全体のサイズを実用的な範囲に保ってください。
エンコードスタックを最新に保つ
後方互換性を維持するため、古いスタックも引き続き利用できるようにしています。ただし、修正、パフォーマンス改善、コーデックやツールチェーンの更新を取り込むため、定期的に新しいスタックへ更新することをおすすめします。
少なくとも年に 1 回はスタック設定を見直し、本番トラフィックを切り替える前にテストしてください。
請求上限の設定
統合中は、意図しないループが発生して、想定外の使用量スパイクにつながることがあります。請求上限は、そのような事態に備える有効な安全策です。
通常の成長は妨げない一方で、想定外の暴走を抑えられる水準に設定してください。