指標の命名規則

このドキュメントでは、Cloud Monitoring が指標に適用する命名規則について説明します。

指標のリソース名

指標タイプのリソース名は、3 つの主要なサブ構造を持つ文字列で構成されます。

  • 特定のプロジェクトの識別子。
  • 文字列で指標記述子を表すマーカー（常に metricDescriptors に設定）。
  • 指標タイプ。

指標タイプのリソース名は次のパターンに従います。

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

サブ文字列 METRIC_TYPE は、指標タイプを表す識別子です。たとえば、次のようなさまざまな形式があります。

agent.googleapis.com/agent/api_request_count
compute.googleapis.com/firewall/dropped_bytes_count
istio.io/service/client/received_bytes_count
kubernetes.io/anthos/APIServiceOpenAPIAggregationControllerQueue1_adds

指標記述子では、name フィールドに指標タイプのリソース名が格納され、type フィールドに METRIC_TYPE サブ文字列が格納されます。

次のテーブルは、リソース名に含まれる METRIC_TYPE サブ文字列を解析する方法を示しています。

可能な構造 説明
SERVICE_NAME 1.googleapis.com/PATH 2 Google Cloud のプロダクトとサービスの指標。これらの指標の一覧については、Google Cloud の指標をご覧ください。
agent.googleapis.com/SERVICE_NAME 1/PATH 2 Google Cloud または AWS の VM インスタンスで実行されている Monitoring エージェントと Logging エージェントから取得した指標。これらの指標の全一覧については、Anthos の指標をご覧ください。
kubernetes.io/anthos/PATH 2 GKE Enterprise からの指標。GKE Enterprise は、オンプレミスとクラウドの両方で Kubernetes クラスタを実行できるようにする Google Cloud サービスです。これらの指標の一覧については、Anthos の指標をご覧ください。
aws.googleapis.com/SERVICE_NAME 1/PATH 2 Amazon Web Services からの指標。これらの指標の一覧については、AWS の指標をご覧ください。
istio.io/PATH 2 Istio for Google Cloud からの指標。これらの指標の一覧については、Istio の指標をご覧ください。
kubernetes.io/PATH 2 Google Kubernetes Engine からの指標。これらの指標の一覧については、Kubernetes の指標をご覧ください。
knative.dev/PATH 2 Knative からの指標。これらの指標の一覧については、Knative の指標をご覧ください。
external.googleapis.com/EXT_SERVICE/PATH 2
external.googleapis.com/prometheus/PATH 2		 Prometheus などのサードパーティのカスタム指標。このオープンソース モニタリング ツールは、多くの場合 Kubernetes によって使用されます。これらの指標の詳細については、外部指標をご覧ください。これらの指標タイプは、指標を定義しているプロジェクトでのみ使用できます。
custom.googleapis.com/PATH 2
external.googleapis.com/user/PATH 2		 ユーザー定義指標。 これらの指標タイプは、その定義がされているプロジェクトでのみ使用できます。
logging.googleapis.com/PATH 2 Cloud Logging からのログベースの指標定義済みの指標を使用するか、カスタム指標を作成することができます。カスタム指標は、定義したプロジェクトでのみ使用できます。

1 SERVICE_NAME は、Compute Engine の compute などの Google Cloud プロダクトを識別します。
2 PATH は、instance/cpu/utilization などのプロダクト内の指標を識別します。

指標のタイプとラベルのルール

次のリストは、カスタム指標タイプを作成する際に従うルールで構成されています。指標タイプに関連付けられたラベルは、タイプ LabelDescriptor の Key-Value ペアとして指定します。キーはラベルの名前として機能します。

  • 指標タイプ

    • 文字列には、大文字と小文字の英字（A-Z、a-z）、数字（0-9）、ピリオド（.）、アンダースコア（_）を使用します。
    • パス要素は、スラッシュ（/）で区切ります。
    • 各パス要素の先頭は文字または数字にする必要があります。
    • 指標タイプの文字列の最大長は 200 文字です。

  • ラベルのキー

    • ラベルのキーには、小文字の英字（a-z）、数字（0-9）、アンダースコア（_）を使用します。
    • ラベルのキーの先頭は文字にします。
    • ラベルキーの最大長は、100 文字です。
    • 各キーは指標タイプ内で一意である必要があります。
    • 指標タイプごとに 30 個までのラベルを作成できます。