バグ・レポート・ツールの使用
vz bug-report
ツールを使用して、クラスタ情報を選択して取得し、問題の診断に役立つアーカイブ(*.tar.gz
)ファイルを作成します。アーカイブ・ファイルは、開発チームとサポート・チームが問題を分析して推奨事項を提供するのに役立ちます。Verrazzano CLIを使用したVerrazzanoのインストール、アップグレードまたはアンインストール中に障害が発生した場合、アーカイブ・ファイルが自動的に生成されます。
CLI設定
vz
コマンドライン・ツールを設定するには、こちらのステップに従います。
vz bug-reportツールの使用
my-bug-report.TAR.gz
という名前のTARファイルにバグ・レポートを作成するには:
$ vz bug-report --report-file my-bug-report.tar.gz
サポート・チームおよび開発チームとバグ・レポートを共有する前に、内容を確認することをお薦めします。
使用方法
次の構文を使用して、ターミナル・ウィンドウでvz
コマンドを実行します。
$ vz bug-report [flags]
使用可能なオプション
コマンド | 定義 |
---|---|
-h、--help |
vz bug-report コマンドのヘルプ。 |
-i、--include-namespaces strings |
クラスタ情報を収集するための、デフォルトで収集されるネームスペース(システム・ネームスペース)に加えたネームスペースのカンマ区切りリスト。このフラグは、--include-namespaces ns1 --include-namespaces ns... のように複数回指定できます |
-r、--report-file string |
vz bug-report コマンドによって作成されるレポート・ファイル(*.tar.gz ファイル)。デフォルトでは現在のディレクトリのbug-report.tar.gz です。 |
-l --include-logs |
1つ以上のネームスペースのポッドからのログを含めます。これは--include-namespaces フラグとともに指定されます。 |
-d --duration duration |
ログが収集される期間(秒、分および時間)。 |
-v、--verbose |
詳細出力を有効にします。 |
使用可能なフラグ
これらのフラグは、すべてのコマンドに適用されます。
フラグ | 定義 |
---|---|
--context string |
使用するkubeconfigファイル・コンテキストの名前。 |
--kubeconfig string |
使用するkubeconfigファイルのパス。 |
サンプル
-
クラスタからデータを収集して、バグ・レポート・ファイル
bugreport.tar.gz
を作成します。$ vz bug-report --report-file bugreport.tar.gz
--report-file
を指定しないと、コマンドによってbug-report.tar.gz
が現在のディレクトリに作成されます。 -
クラスタの追加ネームスペース
ns1
を含めて、バグ・レポート・ファイルbugreport.tar.gz
を作成します:$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1
-
フラグ
--include-namespaces
には、カンマ区切り値を含めることができます。これは複数回指定できます。たとえば、次のコマンドでは、追加のネームスペースns1
、ns2
およびns3
を含めてバグ・レポートが作成されます:$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2,ns3 $ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-namespaces ns3
-
--include-namespaces
フラグを指定することで、--include-logs
フラグを使用して、1つ以上のネームスペースのポッドからログを収集します。たとえば、次のコマンドでは、追加のネームスペースns1
およびns2
からのログを含めてバグ・レポートが作成されます:$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs
-
--duration
フラグは、指定された期間のログを収集します。デフォルト値はゼロ(0
)で、完全なポッド・ログを収集します。秒、分および時間を指定できます。たとえば、次のコマンドでは、指定された期間中の追加のネームスペースns1
およびns2
からのログを含めてバグ・レポートが作成されます:$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs --duration 5m $ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs --duration 2h $ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs --duration 300s
フラグ
--include-namespaces
に指定される値では、大/小文字が区別されます。