ログエントリから関数をトリガーする

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

多くの Google Cloud イベントが Cloud Audit Logs に記録されます。これらのログをフィルタし、シンクを使用して Pub/Sub トピックに転送できます。これらの Pub/Sub トピックは、Cloud Run functions をトリガーする通知を送信します。監査ログを生成するすべての Google Cloud サービスからカスタム イベントを作成できます。

このページでは、Pub/Sub トピックに転送されたログエントリから関数をトリガーする方法の例を示します。

Pub/Sub でトリガーされる関数のイベント構造

すべての Pub/Sub トリガー関数と同様に、Cloud Logging ログエントリからトリガーされる関数は PubsubMessage オブジェクトを受信します。このオブジェクトの data パラメータに base64 でエンコードされた文字列が含まれます。Cloud Logging ログイベントの場合、この値をデコードすると、関連するログエントリが JSON 文字列として返されます。

始める前に

このサンプルコードでは、Cloud Audit Logs を 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リージョン。例: us-central1

   • --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" \
       --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 トリガーはサービス アカウントにリンクされ、関数を呼び出すときに ID として使用します。Eventarc トリガーのサービス アカウントには、関数を呼び出す権限が必要です。デフォルトでは、Cloud Run はデフォルトのコンピューティング サービス アカウントを使用します。

   • --event-filters フラグには、トリガーがモニタリングするイベント フィルタを指定します。event-filters フィルタにすべて一致するイベントが関数の呼び出しをトリガーします。各トリガーには、サポートされているイベントタイプを指定する必要があります。作成後にイベント フィルタの種類を変更することはできません。イベント フィルタの種類を変更するには、新しいトリガーを作成して古いトリガーを削除する必要があります。（省略可）さらにフィルタを追加するには、--event-filters フラグを繰り返し、サポートされているフィルタを ATTRIBUTE=VALUE の形式で指定します。

Cloud ログエントリ

フィルタに一致する Cloud ログエントリが作成されると、関数に対応するログエントリが Google Cloud コンソールで次のように表示されます。

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