モニタリングおよびロギング
Red Hat Developer Hub の監視およびロギングツールでパフォーマンスを追跡し、詳細情報を収集する
概要
第1章 ログレベル リンクのコピーリンクがクリップボードにコピーされました!
ロギングは、ソフトウェアアプリケーションのモニタリングとデバッグに不可欠な要素です。実行時にアプリケーションがどのように機能しているかを把握し、問題の検出と診断に役立ちます。ログレベルを調整することで、非常に詳細な診断出力から最も重大なエラーに至るまで、ログに表示される情報の量と種類を制御できます。この柔軟性により、開発、テスト、実稼働環境のいずれの場合でも、現在の要件に合わせてログ出力をカスタマイズできます。
詳細度の降順でリストされている次のログレベルから選択できます。
-
debug: 詳細情報。通常はトラブルシューティング時にのみ役立ちます。 -
info: アプリケーションの操作に関する一般情報。これはデフォルトのレベルです。 -
warn: 注意が必要となる可能性のある潜在的な問題または状況を示します。 -
error: エラーが発生したが、アプリケーションの続行を妨げない可能性があることを示します。 -
critical: すぐに対処する必要があり、アプリケーションが正しく機能しなくなる可能性のある重大なエラーを示します。
ログレベルを設定することで、ロギングの詳細度を制御できます。ログレベルは、コンソールに表示されるイベントの最小重大度レベルを決定します。たとえば、ログレベルが 'info' に設定されている場合、重大度レベルが 'debug' のイベントは無視されます。
ログレベルを上げるには、LOG_LEVEL 環境変数を 'warn' または 'error' などのより高い重大度レベルに設定します。ただし、既存のコードが主に 'debug' や 'info' などの低い重大度レベルでログを出力している場合、ログレベルを上げても出力は増えない可能性があります。このような場合は、コード内のロギングステートメントを調整して、より高い重大度レベルを使用し、より多くの出力を表示します。
LOG_LEVEL 環境変数を設定する以外に追加の手順は必要ありませんが、その有効性はコード内の既存のロギングステートメントによって異なります。
第2章 OpenShift Container Platform 上の Red Hat Developer Hub に対する可観測性の有効化 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform では、メトリクスは /metrics の正規名の下に HTTP サービスエンドポイント経由で公開されます。ServiceMonitor カスタムリソース (CR) を作成して、ユーザー定義プロジェクトのサービスエンドポイントからメトリクスをスクレイピングできます。
2.1. Red Hat Developer Hub Operator で OpenShift Container Platform クラスターにインストールした場合にメトリクスモニタリングを有効にする リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform Web コンソールの Developer パースペクティブから、Operator によってインストールした Red Hat Developer Hub インスタンスのメトリクスを有効にして表示できます。
前提条件
- OpenShift Container Platform クラスターで、ユーザー定義プロジェクトの監視 が有効になっている。
- Red Hat Developer Hub Operator を使用して、OpenShift Container Platform に Red Hat Developer Hub をインストールしている。
-
OpenShift CLI (
oc) がインストールされている。
手順
現在、Red Hat Developer Hub Operator は、デフォルトで ServiceMonitor カスタムリソース (CR) の作成をサポートしていません。エンドポイントからメトリクスをスクレイピングするための ServiceMonitor CR を作成するには、次の手順を完了する必要があります。
ServiceMonitorCR を YAML ファイルとして作成します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
ServiceMonitorリソースの名前 (例:developer_hub_service_monitor)。- 2
ServiceMonitorが存在する namespace (例:my-rhdh-project)。- 3
ServiceMonitorCR インスタンスを識別するラベル名 (例:my-rhdh-custom-resource)。- 4
- RHDH インスタンスがインストールされている namespace (例:
my-rhdh-project)。 - 5
- RHDH デプロイメントの名前 (例:
developer-hub)。 - 6
- RHDH アプリケーションの名前 (例:
backstage)。
注記spec.selector.matchLabels設定は、RHDH インストールのラベルと一致する必要があります。次のコマンドを実行して、
ServiceMonitorCR を適用します。oc apply -f <filename>
oc apply -f <filename>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
検証
- OpenShift Container Platform Web コンソールの Developer パースペクティブから、Observe ビューを選択します。
- Metrics タブをクリックして、Red Hat Developer Hub Pod のメトリクスを表示します。
-
OpenShift Container Platform Web コンソールの Developer パースペクティブで、Project > Services をクリックし、
backstage-developer-hubのラベルを確認します。
2.2. Helm チャートで OpenShift Container Platform クラスターにインストールした場合にメトリクスモニタリングを有効にする リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform Web コンソールの Developer パースペクティブから、Red Hat Developer Hub Helm デプロイメントのメトリクスを有効にして表示できます。
前提条件
- OpenShift Container Platform クラスターで、ユーザー定義プロジェクトの監視 が有効になっている。
- Helm チャートを使用して、OpenShift Container Platform に Red Hat Developer Hub をインストールしている。
手順
- OpenShift Container Platform Web コンソールの Developer パースペクティブから、Topology ビューを選択します。
Red Hat Developer Hub Helm チャートのオーバーフローメニューをクリックし、Upgrade を選択します。
Upgrade Helm Release ページで、Configure via の YAML view オプションを選択し、次の例に示すように、YAML で
metricsセクションを設定します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Upgrade をクリックします。
検証
- OpenShift Container Platform Web コンソールの Developer パースペクティブから、Observe ビューを選択します。
- Metrics タブをクリックして、Red Hat Developer Hub Pod のメトリクスを表示します。
第3章 Amazon Web Services (AWS) 上の Red Hat Developer Hub のモニタリングとロギング リンクのコピーリンクがクリップボードにコピーされました!
リアルタイムモニタリングには Amazon CloudWatch を使用し、包括的なロギングには Amazon Prometheus を使用するように Red Hat Developer Hub を設定できます。これは、Amazon Web Services (AWS) インフラストラクチャーで Developer Hub をホストする場合に便利です。
3.1. Amazon Prometheus によるモニタリング リンクのコピーリンクがクリップボードにコピーされました!
包括的なロギングのために Amazon Prometheus を使用するように Red Hat Developer Hub を設定できます。Amazon Prometheus は、特定の Pod アノテーションを持つ Pod からデータを抽出します。
3.1.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- Elastic Kubernetes Service (EKS) クラスター用に Prometheus を設定した。
- Prometheus ワークスペース用の Amazon マネージドサービスを作成した。
- Developer Hub メトリクスをインポートするように Prometheus を設定した。
- 作成されたワークスペースに Prometheus メトリクスを取り込んだ。
3.1.2. Red Hat Developer Hub Operator を使用して Amazon Prometheus でモニタリングするアノテーションの設定 リンクのコピーリンクがクリップボードにコピーされました!
Amazon Prometheus へのロギングを有効にするには、Red Hat Developer Hub Operator を使用して必要な Pod アノテーションを設定できます。
手順
Red Hat Developer Hub Operator の管理者として、次のようにデフォルト設定を編集して Prometheus アノテーションを追加します。
# Update OPERATOR_NS accordingly OPERATOR_NS=rhdh-operator kubectl edit configmap backstage-default-config -n "${OPERATOR_NS}"# Update OPERATOR_NS accordingly $ OPERATOR_NS=rhdh-operator $ kubectl edit configmap backstage-default-config -n "${OPERATOR_NS}"Copy to Clipboard Copied! Toggle word wrap Toggle overflow config map で
deployment.yamlキーを見つけて、次のようにspec.template.metadata.annotationsフィールドにアノテーションを追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 変更を保存します。
検証
スクレイピングが機能するかどうかを確認するには、以下の手順を実行します。
次のように、
kubectlを使用して Prometheus コンソールをローカルマシンにポート転送します。kubectl --namespace=prometheus port-forward deploy/prometheus-server 9090
$ kubectl --namespace=prometheus port-forward deploy/prometheus-server 9090Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Web ブラウザーを開いて
http://localhost:9090に移動し、Prometheus コンソールにアクセスします。 -
process_cpu_user_seconds_totalなどの関連メトリクスを監視します。
3.1.3. Red Hat Developer Hub Helm チャートを使用して Amazon Prometheus でモニタリングするアノテーションの設定 リンクのコピーリンクがクリップボードにコピーされました!
Amazon Prometheus へのロギングを有効にするには、Red Hat Developer Hub Helm チャートを使用して必要な Pod アノテーションを設定できます。
手順
backstage Pod にモニタリング用のアノテーションを付けるには、
values.yamlファイルを次のように更新します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
検証
スクレイピングが機能するかどうかを確認するには、以下の手順を実行します。
次のように、
kubectlを使用して Prometheus コンソールをローカルマシンにポート転送します。kubectl --namespace=prometheus port-forward deploy/prometheus-server 9090
kubectl --namespace=prometheus port-forward deploy/prometheus-server 9090Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Web ブラウザーを開いて
http://localhost:9090に移動し、Prometheus コンソールにアクセスします。 -
process_cpu_user_seconds_totalなどの関連メトリクスを監視します。
3.2. Amazon CloudWatch によるロギング リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub 内のロギングは、Winston ライブラリー に依存します。
3.2.1. Red Hat Developer Hub Operator を使用したアプリケーションログレベルの設定 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub Operator を使用して、アプリケーションログレベルを設定できます。
手順
次のように、カスタムリソースに環境変数
LOG_LEVELを含めて、ログレベルを変更します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.2.2. Red Hat Developer Hub Helm チャートを使用したアプリケーションログレベルの設定 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub Helm チャートを使用して、アプリケーションログレベルを設定できます。
手順
環境変数
LOG_LEVELを Helm チャートvalues.yamlファイルに追加して、ログレベルを変更します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.2.3. Amazon CloudWatch からのログの取得 リンクのコピーリンクがクリップボードにコピーされました!
前提条件
- CloudWatch Container Insights は、Amazon Elastic Kubernetes Service のログとメトリクスをキャプチャーするのに使用されます。詳細は、Logging for Amazon Elastic Kubernetes Service のドキュメントを参照してください。
- ログとメトリクスをキャプチャーするには、Amazon CloudWatch Observability EKS アドオンをクラスターにインストールします。Container Insights のセットアップ後、Logs Insights または Live Tail ビューを使用してコンテナーログにアクセスできます。
CloudWatch は、すべてのコンテナーログが統合されるロググループに、次のように名前を付けます。
/aws/containerinsights/<cluster_name>/application
/aws/containerinsights/<cluster_name>/applicationCopy to Clipboard Copied! Toggle word wrap Toggle overflow
手順
Developer Hub インスタンスからログを取得するには、次のようなクエリーを実行します。
fields @timestamp, @message, kubernetes.container_name | filter kubernetes.container_name in ["install-dynamic-plugins", "backstage-backend"]
fields @timestamp, @message, kubernetes.container_name | filter kubernetes.container_name in ["install-dynamic-plugins", "backstage-backend"]Copy to Clipboard Copied! Toggle word wrap Toggle overflow
第4章 Red Hat Developer Hub における Azure Kubernetes Services (AKS) を使用したモニタリングおよびロギング リンクのコピーリンクがクリップボードにコピーされました!
モニタリングおよびロギングは、Red Hat Developer Hub での Azure Kubernetes Services (AKS) の管理および保守に不可欠な要素です。Managed Prometheus Monitoring や Azure Monitor 統合などの機能により、管理者はリソース使用率を効率的に監視し、問題を診断し、コンテナー化されたワークロードの信頼性を確保できます。
4.1. Azure Monitor メトリクスの有効化 リンクのコピーリンクがクリップボードにコピーされました!
マネージド Prometheus モニタリングを有効にするには、次のように、新しいクラスターの作成か既存のクラスターの更新かに応じて、az aks create または az aks update コマンドで -enable-azure-monitor-metrics オプションを使用します。
az aks create/update --resource-group <your-ResourceGroup> --name <your-Cluster> --enable-azure-monitor-metrics
az aks create/update --resource-group <your-ResourceGroup> --name <your-Cluster> --enable-azure-monitor-metrics
上記のコマンドは、Prometheus メトリクス を収集するメトリクスアドオンをインストールします。前のコマンドを使用すると、ネイティブの Azure Monitor メトリクスの両方を通じて Azure リソースのモニタリングを有効にできます。ポータルの Monitoring → Insights で結果を表示することもできます。詳細は、Monitor Azure resources with Azure Monitor を参照してください。
さらに、Managed Prometheus サービスと Azure Monitor の両方のメトリクスには、Azure Managed Grafana サービスからアクセスできます。詳細は、Link a Grafana workspace セクションを参照してください。
デフォルトでは、Prometheus は最小取り込みプロファイルを使用します。これにより、取り込み量が最適化され、スクレイピング頻度、ターゲット、および収集するメトリクスのデフォルト設定が指定されます。デフォルト設定は、カスタム設定を使用してカスタマイズできます。Azure では、スクレイピング設定やその他のメトリクスアドオン設定を提供するために、さまざまな ConfigMap の使用を含むさまざまな方法が提供されています。デフォルトの設定の詳細は、Default Prometheus metrics configuration in Azure Monitor および Customize scraping of Prometheus metrics in Azure Monitor managed service for Prometheus ドキュメントを参照してください。
4.2. モニタリング用のアノテーションの設定 リンクのコピーリンクがクリップボードにコピーされました!
Helm デプロイメントと Operator ベースのデプロイメントの両方で、Red Hat Developer Hub 固有のメトリクスを監視するためのアノテーションを設定できます。
- Helm のデプロイメント
backstage Pod にモニタリング用のアノテーションを付けるには、
values.yamlファイルを次のように更新します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Operator ベースのデプロイメント
手順
Operator の管理者として、デフォルト設定を編集して、次のように Prometheus アノテーションを追加します。
# Update OPERATOR_NS accordingly OPERATOR_NS=rhdh-operator kubectl edit configmap backstage-default-config -n "${OPERATOR_NS}"# Update OPERATOR_NS accordingly OPERATOR_NS=rhdh-operator kubectl edit configmap backstage-default-config -n "${OPERATOR_NS}"Copy to Clipboard Copied! Toggle word wrap Toggle overflow ConfigMap で
deployment.yamlキーを見つけて、次のようにアノテーションをspec.template.metadata.annotationsフィールドに追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 変更を保存します。
検証
スクレイピングが機能するかどうかを確認するには、対応する Azure Monitor Workspace に移動し、Monitoring → Metrics でメトリクスを表示します。
4.3. Azure Kubernetes Services (AKS) を使用したログの表示 リンクのコピーリンクがクリップボードにコピーされました!
Kubernetes オブジェクトによって生成されたライブデータログにアクセスし、AKS 内の Container Insights でログデータを収集できます。
前提条件
- Developer Hub が AKS にデプロイされている。
詳細は、Microsoft Azure Kubernetes Service への Red Hat Developer Hub のインストール を参照してください。
手順
- Developer Hub インスタンスからのライブログの表示
- Azure Portal に移動します。
-
リソースグループ
<your-ResourceGroup>を検索し、AKS クラスター<your-Cluster>を見つけます。 - メニューから Kubernetes resources → Workloads を選択します。
-
<your-rhdh-cr>-developer-hubデプロイメント (Helm チャートインストールの場合) または<your-rhdh-cr>-backstageデプロイメント (Operator ベースのインストールの場合) を選択します。 - 左側のメニューで Live Logs をクリックします。
Pod を選択します。
注記Pod は 1 つだけである必要があります。
ライブログデータが収集され、表示されます。
- Container Engine からのリアルタイムログデータの表示
- Azure Portal に移動します。
-
リソースグループ
<your-ResourceGroup>を検索し、AKS クラスター<your-Cluster>を見つけます。 - メニューから Monitoring → Insights を選択します。
- Containers タブに移動します。
- backend-backstage コンテナーを見つけてクリックすると、Container Engine によって生成されるリアルタイムログデータが表示されます。