カウンタ指標の作成

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

カウンタ指標の作成

Logging Console

GCP Console でログベースのカウンタ指標を作成するには、次の手順に従います。

  1. GCP Console の左側のナビゲーション リストで、[Stackdriver Logging] > [ログベースの指標] をクリックするか、次のボタンをクリックします。

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

  2. ページの上部にあるプルダウン メニューを使用してプロジェクトを選択します。

  3. ページの上部にある [指標を作成] をクリックします。ページの右側に [指標エディタ]、左側にログを表示するビューアパネルが表示されます。

    カウンタ指標の作成

  4. ビューアパネルで、指標でカウントするログエントリのみを表示するフィルタを作成します。

    基本フィルタは、ログエントリの上にあるプルダウン メニューから選択できます。検索バーの右側にあるプルダウン メニューをクリックして、[高度なフィルタに変換] を選択すると、高度なフィルタのインターフェースを表示できます。

    詳細については、ログビューアをご覧ください。

  5. [指標エディタ] パネルで、次のフィールドを設定します。

    • 名前: プロジェクトのログベースの指標で一意の名前を選択します。命名に関する制限事項が適用されます。詳細についてはトラブルシューティングをご覧ください。
    • 説明: 指標を説明します。
    • ラベル: (省略可)ラベルごとに [アイテムを追加] をクリックして、ラベルを追加します。ラベルの定義の詳細については、ログベースの指標ラベルをご覧ください。
    • 単位: カウンタ指標では、空白のままにするか、数字「1」を挿入します。
    • タイプ: カウンタ
  6. [指標を作成] をクリックして、メトリックを作成します。

Logging API

カウンタ指標を作成するには、Stackdriver 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 タイプをご覧ください。

Cloud SDK

Cloud SDK 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"

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

新しい指標のレイテンシ

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

カウンタ指標の検査

GCP プロジェクトのログベース指標を一覧表示する、またはプロジェクトの特定の指標を検査するには、次の手順を行います。

Logging Console

次のボタンをクリックして、[ログベースの指標] ページに移動します。このページには、現在のプロジェクトのすべてのログベースの指標が一覧表示されます。

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

ログベースの指標でデータを表示するには、指標のリストの右側にあるオーバーフロー メニューから [Metric Explorer に表示] を選択します。

Logging API

指標の一覧表示

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

  • parent: プロジェクトのリソース名: projects/[PROJECT_ID]
  • pageSize: 結果の最大数。
  • pageToken: 結果の次のページを取得します。projects.metrics.list をご覧ください。

指標定義の取得

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

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

    projects/[PROJECT_ID]/metrics/[METRIC_ID]
    

指標データの読み取り

ログベースの指標で時系列データを読み取るには、Stackdriver Monitoring API の projects.timeseries.list を使用します。詳しくは、時系列の読み取りをご覧ください。ログベースの指標に必要な情報は次のとおりです。

  • 指標タイプは logging.googleapis.com/user/[METRIC_ID] です。

Cloud SDK

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

gcloud logging metrics list

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

gcloud logging metrics describe [METRIC_NAME]

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

gcloud logging metrics --help

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

カウンタ指標の更新

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

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

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

Logging Console

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

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

  2. 編集するログベースの指標の右側にあるメニューの [指標を編集] をクリックします。

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

  4. [完了] をクリックします。

Logging API

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

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

    projects/[PROJECT_ID]/metrics/[METRIC_ID]
    

    例:

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

Cloud SDK

Cloud SDK を使用すると、既存の指標の説明とフィルタのみを変更できます。

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

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

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

gcloud logging metrics update --help

カウンタ指標の削除

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

Logging Console

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

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

  2. 削除する指標を選択し、ページの上部にある [削除] をクリックします。

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

Logging API

API の projects.metrics.delete メソッドを使用します。

Cloud SDK

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

gcloud logging metrics delete [METRIC_NAME]

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

gcloud logging metrics delete --help

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

ご不明な点がありましたら、Google のサポートページをご覧ください。