カウンタ指標を構成する

このページでは、Cloud Console、Logging API、gcloud コマンドライン ツールを使用してカウンタタイプのログベースの指標を作成する方法について説明します。

ログベースの指標の全体像については、ログベースの指標の概要をご覧ください。

カウンタ指標の作成

指標でカウントするログエントリのフィルタを作成する場合は、正規表現を使用します。 フィルタの長さは 20,000 文字までです。

Console

Google Cloud プロジェクトの Cloud Console でカウンタ指標を作成するには、次の手順に従います。

  1. [ロギング] > [ログベースの指標] ページに移動します。

    [ログベースの指標] に移動

  2. [指標を作成] をクリックします。[ログの指標の作成] パネルが表示されます。

  3. [指標タイプ] を [カウンター] に設定します。

  4. [詳細] セクションで次のフィールドを設定します。

    • ログ指標の名前: Cloud プロジェクトのログベースの指標で一意の名前を選択します。命名に関する制限事項が適用されます。詳細についてはトラブルシューティングをご覧ください。
    • 説明: 指標の説明を入力します。
    • ユニット: 空白のままにするか、数字「1」を挿入します。
  5. [フィルタの選択] で指標フィルタを定義します。

    ロギングクエリ言語を使用して、指標でカウントするログエントリのみを収集するフィルタを作成します。 正規表現を使用して指標のフィルタを作成することもできます。

    [ログをプレビュー] をクリックして、フィルタと一致するログエントリを表示するパネルを開きます。

  6. (省略可)[ラベル] にラベルを追加します。ラベルの作成手順については、ラベルの作成をご覧ください。

  7. [指標を作成] をクリックして、メトリックを作成します。

gcloud

gcloud コマンドライン ツールは、ラベルのないカウンタタイプのログベースの指標をサポートしています。以下は、ログベースの指標を作成するコマンドです。

gcloud logging metrics create METRIC_NAME METRIC_DESCRIPTION FILTER

たとえば、次のコマンドは error_count というログベースのカウンタ指標を作成します。

gcloud logging metrics create error_count \
     --description "Errors in syslog." \
     --log-filter "resource.type=gce_instance AND logName:logs/syslog AND severity>=ERROR"

Cloud プロジェクトのログベースの指標で一意の指標名を選択します。命名に関する制限事項が適用されます。詳細については、ログベースの指標のトラブルシューティングをご覧ください。

API

カウンタの指標を作成するには、Logging API の projects.metrics.create メソッドを使用します。このメソッドは、API Explorer で試用できます。次のように、メソッドの引数を準備します。

  1. parent フィールドを、指標を作成するプロジェクトに設定します。

    projects/PROJECT_ID
    
  2. リクエスト本文を LogMetric オブジェクトに設定します。オブジェクトの例を次に示します。

    {
      name:        "my-metric"
      description: "This is my metric."
      filter:      "resource.type=gce_instance AND logName:\"logs/syslog\"",
      metricDescriptor: {
          labels: [
            {
              key: "my-label",
              valueType: STRING,
              description: "This is my label.",
            }
          ]
      },
      labelExtractors: {
        "my-label":
          "REGEXP_EXTRACT(jsonPayload.someField, \"before ([0-9]+) after\")",
        ...
      },
    }
    

注:

  • プロジェクトのログベースの指標で一意の指標名を選択します。命名に関する制限事項が適用されます。詳細についてはトラブルシューティングをご覧ください。

  • カウンタ指標の場合、LogMetric フィールドの valueExtractorbucketOptions は用途がないため、省略します。

  • 指標にラベルがない場合は、metricDescriptorlabelExtractors フィールドを省略できます。指標にラベルがある場合、ラベル付けの手順や API でラベルを作成する方法について、ログベースの指標ラベルをご覧ください。

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

新しい指標レイテンシ

新しい指標は、以前のログビューアの指標リストおよび関連する Monitoring メニューにすぐに表示されます。データは通常、1 分以内で利用可能になります。

カウンタ指標の検査

Google Cloud プロジェクトのユーザー定義のログベース指標をリスト表示したり、Cloud プロジェクトの特定の指標を検査したりするには、次のようにします。

Console

[ログベースの指標] ページに移動します。

[ログベースの指標] に移動

