透過記錄項目觸發函式

Cloud 稽核記錄會記錄許多 Google Cloud 服務的事件。您可以使用接收器篩選這些記錄，並將其轉送至觸發 Cloud Run 函式的 Pub/Sub 主題。對於任何會產生稽核記錄的Google Cloud 服務，皆可依此方式回應事件。

本頁範例說明如何從轉送至 Pub/Sub 主題的記錄項目叫用函式。本教學課程使用 Eventarc 觸發條件，但您也可以使用直接 Pub/Sub 觸發條件來觸發函式。

Pub/Sub 觸發函式的事件結構

由 Cloud Logging 記錄項目觸發的函式會收到 PubsubMessage 物件，而此物件的 data 參數為 base64 編碼字串。就 Cloud Logging 記錄事件而言，解碼此值之後，會以 JSON 字串傳回相關記錄項目。

事前準備

程式碼範例會將 Cloud 稽核記錄轉送至 Cloud Run 函式。執行程式碼範例前，請先備妥下列項目：

• Pub/Sub 主題
• Cloud Logging 記錄檔接收器

如要瞭解應啟用哪些 API，以及部署由 Pub/Sub 觸發的函式需要哪些角色，請參閱 Pub/Sub 觸發條件指南。

程式碼範例

您可以使用 Pub/Sub 觸發函式，偵測並回應匯出的 Cloud Logging 記錄：

exports.processLogEntry = data => {
  const dataBuffer = Buffer.from(data.data, 'base64');

  const logEntry = JSON.parse(dataBuffer.toString('ascii')).protoPayload;
  console.log(`Method: ${logEntry.methodName}`);
  console.log(`Resource: ${logEntry.resourceName}`);
  console.log(`Initiator: ${logEntry.authenticationInfo.principalEmail}`);
};

import base64
import json

def process_log_entry(data, context):
    data_buffer = base64.b64decode(data["data"])
    log_entry = json.loads(data_buffer)["protoPayload"]

    print(f"Method: {log_entry['methodName']}")
    print(f"Resource: {log_entry['resourceName']}")
    print(f"Initiator: {log_entry['authenticationInfo']['principalEmail']}")

// Package log contains examples for handling Cloud Functions logs.
package log

import (
	"context"
	"log"
)

// PubSubMessage is the payload of a Pub/Sub event.
// See the documentation for more details:
// https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage
type PubSubMessage struct {
	Data []byte `json:"data"`
}

// ProcessLogEntry processes a Pub/Sub message from Cloud Logging.
func ProcessLogEntry(ctx context.Context, m PubSubMessage) error {
	log.Printf("Log entry data: %s", string(m.Data))
	return nil
}

import com.google.cloud.functions.BackgroundFunction;
import com.google.cloud.functions.Context;
import functions.eventpojos.PubsubMessage;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.logging.Logger;

public class StackdriverLogging implements BackgroundFunction<PubsubMessage> {
  private static final Logger logger = Logger.getLogger(StackdriverLogging.class.getName());

  @Override
  public void accept(PubsubMessage message, Context context) {
    String name = "World";

    if (!message.getData().isEmpty()) {
      name = new String(Base64.getDecoder().decode(
          message.getData().getBytes(StandardCharsets.UTF_8)), StandardCharsets.UTF_8);
    }
    String res = String.format("Hello, %s", name);
    logger.info(res);
  }
}

部署及觸發函式

如要在部署函式時設定觸發條件，請按照下列步驟操作：

1. 在包含程式碼範例的目錄中執行下列指令，部署函式：

   Node.js

   gcloud run deploy nodejs-log-function \
         --source . \
         --function processLogEntry \
         --base-image nodejs20 \
         --region REGION
   

   Python

   gcloud run deploy python-log-function \
         --source . \
         --function process_log_entry \
         --base-image python312 \
         --region REGION
   

   Go

   gcloud run deploy go-log-function \
         --source . \
         --function ProcessLogEntry \
         --base-image go122 \
         --region REGION
   

   Java

   gcloud run deploy java-log-function \
         --source . \
         --function StackdriverLogging \
         --base-image java21 \
         --region REGION
   

   更改下列內容：

   • REGION：要部署函式的 Google Cloud 區域。例如 europe-west1。
   • --function 旗標指定範例原始碼中函式的進入點。這是 Cloud Run 在函式運作時執行的程式碼。此旗標的值必須是原始碼中既有的函式名稱或完整類別名稱。
   • --base-image 旗標會指定函式的基本映像檔環境。如要進一步瞭解基礎映像檔和各映像檔包含的套件，請參閱「執行階段基礎映像檔」。

2. 執行下列指令，建立可篩選事件的觸發條件：

   gcloud eventarc triggers create TRIGGER_NAME  \
       --location=EVENTARC_TRIGGER_LOCATION \
       --destination-run-service=SERVICE  \
       --destination-run-region=REGION \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
       --transport-topic=projects/PROJECT_ID/topics/TOPIC_NAME \
       --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com
   

   更改下列內容：

   • TRIGGER_NAME：觸發條件的名稱。
   • EVENTARC_TRIGGER_LOCATION：Eventarc 觸發條件的位置。一般來說，Eventarc 觸發條件的位置應與要監控事件的Google Cloud 資源位置相符。在多數情況下，您也應在相同區域部署函式。如要進一步瞭解 Eventarc 觸發條件位置，請參閱「瞭解 Eventarc 位置」。
   • SERVICE：要部署的函式名稱。
   • REGION：部署函式的 Cloud Run 區域。
   • PROJECT_NUMBER：您的 Google Cloud 專案編號。Eventarc 觸發條件會連結至服務帳戶，在叫用函式時做為身分識別。Eventarc 觸發條件的服務帳戶必須具備叫用函式的權限。根據預設，Cloud Run 會使用預設運算服務帳戶。
   • --event-filters 旗標會指定觸發條件監控的事件篩選器。當事件符合所有事件篩選器時，就會觸發函式呼叫。每個觸發條件都必須有支援的事件類型。事件篩選器類型建立後即無法變更。如要變更事件篩選器類型，請建立新的觸發條件，並刪除舊的觸發條件。您也可以重複使用 --event-filters 旗標，並以 ATTRIBUTE=VALUE 格式加入支援的篩選器，藉此新增更多篩選器。
   • TOPIC_NAME：接收記錄項目事件的 Pub/Sub 主題名稱。
   • --transport-topic 旗標會指定 Eventarc 用來將事件傳輸至函式的 Pub/Sub 主題。請注意，如果您先前未建立 Pub/Sub 主題，則不需要這個旗標。

Cloud 記錄項目

如果建立的 Cloud 記錄項目符合任一篩選條件，Google Cloud 控制台中函式的對應記錄項目應如下所示：

Method: METHOD
Resource: projects/YOUR_GCLOUD_PROJECT/...
Initiator: YOUR_EMAIL_ADDRESS