サポート バンドル ツールを実行する

Automation Suite サポート バンドル ツールは、UiPath® サービスとその他のソフトウェア コンポーネント (Istio、ArgoCD など) のアプリケーション レベルのログを収集します。Automation Suite サポート バンドル ツールには履歴レコードも含まれており、このレコードを使用して問題のトラブルシューティング時にパターンを分析できます。特にクラスターのステートを確認しただけでは問題の潜在的な根本原因がはっきりしない場合、詳細なログが役に立ちます。

Automation Suite サポート バンドル ツールは、UiPath® のサポート チームにガイダンスや修正を依頼する際にも必要です。サポート チームはこのツールを使用して分析を実施するためです。

注:

Automation Suite サポート バンドル ツールは、お客様、お客様のユーザー、お客様のオートメーションの PII や機密データを収集・保存しません。UiPath® アプリケーションが機密情報を漏洩したり、レコードに記録したりすることはありません。プラットフォーム レベルで、ログ コレクターはこのような重要な情報をマスクするように設計されています。

このツールでは、概要レベルの要約された使用状況テレメトリもエクスポートされ、XML ファイルが生成されます。このテレメトリには次のものが含まれます。

• ロボットの種類別の月あたりのロボットの実行時間です。
• ロボットの同時実行数 - 同時に実行されるロボットの最大数です。
• ジョブの実行、プロセスの実行、キュー アイテム、ジョブの失敗率、およびユーザーに関するメトリックです。
• 環境情報。
• AI ユニットの使用状況の概要 (AI Center を使用する場合)。

Customer Portal に XML ファイルをアップロードして、セルフホストの使用状況テレメトリの概要を UiPath サポート チームと共有できます。

Automation Suite 2024.10 以降では、除外リストに service-metrics リストすることで、この要約されたテレメトリの生成をオプトアウトできます。

サポート バンドルを生成する

サポート バンドルを生成するには、次のコマンドを実行します。

./uipathctl health bundle input.json --versions versions.json

このツールですべてのログを収集してローカル/管理マシンの一時的な場所に保存するには、少し時間がかかります。

以下の表に、サポート バンドル ツールでサポートされている任意のフラグのリストを示します。

フラグ	説明
--output-dir string	サポート バンドルを保存するディレクトリを指定します。
--namespace string	UiPath Automation Suite をデプロイする名前空間を指定します。
--include string	バンドルに含める追加のコンポーネントを (コンマ区切りで) 指定します (例: --include=historical-logs)。
--exclude string	バンドルから除外するコンポーネントをコンマで区切って指定します ( など service-metrics)。
--from YYYY-MM-DD	履歴ログを YYYY-MM-DD 形式で収集する開始日です。
--days int	開始日からの履歴ログの収集日の日数です。
--limit-bytes int	バイト単位の整数値を指定して、実行中のポッドのログのサイズを制限します。

注:

• 既定では、 --from フラグが指定されていない場合、指定された --days に関係なく、今日から過去 2 日間の履歴ログが収集されます。
• --fromが指定され、--daysが指定されていない場合、履歴ログは指定された開始日から 2 日間収集されます。

Automation Suite サポート バンドルの構造

.tar.gz アーカイブには、次のファイルとフォルダーが含まれます。

ファイル/フォルダー	説明
current-logs	ライブ ログ (ポッドの現在および以前のインスタンスのログなど) が含まれます。
events.json	すべての名前空間のイベントの説明が含まれます。
alerts	クラスター内のアクティブな Prometheus アラートが含まれます。
namespace/resource/object.yaml	サーバー優先/カスタム名前空間とクラスタースコープのリソースのオブジェクトの説明が含まれます。
service-metrics	個々の XML ファイルに格納される高レベルの使用状況テレメトリが含まれます。

注:

履歴ログは、EKS/AKS 環境ではサポートされていません。