このガイドでは、カスタム指標を作成して使用する方法について説明します。情報は次のセクションに分かれています。
OpenCensus によるカスタム指標: オープンソースのモニタリングとトレースのライブラリである OpenCensus を使用して、カスタム指標を作成し、それらに指標データを追加し、Cloud Monitoring にエクスポートする方法について説明します。
OpenCensus から Cloud Monitoring に指標がエクスポートされると、Monitoring ではそれらを他のカスタム指標と同様に扱います。
カスタム指標の作成: Cloud Monitoring API を使用してカスタム指標を作成し、それらに時系列データを追加する方法について説明します。
Monitoring API については、API Explorer と C#、Go、Java、Node.js、PHP、Python、Ruby の各プログラミング言語を使用した例が示されています。
以下の情報は、カスタム指標と、Cloud Monitoring によって提供される指標の両方に適用されます。
- 指標の閲覧: カスタム指標と 900 以上の組み込み指標を一覧表示し、それらの指標を調べる方法について説明します。
- 指標の読み取り: Monitoring API を使用してカスタム指標や組み込み指標から時系列データを取得する方法について説明します。グラフやアラートで指標データを使用することもできます。
指標に対するこうした操作のすべてには Cloud Monitoring API v3 が必要です。 リファレンス ドキュメントとしては、Cloud Monitoring API の概要をご覧ください。
Cloud Monitoring の基礎となる指標のコンセプトについての説明は、指標、時系列、リソースをご覧ください。
始める前に
カスタム指標は、ワークスペースのメンバーである Google Cloud プロジェクトに属します。組み込み指標を閲覧するだけの場合でも、作業用のプロジェクトが必要です。
- アクセスしたいモニタリング データがある Google Cloud Console プロジェクトを作成または選択します。このガイドでは、プロジェクトの ID は、
{your-project-id}と表記しています。 - Monitoring 用のプロジェクトを有効にします。
Google Cloud プロジェクトのログに基づいて指標を設定する場合は、ログベースの指標を使用します。
カスタム指標の概要
カスタム指標は Monitoring の組み込み指標とほぼ同じですが、次の点が異なります。
- カスタム指標は Google Cloud プロジェクト内に作成できます。
- 通常、カスタム指標名は
custom.googleapis.com/で始まります。これは組み込み指標とは異なります。 - カスタム指標に時系列データを書き込むことができます。
- カスタム指標を削除できます。
組み込み指標の詳細については、指標の一覧をご覧ください。
次の表は、Monitoring API のどのメソッドがカスタム指標と組み込み指標で使用できるかを示しています。
| Monitoring API の API メソッド | カスタム指標 で使用 |
組み込み指標 で使用 |
|---|---|---|
| monitoredResourceDescriptors.get | ○ | ○ |
| monitoredResourceDescriptors.list | ○ | ○ |
| metricDescriptors.get | ○ | ○ |
| metricDescriptors.list | ○ | ○ |
| timeSeries.list | ○ | ○ |
| timeSeries.create | ○ | |
| metricDescriptors.create | ○ | |
| metricDescriptors.delete | ○ |
制限とレイテンシ
カスタム指標とデータ保持について詳しくは、割り当てと上限をご覧ください。保存期間を超えて指標データを保持する場合は、Cloud Storage や BigQuery のような別の場所にデータを手動でコピーする必要があります。
カスタム指標へのデータの書き込みに伴うレイテンシについて詳しくは、指標データのレイテンシをご覧ください。