[ユーザー定義の指標] ペインに、現在の Cloud プロジェクト内にあるユーザー定義のログベース指標が表示されます。

ログベースの指標でデータを表示するには、指標の行にあるメニューをクリックして、[Metrics Explorer に表示] を選択します。

gcloud

のユーザー定義のログベース指標を一覧表示するには、次のコマンドを使用します。

gcloud logging metrics list

プロジェクトのユーザー定義のログベース指標を表示するには、次のコマンドを使用します。

gcloud logging metrics describe METRIC_NAME

サポートが必要な場合は、次のコマンドを使用します。

gcloud logging metrics --help

指標の時系列データを Cloud SDK から読み取ることはできません。

API

指標のリスト

Cloud プロジェクトのユーザー定義のログベース指標を一覧表示するには、projects.metrics.list API メソッドを使用します。メソッドのパラメータには、次のように入力します。

  • : Cloud プロジェクトのリソース名。プロジェクト / PROJECT_ID
  • pageSize: 結果の最大数。
  • pageToken: 結果の次のページを取得します。ページトークンの使用方法について詳しくは、projects.metrics.list をご覧ください。

指標の定義を取得する

ユーザー定義のログベース指標を 1 つ取得するには、projects.metrics.get API メソッドを使用します。メソッドのパラメータには、次のように入力します。

  • metricName: 指標のリソース名。

    projects/PROJECT_ID/metrics/METRIC_ID
    

指標データを読み取る

ログベースの指標で時系列データを読み取るには、Cloud Monitoring API の projects.timeseries.list を使用します。時系列データの詳細については、時系列の読み取りをご覧ください。

ユーザー定義のログベース指標を 1 つ読み取るには、メソッドのパラメータに次のような指標タイプと ID を入力します。

logging.googleapis.com/user/METRIC_ID

カウンタ指標を更新する

ログベースの指標を更新して、指標で参照されるフィールドの説明、フィルタ、フィールド名を編集できます。新しいラベルを指標に追加し、指標とラベルの値を抽出する正規表現を変更できます。

ユーザー定義のログベースの指標またはラベルの名前とタイプは変更できません。また、ログベース指標の既存のラベルは削除できません。

ログベースの指標を編集するには、次の手順を行います。

Console

  1. [ログベースの指標] ページに移動します。

    [ログベースの指標] に移動

  2. 変更するログベースの指標のメニューで [指標を編集] をクリックします。

  3. 指標の変更可能な項目を変更します。

  4. [指標の更新] をクリックします。

gcloud

既存の指標の説明とクエリは、Cloud SDK を使用することによってのみ変更できます。

ログベースの指標を更新するには、次のコマンドを使用します。フラグのいずれかまたは両方を指定できます。

gcloud logging metrics update METRIC_NAME --description=DESCRIPTION --log-filter=FILTER

詳細については、次のコマンドを使用してください。

gcloud logging metrics update --help

API

ログベースの指標を編集するには、API の projects.metrics.update メソッドを使用します。フィールドを次のように設定します。

  • metricName: 指標の完全リソース名。

    projects/PROJECT_ID/metrics/METRIC_ID
    

    例:

    projects/my-gcp-project/metrics/my-error-metric
    
  • リクエスト本文には、加える変更や追加を除いて既存の指標とまったく同じ LogMetric オブジェクトを含めます。

カウンタ指標を削除する

ユーザー定義のログベース指標を削除するには、次の手順に従います。

Console

  1. [ログベースの指標] ページに移動します。

    [ログベースの指標] に移動

  2. 削除する接続を選択して、[削除] をクリックします。

    または、削除するログベースの指標のメニューで [指標を削除] をクリックします。

gcloud

次のコマンドを使用して、現在の Cloud プロジェクトのユーザー定義のログベース指標を削除します。

gcloud logging metrics delete METRIC_NAME

詳細については、次のコマンドを使用してください。

gcloud logging metrics delete --help

API

ユーザー定義のログベースの指標を削除するには、API の projects.metrics.delete メソッドを使用します。

さらに、Google Cloud Console の [ログベースの指標] ページの中にあるログベースの指標のインターフェースの [ユーザー定義の指標] ペインには、さらに多くの機能があり、Cloud プロジェクトのユーザー定義の指標の管理に役立ちます。詳しくは、[ユーザー定義の指標] ペインをご覧ください。