Automation Suite サポート バンドルを使用する

概要

Automation Suite サポート バンドルは、問題の評価と修正に必要な UiPath® サービスや関連オブジェクトのアプリケーション レベルのログを収集します。 Automation Suite サポート バンドルには履歴ログも含まれており、このログを使用して問題のトラブルシューティング時にパターンを分析できます。 履歴ログは、クラスターのステートを確認しただけでは問題の潜在的な根本原因がはっきりしない場合に特に役立ちます。

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

注:

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

Automation Suite サポート バンドル ツールのパラメーター

• 使用状況と構成のテレメトリの概要もこのツールを使用してエクスポートされ、XML ファイルが生成されます。このテレメトリには以下が含まれます。
  • Automation Suite のインストール構成の詳細 (Kubernetes のフレーバー、インストール モード、バージョン、有効化されているサービスなどの設定など)
  • クラスターレベルのリソース使用状況の情報 (CPU やメモリの可用性、使用率などのメトリック)
  • UiPathctl コマンド実行の詳細情報 (ステータス、ログ、実行時間など)
  • 使用状況テレメトリ:
    • ロボットの種類別の月あたりのロボットの実行時間です。
    • ロボットの同時実行数 - 同時に実行されるロボットの最大数です。
    • ジョブの実行、プロセスの実行、キュー アイテム、ジョブの失敗率、およびユーザーに関するメトリックです。
    • 環境情報。
    • AI ユニットの使用状況の概要 (AI Center を使用する場合)。
• UiPath は、このデータを内部レポートにのみ使用し、顧客の理解を強化し、サポートの質と全体的なエクスペリエンスを向上させます。
• Customer Portal に XML ファイルをアップロードして、セルフホストの使用状況テレメトリの概要を UiPath サポート チームと共有できます。
• 要約テレメトリの生成を停止するには、[--exclude=service-metrics] オプションを使用して除外リストにservice-metricsを追加します。このオプションは、v2.2510 以降の Automation Suite で使用できます。

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

サポート バンドルを生成するには、インストーラー ディレクトリから次のコマンドを実行します。

./bin/uipathctl health bundle cluster_config.json --versions versions/helm-charts.json

Automation Suite 2.2510.1 以降では、構成ファイル (cluster_config.json) およびバージョン ファイル (helm-charts.json) のパラメーターへのパスは任意です。サポート バンドルを生成するには、以下を実行します。

./bin/uipathctl health bundle

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

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

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

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

RKE2 バンドルは、サポート バンドルに既定で含まれています。 除外するには、flag --exclude=rke2-bundleを使用します。

履歴ログは既定ではサポート バンドルに含まれません。 これらを含めるには、 フラグ --include=historical-logsを使用します。

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

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

ファイル/フォルダー	説明
logs	Ceph または外部 ObjectStore から収集した履歴ログが含まれます。
current-logs	ライブ ログ (ポッドの現在および以前のインスタンスのログなど) が含まれます。
events.json	すべての名前空間のイベントの説明が含まれます。
alerts	クラスター内のアクティブな Prometheus アラートが含まれます。
server0.tar.gz, server1.tar.gz, ...	クラスター内のすべてのノードの RKE2 バンドルが含まれます。
namespace/resource/object.yaml	サーバー優先/カスタム名前空間とクラスタースコープのリソースのオブジェクトの説明が含まれます。
service-metrics	概要レベルの構成と使用状況のテレメトリが個々の XML ファイルに格納されます。

RKE2 のバンドル構造は次のとおりです。

ディレクトリ	説明
systemlogs	システム イベント、セキュリティ監査、および一般的なシステム メッセージに関連するログが含まれます。
systeminfo	実行中のプロセス、ディスク使用量、CPU 使用率などに関する情報が含まれます。
etcd	etcdキーと値ストアのデータ ストレージに関する情報が含まれます。
journald	systemd-journaldによって管理されるログが含まれます。
networking	iptables、ルーティングなどのネットワーク構成の詳細が含まれています。
rke2	Kubelet のログ、エージェントとサーバーの証明書、crictl に関する情報、クラスターで実行されているリソース、ポッド ログが含まれます。