このページでは、Monitoring API を使用して以下のことを行う方法について説明します。
- カスタム指標タイプの一覧または説明を取得する。
- カスタム指標の設計に役立つ、組み込みの指標タイプの一覧または説明を取得する。この一覧は、次のドキュメントでも紹介されています。詳しくは、指標の一覧をご覧ください。
- 使用可能なモニタリング対象リソースタイプの一覧または説明を取得する。これは、カスタム指標の時系列データのラベルを付けるのに使用できます。この一覧は、次のドキュメントでも紹介されています。詳しくは、モニタリング対象リソースタイプをご覧ください。
これらのコンセプトの概要については、指標、時系列、リソースをご覧ください。
このページでは、metricDescriptors.list
メソッドと get
メソッド、および monitoredResourceDescriptors.list
メソッドと get
メソッドについて説明します。これらのメソッドを使用するには、いくつかの方法があります。
コードを記述せずにこれらのメソッドを実行するには、このページの [プロトコル] タブにある例からフォームベースの API Explorer を使用します(このツールの詳細については、API Explorer をご覧ください)。
選択したプログラミング言語からこれらのメソッドを使用する方法については、このページの実行可能なコードサンプルをご覧ください。
BindPlane からの指標を参照する
BindPlane からの指標は、Metrics Explorer にあります。
すべての BindPlane 指標は generic_node
のリソースタイプとともに表示され、指標名には接頭辞 external.googleapis.com/bluemedora/generic_node/
が付けられます。
BindPlane で使用できるソースについては、BindPlane ソースのドキュメントをご覧ください。
ワークスペースは不要
カスタム指標を使用している場合を除き、プロジェクトがワークスペースにない場合でも、既存のプロジェクトを metricDescriptors.list
呼び出しと get
呼び出しで使用できます。カスタム指標を扱う場合は、カスタム指標が定義されているプロジェクトを指定する必要があります。
既存のプロジェクトを monitoredResourceDescriptors.list
メソッドと get
メソッドで使用することもできます。
指標記述子の一覧表示
指標記述子は組み込みおよびカスタムの指標を定義するスキーマです。使用可能な指標記述子を閲覧することで、興味のある指標の詳細を知ることができます。
現時点で 900 以上の組み込み指標があります。詳細なリストについては、指標の一覧をご覧ください。
指標タイプの命名方法について詳しくは、命名規則をご覧ください。
例: 指標タイプの一覧表示
現在の指標タイプの一覧を取得するには、metricDescriptors.list
メソッドを使用します。返された指標タイプのセットを絞り込むには、フィルタを使用します。どの指標タイプを検索すべきか判断できない場合は、値のタイプと指標の種類をご覧ください。
プロトコル
Compute Engine の指標を取得するための metricDescriptors.list
のサンプル パラメータを次に示します。
- 名前:
projects/[PROJECT_ID]
- フィルタ:
metric.type = starts_with("compute.googleapis.com")
- フィールド:
metricDescriptors.type,metricDescriptors.displayName
[Execute] ボタンをクリックする前に、[PROJECT_ID]
を有効な ID に変更してください。
次のサンプル出力は、フィルタに一致する多くの Compute Engine の指標のうち 3 つを示しています。
"metricDescriptors": [
{
"displayName": "Dropped bytes",
"type": "compute.googleapis.com/firewall/dropped_bytes_count"
},
{
"displayName": "Dropped packets",
"type": "compute.googleapis.com/firewall/dropped_packets_count"
},
{
"displayName": "Reserved cores.",
"type": "compute.googleapis.com/instance/cpu/reserved_cores"
},
...
]
この type
の値は、指標記述子(例: compute.googleapis.com/firewall/dropped_packets_count
)を識別します。この値は「指標タイプ」または「指標タイプ名」と呼ばれることもあります。
C#
Go
Java
Node.js
PHP
Python
Ruby
問題がある場合は、API 呼び出しのトラブルシューティングをご覧ください。
例: 指標記述子の取得
指標タイプの詳細を取得するには、metricDescriptors.get
メソッドを使用して完全な指標記述子を取得します。
特定の指標記述子を取得するには、その記述子の完全な名前が必要です。この値は次の 2 つの要素で構成されています。
projects/[PROJECT_ID]/metricDescriptors
で構成される接頭辞。- 指標記述子を識別する
type
値(例:compute.googleapis.com/firewall/dropped_packets_count
)。type
値の詳細については、例: 指標タイプの一覧表示にある [プロトコル] タブをご覧ください。
例: projects/[PROJECT_ID]/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
。
プロトコル
Compute Engine の /firewall/dropped_packets_count
指標の詳細情報を取得するには、metricDescriptors.get
に対して次のパラメータを使用します。
- 名前:
projects/[PROJECT_ID]/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
[Execute] ボタンをクリックする前に、[PROJECT_ID]
を有効な ID に変更してください。
次のサンプル レスポンスは、指標の記述子を示しています。
{
"type": "compute.googleapis.com/firewall/dropped_packets_count",
"name": "projects/[PROJECT_ID]/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count",
"description": "Delta count of incoming packets dropped by the firewall.",
"displayName": "Dropped packets",
"labels": [
{
"key": "instance_name",
"description": "The name of the VM instance."
}
],
"metricKind": "DELTA",
"valueType": "INT64",
"unit": "1"
}
C#
Go
Java
Node.js
PHP
Python
Ruby
問題がある場合は、API 呼び出しのトラブルシューティングをご覧ください。
モニタリング対象リソースの一覧表示
モニタリング対象リソースは、モニタリングできるクラウド エンティティです。既存のモニタリング対象リソースタイプを閲覧することで、指標を持つエンティティの種類を探すことができます。
現時点で約 100 種類のモニタリング対象リソース記述子があります。詳細なリストについては、モニタリング対象リソースの一覧をご覧ください。
指標記述子とモニタリング対象リソースの概要については、指標、時系列、リソースをご覧ください。
プロジェクトがワークスペースにない場合でも、既存のプロジェクトを monitoredResourceDescriptors.list
呼び出しと get
呼び出しで使用できます。
例: リソースタイプの一覧表示
Monitoring API からモニタリング対象リソースタイプの現在の一覧を取得するには、monitoredResourceDescriptors.list
メソッドを使用してプロジェクト ID を指定します。
プロトコル
モニタリング対象リソースタイプの現在の一覧を取得するには、次のサンプル パラメータを指定して monitoredResourceDescriptors.list
を使用します。
- 名前:
projects/[PROJECT_ID]
- フィールド:
resourceDescriptors.type
[Execute] ボタンをクリックする前に、[PROJECT_ID]
を有効な ID に変更してください。
次のサンプル レスポンスは、返されたモニタリング対象リソースタイプの例です。
{
"resourceDescriptors": [
{
"type": "api"
},
{
"type": "aws_cloudfront_distribution"
},
{
"type": "aws_dynamodb_table"
},
{
"type": "aws_ebs_volume"
},
...
}
C#
Go
Java
Node.js
PHP
Python
Ruby
問題がある場合は、API 呼び出しのトラブルシューティングをご覧ください。
リソース記述子の取得
モニタリング対象リソースタイプの詳細を取得するには、monitoredResourceDescriptors.get
メソッドを使用して、完全な記述子を取得します。
特定のモニタリング対象リソース記述子を取得するには、その記述子の完全な名前が必要です。この値は次の 2 つの要素で構成されています。
projects/[PROJECT_ID]/monitoredResourceDescriptors
で構成される接頭辞。- 指標記述子を識別する
type
値(例:gce_instance
)。type
値の詳細については、例: リソースタイプの一覧表示にある [プロトコル] タブをご覧ください。
例: projects/[PROJECT_ID]/monitoredResourceDescriptors/gce_instance
。
プロトコル
gce_instance
リソースタイプの詳細を取得するには、monitoredResourceDescriptors.get
メソッドに対して次のパラメータを使用します。
- 名前:
projects/[PROJECT_ID]/monitoredResourceDescriptors/gce_instance
[Execute] ボタンをクリックする前に、[PROJECT_ID]
を有効な ID に変更してください。
次のサンプル レスポンスは、このモニタリング対象リソースの記述子を示します。
{
"type": "gce_instance",
"displayName": "GCE VM Instance",
"description": "A virtual machine instance hosted in Google Compute Engine (GCE).",
"labels": [
{
"key": "project_id",
"description": "The identifier of the GCP project associated with this resource, such as \"my-project\"."
},
{
"key": "instance_id",
"description": "The numeric VM instance identifier assigned by Compute Engine."
},
{
"key": "zone",
"description": "The Compute Engine zone in which the VM is running."
}
],
"name": "projects/[PROJECT_ID]/monitoredResourceDescriptors/gce_instance"
}
C#
Go
Java
Node.js
PHP
Python
Ruby
問題がある場合は、API 呼び出しのトラブルシューティングをご覧ください。
リソースを検索する
モニタリング対象のリソース オブジェクトが時系列データに含まれています。通常、特定のタイプのモニタリング対象リソースが含まれる指標を推測できます。たとえば、gce_instance
モニタリング対象リソースを確認するには、compute.googleapils.com/instance/cpu/utilization
のような指標から時系列データを調べます。該当しそうな指標の時系列が特定されたら、指標データの読み取りをご覧ください。