OpenShiftログの効果的な表示方法&テクニック
0.はじめに
OpenShift Container Platform(以下、OCP)入門者向けに、ログを効果的に表示する方法を解説します。
OpenShiftでログを効果的に表示する方法とは、アプリケーションやクラスターリソースの動作状況やエラーのトラブルシューティングに役立つ情報をすばやく取得することを指します。
具体例とともにCLIコマンドおよびWebコンソールでのログ確認方法を紹介していきます。
- ビルド構成の最新ログを表示
- デプロイメントの最新ログを表示
- 特定バージョンのデプロイメントまたはビルド構成のログを表示
- 特定Podの最新ログを表示
- ログの最後の数行だけを表示
- 特定ノードのログを表示
- Podの詳細情報を確認(describe)
では、次の章から具体的な解説を進めます!
1. ビルド構成の最新ログを表示
CLIでのログ表示
ビルド構成(BuildConfig)の最新のビルドログをリアルタイムで表示します。ビルドエラーや進行状況の確認に役立ちます。
oc logs -f bc/<build-config-name>
Webコンソールでのログ表示
- Webコンソールにログインし、左メニューの「ビルド」→「ビルド構成」を選択。
- 該当のビルド構成をクリックし、「ビルドログ」タブで最新のビルドログが表示されます。
2. デプロイメントの最新ログを表示
CLIでのログ表示
特定のデプロイメントのログをリアルタイムで取得します。デプロイメントに関連するPodの状態を確認するのに役立ちます。
oc logs -f deployment/<deployment-name>
Webコンソールでのログ表示
- Webコンソールで「ワークロード」→「デプロイメント」を選択。
- 該当のデプロイメント名をクリックし、「ログ」タブで最新のデプロイメントログを確認します。
3. 特定バージョンのデプロイメントまたはビルド構成のログを表示
CLIでのログ表示
特定のバージョンに基づくデプロイメントやビルド構成のログを取得する場合は、-version
オプションを使います。
デプロイメントの特定バージョンのログ:
oc logs -f deployment/<deployment-name> -version=<version-number>
ビルド構成の特定バージョンのログ:
oc logs -f bc/<build-config-name> -version=<version-number>
Webコンソールでのログ表示
- Webコンソールの「ワークロード」→「デプロイメント」または「ビルド構成」から該当リソースを選択。
- バージョン情報がある場合、過去のビルドやデプロイメントのログを確認できるメニューが表示されます。
4. 特定Podの最新ログを表示
CLIでのログ表示
特定のPodのログをリアルタイムで確認します。-f
オプションでログがストリーミングされ、コンテナの実行中のアクティビティを追跡できます。
oc logs -f pod/<pod-name>
Webコンソールでのログ表示
- Webコンソールで「ワークロード」→「Pod」を選択。
- 該当のPodをクリックし、「ログ」タブでリアルタイムログを確認できます。
5. ログの最後の数行だけを表示
リアルタイムのログ全体ではなく、特定の行数のみ取得したい場合、--tail
オプションを使用します。
oc logs -f pod/<pod-name> --tail=10
6. 特定ノードのログを表示
CLIでのノードログ表示
特定ノード、または特定の役割を持つノードのログを確認します。管理者がノードのトラブルシューティングに利用する方法です。
特定ノードのログ:
oc adm node-logs <node-name>
マスターやワーカーロールを持つノードのログ:
oc adm node-logs --role master
oc adm node-logs --role worker
特定のユニット(例えばkubelet)に関するログ:
oc adm node-logs --role master -u kubelet
Webコンソールでのノードログ表示
- Webコンソールの「コンピュート」→「ノード」を選択。
- 各ノードの詳細情報ページで、関連するイベントやリソース使用状況を確認します。ログのダイレクトな確認機能はありませんが、イベント情報が参考になります。
7. Podの詳細情報を確認(describe)
特定のPodに関する詳細なイベントログや状態、環境変数などを確認する場合、oc describe
コマンドを使います。
CLIでの詳細情報確認
oc describe pod <podname>
Webコンソールでの詳細情報確認
- Webコンソールで「ワークロード」→「Pod」を選択。
- 該当のPodをクリックし、「詳細」タブで、環境変数やステータス、イベント情報が確認できます。
8.おわりに
今回はOpenShiftのログを効果的に表示する方法について理解を深めるために、以下を学びました。
-
リアルタイム監視:
-f
オプションでストリーミング表示し、動作中のアクティビティやエラーをリアルタイムで確認。 -
特定範囲の絞り込み:
--tail
オプションで、必要な行数だけを取得して効率的に確認。 - コンポーネント単位の確認: デプロイメント、ビルド構成、Pod、ノードなどの各コンポーネントごとにログを分けて確認し、トラブルシューティングを迅速化。
これら効果的なログ表示と分析のポイントを抑えることによって、トラブルシューティングに役立つ情報をすばやく取得することができます。
1回で覚えるのは難しいと思うので、何度かトライして覚えるで全然大丈夫です。
今後もOpenShiftについて解説していきます。
おわりっ!
Discussion