用語に関する注意事項

言葉の名前、タイプ、種類、指標、リソースは、Cloud Monitoring に関連するさまざまな組み合わせやコンテキストに表示され、使用量が一貫しているとは限りません。たとえば、次のような一般的なパターンがあります。

  • 指標という用語は、異なるコンテキストで次のいずれかを指すのに使われることがあります。

    • 測定される一般的な「何か」
    • 指標タイプ
    • 時系列
    • 指標タイプに関連付けられた時系列のセット
    • TimeSeries 構造に埋め込まれる Metric 構造
  • storage.googleapis.com/api/request_count のような文字列は、次のいずれかとして呼ばれることがあります。

    • 指標
    • 指標名
    • 指標タイプ
    • 指標タイプ名
  • gcs_bucket のような文字列は、次のいずれかとして呼ばれることがあります。

    • リソース名 1
    • モニタリング対象リソース
    • モニタリング対象リソースタイプ
    • モニタリング対象リソース名

1 REST API リファレンス マテリアルでは、リソース名という用語が頻繁に使用されます。これは、通常はモニタリング対象リソースとは関係ありません。この用語について詳しくは、リソース名をご覧ください。

このセクションでは、混乱しやすい用語のいくつかについて説明します。

タイプと名前

指標タイプとモニタリング対象リソースの記述子には、名前とタイプの両方があります。この 2 つの用語を互いに置き換え可能なものとして簡易に使用することは一般的に行われています。

たとえば、文字列 storage.googleapis.com/api/request_count指標タイプですが、名前またはタイプ名と呼ぶこともあります。

この指標タイプの記述子を見ると、次の 2 つの Key-Value ペア(nametype)が表示されています。

{
  "name": "projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count",
  ...
  "type": "storage.googleapis.com/api/request_count",
}

指標記述子の type は、データを生成するサービス(たとえば storage.googleapis.com)と測定対象(api/request_count)に関する情報をエンコードする文字列です。

指標記述子では、name の値は指標タイプの完全修飾版です。name 値は、次の文字列で始まる type 値です。

projects/[PROJECT_ID]/metricDescriptors/

モニタリング対象リソースにも同様のパターンが保持されます。type はなんらかの種類のリソースのラベルで、name は次の文字列で始まる type 値で構成されます。

projects/[PROJECT_ID]/monitoredResourceDescriptors/

次の例は、モニタリング対象リソースのリストapi エントリに対応しています。

{
  "type": "api",
  ...
  "name": "projects/[PROJECT_ID]/monitoredResourceDescriptors/api"
}

プロジェクト内の name の値は type の値から完全に予測できますが、まったく同じものではありません。ただし、これらの用語は普段の議論ではしばしば不正確に使用されます。

指標の種類と値の型

「指標タイプ」と混同されやすい用語が他に 2 つあります。

  • 値の型
  • 指標の種類

これらの用語は「指標タイプ」を代替する用語ではありません。

「値の型」と「指標の種類」は、収集されたデータを表します。これらは両方ともプログラミングの概念の「データ型」に関連しています。

  • 値の型は、個々の値を表します。
  • 指標の種類は、値の相互関係を表します。

詳しくは、指標の種類とタイプをご覧ください。

リソース名

文字列を type(または他の)値の前に付けることで name 値を作成するパターンは、指標タイプとモニタリング対象リソースタイプをはるかに超えて拡大します。一意に識別可能なデータを作成するほぼすべてのものとともに出てきます。たとえば、MetricDescriptorAlertPolicy は両方ともこのパターンに従います。

name フィールドの値は、しばしばリファレンス ドキュメントで「リソース名」として説明されています。

API リファレンスの「リソース名」

リソース名を持つ構造とそれを得る方法の例を以下に示します。

  • 指標記述子: 接頭辞と type フィールドの値を結合します。
    • 接頭辞: projects/[PROJECT_ID]/metricDescriptors
    • type(サンプル): storage.googleapis.com/api/request_count
    • name: projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
  • モニタリング対象リソース記述子: 接頭辞と type フィールドの値を結合します。
    • 接頭辞: projects/[PROJECT_ID]/monitoredResourceDescriptors
    • type(サンプル): api
    • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
  • アラート ポリシー: 接頭辞と生成された ID の値を結合します
    • 接頭辞: projects/[PROJECT_ID]/alertPolicies
    • アラート ポリシー ID: ポリシーを作成したときに生成された番号
    • name: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

「リソース名」という用語は、サービスの API の階層内に存在するリソースを表し、モニタリング対象リソースのコンセプトとはまったく関係しません。API の設計におけるリソース名の詳細については、リソース名をご覧ください。