命名規則

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

  • 特定のプロジェクトの識別子
  • 文字列が指標記述子を示すことを表すマーカー
  • 指標タイプ

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

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/antho/APIServiceOpenAPIAggregationControllerQueue1_adds

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

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

可能な構造 説明
SERVICE 1.googleapis.com/PATH 2 Google Cloud のプロダクトとサービスの指標。これらの指標の一覧については、Google Cloud の指標をご覧ください。
agent.googleapis.com/SERVICE 1/PATH 2 Google Cloud または AWS の VM インスタンスで実行されている Monitoring エージェントと Logging エージェントからの指標。これらの指標の一覧については、エージェントの指標をご覧ください。
kubernetes.io/anthos/PATH 2 Anthos(オンプレミスとクラウドの両方でKubernetesクラスターを実行できるようにするGoogle Cloudサービス)の指標。これらの指標の一覧については、Anthos の指標をご覧ください。
aws.googleapis.com/SERVICE 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 ユーザー定義のカスタム指標。これらの指標タイプは、指標を定義しているプロジェクトでのみ使用できます。
logging.googleapis.com/PATH 2 Cloud Logging からのログベースの指標事前定義された指標を使用することも、カスタム指標を作成することもできます。カスタム指標は、それを定義したプロジェクトでのみ使用できます。

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

指標タイプとラベルの命名

カスタム指標タイプを作成する場合は、次の指標タイプとラベルの命名規則を次のように遵守する必要があります。指標タイプを定義する場合、ラベルは LabelDescriptor タイプの Key-Value ペアとして指定されます。キーはラベルの名前として機能します。

  • 指標タイプ
    • 文字列には大文字と小文字の英字(A-Za-z)、数字(0-9)、アンダースコア(_)を使用できます。
    • ピリオド(.)は、文字列のドメイン部分でのみ使用できます(例: custom.googleapis.com)。
    • スラッシュ(/)を使用してパス要素を区切ることができます。
    • 各パス要素の先頭は文字または数字にします。
    • 指標タイプの文字列の最大長は 200 文字です。
  • ラベルキー
    • ラベルキーでは小文字(a-z)、数字(0-9)、アンダースコア(_)、ダッシュ(-)を使用できます。
    • ラベルキーの先頭は文字にします。
    • ラベルキーの最大文字数は 100 文字です。
    • 各キーは指標タイプ内で一意である必要があります。 指標タイプごとに 10 個までのラベルを作成できます。