ログベースの指標にラベルを構成する

Console

1. ログベースの指標を作成する場合は、[ログの指標を作成] パネルにラベルを追加するオプションがあります。

2. [ラベルを追加] をクリックします。

   ヒント: ログエントリ内のフィールドと値を表示するには、次のようにします。

   1. [フィルタの選択] で [ログのプレビュー] をクリックします。
   2. [ログを表示] ペインで、ログエントリを選択して、その横にある展開navigate_nextをクリックします。
   3. [ネストされたフィールドを展開] をクリックします。

3. [ラベル] セクションで次のフィールドを設定します。

   1. ラベル名: ラベルの名前を入力します。例: ID
      

      名前は、次の条件を満たす必要があります。

      • 長さが 100 文字以下である。
      • 正規表現 [a-zA-Z][a-zA-Z0-9_]* と一致する。
      • 文字列「log」以外も含まれる。

   2. 説明: ラベルを説明します。想定されるログ値の形式について、できるだけ具体的に指定してください。例: Instance number

   3. ラベルのデータ型: [文字列]、[ブール値]、または [整数] を選択します。

   4. フィールド名: ラベルの値を含むログエントリ フィールドの名前を入力します。入力時に選択肢が表示されます。このサンプルでは、次のフィールドになります。

      labels."compute.googleapis.com/resource_id"
      

   5. 正規表現: ラベルの値によってフィールドのコンテンツ全体が構成されている場合は、このフィールドを空のままにしておくことができます。それ以外の場合は、フィールド値からラベル値を抽出する正規表現のキャプチャ グループを指定します。

      たとえば、フィールドには通常、次のようなテキストが含まれているとします。

      The instance number is 0123456789; the ID is my-test-instance22
      

      ラベル値をインスタンス番号にする場合は、正しい番号を抽出する多くの正規表現があります。たとえば、次の式では、かっこは抽出されるテキストの部分を識別するキャプチャ グループです。

      The instance number is ([0-9]+); .*
      

      正規表現の詳細については、RE2 構文をご覧ください。

4. [完了] をクリックして、ラベルを作成します。これらの手順を繰り返して、さらにラベルを追加できます。

5. 指標の作成を終了するには、[指標を作成] をクリックします。

gcloud

カスタムラベルを使用してログベースの指標を作成するには、カスタムラベルを含む、JSON または YAML 形式の LogMetric 定義の表現を含むファイルを作成する必要があります。次に、--config-from-file フラグを指定して create コマンドを呼び出し、FILENAME は JSON ファイルまたは YAML ファイルの名前で置き換えて、指標を作成します。

gcloud logging metrics create metric_name --config-from-file FILENAME

詳細については、gcloud logging metrics create をご覧ください。

API

ラベルは Logging API の projects.metrics.create メソッド呼び出しリクエストの本文で、LogMetric オブジェクトの一部として指定します。完全なメソッド呼び出しの詳細については、カウンタ指標の作成または分布指標の作成をご覧ください。

各ラベルについて、LogMetric の metricDescriptor フィールドと labelExtractors フィールドの両方にセグメントを追加する必要があります。

構文は次のとおりです。

{
  ...
  metricDescriptor: {
      labels: [
        { key: LABEL_NAME, valueType: LABEL_TYPE,
          description: LABEL_DESCRIPTION },
        ...
      ]
  },
  labelExtractors: {
    LABEL_NAME: EXTRACTOR_EXPRESSION,
    ...
  },
}

構文要素の意味は次のとおりです。

• LABEL_NAME: 文字列としてのラベルの名前。
• VALUE_TYPE: ラベルのタイプ: STRING、BOOL、または INT64。
• LABEL_DESCRIPTION: ラベルの説明。

• EXTRACTOR_EXPRESSION: ログエントリ フィールド名と任意の正規表現を組み合わせた文字列。抽出式は次のいずれかです。

  EXTRACT(FIELD)
  

  REGEXP_EXTRACT(FIELD, REGEXP)
  

正規表現の詳細については、RE2 構文をご覧ください。

2 つのラベルの例を次に示します。

{
  ...
  metricDescriptor: {
      labels: [
        { key: "label_name_a", valueType: STRING },
        { key: "label_name_b", valueType: INT64 },
      ]
  },
  labelExtractors: {
    "label_name_a":
      "REGEXP_EXTRACT(jsonPayload.field_a, \"before ([a-zA-Z ]+) after\")",
    "label_name_b": "EXTRACT(jsonPayload.field_b)",
  },
}

詳しくは、LogMetric タイプをご覧ください。