本ドキュメントでは、DNA Center (Cisco Digital Network Architecture Center) の 'rca' コマンドによるログ採取方法を説明します。本ドキュメント作成時に確認している製品バージョンは、DNA Center version 1.2.8 です。
DNA Center の解析用ログ採取
'rca' コマンドは、 DNA Center の Maglev プラットフォームで動作する解析用ログ収集のためのコマンドラインツールです。TAC からの指示があった場合、本手順にてオフライン解析用のファイルを取得できます。また、各サービスの稼働状況を簡易的に確認するため、'magctl appstack status' コマンド結果も同時に保存しておくと便利です。関連するサービスの概要や稼働状況の確認方法の詳細については、DNA Center の各サービス の記事を参照します。
注意事項
- 再現可能な問題を調査する場合、現象を再現させた直後のタイミングで 'rca' コマンドを実行します。
- 時間が経つと問題が発生していた時の環境情報を採取できなくなる可能性があります。
- 再現手順が GUI 操作を伴う場合、スクリーンショットとあわせて操作時の時刻情報も記録します。エラーが表示されてもすぐ消えてしまう場合など記録が困難な場合は、DNAC: GUI エラーメッセージの確認・保存手順 の記事を参照します。
- マルチ ノード クラスタ環境では、各ノードで 'rca' コマンドを実行し、全ノード分のファイルを採取します。
- 'rca' コマンドの実行には、数分から数十分程度かかります。
事前に準備するもの
- SSH 接続用ターミナルソフトウェア（PuTTY, Tera Term など）
- SCP や SFTP プロトコルをサポートするクライアントソフトウェア (WinSCP など)、または SCP でファイル受信可能なサーバー
- maglev ユーザー(CLI)と admin ユーザー(WebUI)のパスワード
- リモートサーバーへ SCP でコピーをする場合、コピー先サーバの情報（アドレス、パス、ユーザー名、パスワード）
- SCM (Support Case Manager) へログをアップロードする場合、サービスリクエスト番号とトークン
rca ファイルの生成
- ターミナルソフトウェアを利用して SSH にて DNA Center にログインします。ユーザーは'maglev', ポート番号は 2222 です。
$ ssh -p 2222 maglev@<DNA Center の IP アドレス>
- プロンプトから、'sudo rca' コマンドを実行します。sudo パスワードを確認されますので、'maglev' ユーザーのパスワードを入力します。
$ sudo rca
[sudo] password for maglev: <maglev ユーザーのパスワードを入力>
===============================================================
VERIFYING SSH/SUDO ACCESS
===============================================================
Done
changed ownership of '/data/rca' from maglev:maglev to root:root
- ’admin’ ユーザーのパスワードを確認されますので、パスワードを入力します。
===============================================================
VERIFYING ADMINISTRATION ACCESS
Please note that after 3 failed login attempts, diagnostic
collection will proceed, but not all diagnostics will be
collected.
===============================================================
[administration] password for 'admin': <admin ユーザーのパスワードを入力>
User 'admin' logged into 'kong-frontend.maglev-system.svc.cluster.local' successfully
- ログ情報収集中は、ターミナルに rca コマンドの実行状況が出力されます。(この出力自体は DNA Center のログではありません。)
取得時間は規模やログの量により異なりますが、完了までおよそ数分から数十分かかります。
===============================================================
RCA package created on Fri Jan 25 05:55:27 UTC 2019
===============================================================
2019-01-25 05:55:27 | INFO | Generating log for 'date'...
...
- 'rca' コマンド出力結果の最後には、実際に作成したログファイル名とパスが含まれていますので、このフルパスを控えておきます。
Created RCA package: /data/rca/maglev-<DNA Center の IP アドレス>-rca-<YYYY-MM-DD_hh-mm-ss>_UTC.tar.gz
magctl appstack status コマンド結果の取得
- ターミナルソフトウェアを利用して SSH にて DNA Center にログインします。ユーザーは'maglev', ポート番号は 2222 です。
$ ssh -p 2222 maglev@<DNA Center の IP アドレス>
- プロンプトから、'magctl appstack status' コマンドを実行し、結果の出力をコピーして任意のテキストファイルに保存します。
$ magctl appstack status
または、以下のコマンドでテキストファイルに直接保存して出力されたファイル名とフルパスを控えておきます。
$ magctl appstack status > magctl_appstack_status_`date +%Y-%m-%d_%H-%M-%S_%Z`.log
$ ls -ld $PWD/magctl_appstack_status*
-rw-rw-r-- 1 maglev maglev 20059 Jan 16 05:00 /home/maglev/magctl_appstack_status_2020-01-16_05-00-37_UTC.log
ファイルのコピー
DNA Center から SCP によるファイル転送が可能な環境がある場合
以下の SCP コマンドで rca ファイルのコピーを行います。リモートサーバーのユーザー名およびパスワードが必要です。
$ scp /data/rca/maglev-<DNA Center の IP アドレス>-rca-<YYYY-MM-DD_hh-mm-ss>_UTC.tar.gz <コピー先サーバの username>@<コピー先サーバのアドレス>:<コピー先サーバのパス>
'magctl appstack status' の結果をファイル出力した場合、以下の SCP コマンドでファイルのコピーを行います。
$ scp /home/maglev/magctl_appstack_status_<YYYY-MM-DD_hh-mm-ss>_UTC.log <コピー先サーバの username>@<コピー先サーバのアドレス>:<コピー先サーバのパス>
受け取り側の端末から操作する場合
'maglev' ユーザーを指定して以下の SCP コマンドを利用するか、WinSCP などのクライアントソフトウェアを利用して DNA Center からファイルのダウンロードを行えます。この場合のポート番号は 22 ではなく、2222 を利用することに注意します。'maglev' ユーザーのパスワードが必要です。
$ scp -P 2222 maglev@<DNA Center の IP アドレス>:/data/rca/maglev-<DNA Center の IP アドレス>-rca-<YYYY-MM-DD_hh-mm-ss>_UTC.tar.gz .
'magctl appstack status' の結果をファイル出力した場合、以下の SCP コマンドでファイルのコピーを行います。
$ scp -P 2222 maglev@<DNA Center の IP アドレス>:/home/maglev/magctl_appstack_status_<YYYY-MM-DD_hh-mm-ss>_UTC.log .
DNA Center から SCM へ直接アップロードする場合
DNAC: DNA Center から SCM へのログ直接アップロード方法 の記事を参考に資料を直接 SCM へアップロードします。
ファイルの削除
ファイル転送が完了したら、必要に応じて DNA Center 上の rca ファイル/出力ファイルをターミナル('rm'コマンド)もしくは SFTP クライアントから削除します。
$ sudo rm /data/rca/maglev-<DNA Center の IP アドレス>-rca-<YYYY-MM-DD_hh-mm-ss>_UTC.tar.gz
[sudo] password for maglev: <maglev ユーザーのパスワードを入力>
$ rm /home/maglev/magctl_appstack_status_<YYYY-MM-DD_hh-mm-ss>_UTC.log
rca ファイルは容量が大きいため、生成したファイルをそのままにするような運用を続けると、ディスク容量を逼迫させることがあります。正常にファイルを引き上げたら消しておくことを推奨します。
参考資料
