建立計數器指標

本頁面說明如何使用 GCP 主控台、Stackdriver Logging API 與 Cloud SDK (gcloud logging 指令) 建立計數器類型記錄指標

建立計數器指標

Logging 主控台

請按照下列步驟在 GCP 主控台中建立記錄計數器指標:

  1. 在 GCP 主控台的左側導覽清單中按一下 [Stackdriver Logging] > [Logs-based Metrics] (記錄指標),或按一下下列按鈕:

    前往「Logs-Based Metrics」(記錄指標)

  2. 使用頁面頂端的下拉式選單選取專案。

  3. 按一下頁面頂端的 [Create Metric] (建立指標)。您會在頁面右側看見「Metric Editor」(指標編輯工具),檢視器面板會在左側顯示您的記錄:

    建立計數器指標

  4. 在檢視器面板中建立篩選器,僅顯示您要在指標中計數的記錄項目。

    基本篩選器可在記錄項目上方的下拉式選單中找到。您也可以按一下搜尋列右側的下拉式選單,並選取 [轉換為進階篩選器],來存取進階篩選器介面。

    詳情請參閱記錄檢視器一文。

  5. 在「Metric Editor」(指標編輯工具) 面板中,設定下列欄位:

    • 名稱:選擇在專案的記錄指標中不重複的名稱。存在一些命名限制;詳情請參閱疑難排解一文。
    • 說明:說明指標。
    • 標籤:(選填) 為每個標籤按一下 [Add Item] (新增項目) 來新增標籤。如要進一步瞭解如何定義標籤,請參閱記錄指標標籤一文。
    • 單位:針對計數器指標,保留此欄位空白,或插入數字 [1]
    • 類型:「Counter」(計數器)
  6. 按一下 [建立指標] 來建立指標。

Logging API

如要建立計數器指標,請使用 Stackdriver Logging API 的 projects.metrics.create 方法。您可以試用 APIs 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 logging 指令支援不含標籤的計數器類型記錄指標。以下是建立記錄指標的指令:

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 選單中。資料應該可以在一分鐘之內使用。

檢查計數器指標

如要列出 GCP 專案中的記錄指標,或檢查專案中的特定指標,請執行下列操作:

Logging 主控台

按一下下列按鈕,前往「記錄指標」頁面,此頁面會列出目前專案中的所有記錄指標:

前往「Logs-based Metrics」(記錄指標)

如要查看記錄指標中的資料,請從指標清單右側的溢位選單中選取 [在 Metrics Explorer 中查看]

Logging API

列出指標

如要列出專案中的使用者定義的記錄指標,請使用 projects.metrics.list API 方法。 如下填入方法的參數:

  • parent:專案的資源名稱:projects/[PROJECT_ID]
  • pageSize:結果數上限。
  • pageToken:取得下一個頁面的結果。請參閱 projects.metrics.list 一文。

擷取指標定義

如要擷取單一使用者定義的記錄指標,請使用 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 主控台

  1. 前往「記錄指標」頁面:

    前往「Logs-based Metrics」(記錄指標)

  2. 按一下您要編輯的記錄指標右側選單中的 [Edit metric] (編輯指標)

  3. 只變更指標中的允許項目。

  4. 按一下 [Done] (完成)

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 主控台

  1. 前往「記錄指標」頁面:

    前往「Logs-based Metrics」(記錄指標)

  2. 選取您要刪除的指標,並按一下頁面頂端的 [Delete] (刪除)

    您也可以按一下您要刪除的記錄指標右側選單中的 [Delete metric] (刪除指標)

Logging API

使用 API 中的 projects.metrics.delete 方法。

Cloud SDK

使用下列指令刪除目前專案中的使用者定義的記錄指標:

gcloud logging metrics delete [METRIC_NAME]

如需詳細資料,請使用下列指令:

gcloud logging metrics delete --help

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Stackdriver Logging
需要協助嗎?請前往我們的支援網頁