このドキュメントでは、合成モニターの実行履歴の調査方法と、収集された指標とログの表示方法について説明します。
準備
Google Cloud コンソールを使用して合成モニターの実行結果を表示するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールの付与を管理者に依頼してください。
-
モニタリング閲覧者(
roles/monitoring.viewer
) -
Cloud Functions デベロッパー(
roles/cloudfunctions.developer
) -
ログビューア(
roles/logging.viewer
)
ロールの付与の詳細については、アクセスを管理するをご覧ください。
必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
合成モニターの実行履歴を表示する
実行の成否の履歴を確認するには、合成モニターの [合成モニターの詳細] ページをご覧ください。
-
Google Cloud コンソールの [ナビゲーション] パネルで [Monitoring] を選択し、 [合成モニタリング] を選択します。
- [合成モニターの詳細] ページを開くには、表示する合成モニターを見つけて、その名前をクリックします。
[合成モニターの詳細] ページに、成功率と期間や最新のステータスなどの概要情報が表示されます。また、このページでは、実行の記録された期間をグラフ化し、実行ごとに 1 行を表示するテーブルも示します。
テーブルの各行には、ステータス、日付、期間が表示され、現在のコードとその実行に関連するログを表示するページにリンクされます。
実行のログとトレースを表示する
実行のログ、トレース、概要情報を表示するには、[合成モニターの詳細] ページで、実行へのリンクをクリックします。このページでは、次のことができます。
- ログデータを表示する。
- トレースデータを表示する。
現在のコードを表示します。
Cloud Functions にアクセスします。
Mocha テストでは、各テストの結果が表示されます。たとえば、合成モニターに 4 つの Mocha テストが含まれている場合、[テスト結果] ペインには 4 つのエントリが表示されます。 リスト内の各エントリには、成功または失敗のアノテーションが付けられます。
「失敗」とマークされたエントリを選択すると、失敗したコードが表示され、ハイライト表示されます。
ログデータを表示
ログは Cloud Monitoring によって自動的に収集されます。これらのログには、テストと失敗の詳細に関する情報が含まれます。使用可能なログは、Cloud Functions によって異なります。たとえば、Mocha を使用する場合、ログには、テストの成否の情報と、テスト期間に関する情報が含まれます。テストが失敗した場合は、完全なスタック トレースの情報も含まれます。スタック トレースには、失敗したコード行、エラータイプ、エラー メッセージが含まれます。
関連ログの詳細を表示するには、[実行ログ] ペインでログエントリを展開します。
ログエントリは JSON 形式で表示されます。ログ エクスプローラでログを表示する場合は、[ログ エクスプローラで開く] をクリックします。ログ エクスプローラが開き、クエリが事前構成されます。
トレースデータを表示する
トレースデータは、Cloud Functions の実行時に自動的に収集されます。次のスクリーンショットは、汎用テンプレートの使用時にトレースでキャプチャされるデータの種類を示しています。
前のスクリーンショットでは、ガントチャートの最初の行に Cloud Monitoring が開始した HTTP リクエストが表示されています。トレースデータは、Winston ロガーに渡されたテキストと、axios get
呼び出しによって発行された送信 HTTP リクエストを表示します。
トレース フライアウトで [Trace で表示] をクリックすると、Cloud Trace エクスプローラを使用してトレースデータを表示できます。トレースがすでに展開されて詳細が表示されています。トレースまたはスパンに円が表示されたら、円をクリックしてログエントリを表示できます。Cloud Function は resource.labels.service_name
フィールドを表示することで確認できます。
コンソール
トレースデータを表示するには、次のいずれかを行います。
トレースの概要情報を表示するには、実行の詳細ページのツールバーで、[トレースの詳細表示] をクリックします。
レイテンシ データの概要を表示するフライアウトが開きます。トレースとそのスパンの詳細については、Cloud Trace でデータを確認してください。Cloud Trace を開くには、[Trace で表示] をクリックします。
Cloud Trace でトレースを表示します。
-
Google Cloud コンソールで、[Trace エクスプローラ] ページに移動します。
このページは、検索バーを使用しても確認できます。
- 散布図または表でトレースを選択します。
- スパンに関連付けられたログやイベントごとに、スパンには円でアノテーションが付けられます。イベントやログの詳細を取得するには、円を選択します。
-
トレースデータの探索の詳細については、トレースを検索して調査するをご覧ください。
API
Google Cloud コンソールを使用してトレースデータを表示することをおすすめします。ただし、Cloud Trace API を使用する場合は、traces.list
メソッドを使用して使用可能なトレースを一覧表示し、traces.get
メソッドを使用してトレースの詳細を取得します。
Cloud Functions のログと指標を表示する
ログと指標には、Cloud Function が実行しているアクションに関する情報が表示されます。たとえば、値が GoogleStackdriverMonitoring-UptimeChecks
の userAgent
という名前のフィールドを含むログは、サービスが稼働時間チェック サービスからリクエストを受け取ったことを示します。
このセクションの残りの部分では、Cloud Functions によって収集されたログと指標を表示する方法について説明します。
関数のログを表示する
コンソール
Cloud Functions の関数のログを表示するには、次のようにします。
- 合成モニターの名前を含むペインで、Cloud Functions の関数名をクリックします。
- [関数の詳細] ページで、[ログ] タブを選択します。
グラフ内のログデータを詳細に調べるには、ログエントリを展開して、[ログ エクスプローラで開く] を選択します。ログ エクスプローラで、クエリの絞り込み、ログベースの指標の作成、またはログベースのアラートの作成などのアクションを実行します。
API
Cloud Functions の関数のログをプログラムで読み書きする方法については、ログの作成、表示、処理をご覧ください。
関数の指標を表示する
合成モニターの場合、Cloud Monitoring と Cloud Functions の両方で指標が収集されます。
Cloud Monitoring は、合成モニターの各実行に関する指標を収集します。これらの指標には、コード実行のレイテンシと成功履歴が含まれます。これらの指標の表示方法については、合成モニターの実行履歴を表示するをご覧ください。
Cloud Functions は、各 Cloud Functions の関数に関する指標を収集します。これらの指標には、実行時間、メモリ使用率、インスタンス数、セクションごとの呼び出し数が記録されます。このセクションの残りの部分では、これらの指標を表示する方法について説明します。
コンソール
Cloud Functions の関数の指標を表示するには、次のようにします。
- 合成モニターの名前を含むペインで、Cloud Functions の関数名をクリックします。
- [関数の詳細] ページで、[指標] タブを選択します。
特定の期間を拡大するには、次のようにします。
- グラフ上で、期間の一方の終端にポインタを置き、ポインタを左クリックします。
- 期間のもう一方の終端までポインタを水平方向にドラッグし、その後、ポインタボタンを放します。
グラフに表示されるデータを詳細に調べるには、グラフ ツールバーで more_vert [その他のグラフ オプション] を選択します。次のような操作を行うことができます。
- PNG または CSV としてグラフをダウンロードする
- グラフをカスタム ダッシュボードに保存する
- Metrics Explorer を開く
- グラフの凡例を開くか閉じる
- ズームをリセットする
API
Cloud Functions の関数の指標をプログラムで読み取る方法については、モニタリング指標の表示をご覧ください。