Go で Cloud Run functions の HTTP 関数を作成してデプロイする

はじめに

このガイドでは、Go ランタイムを使用して Cloud Run functions を記述するプロセスを説明します。Cloud Run functions には次の 2 つのタイプがあります。

  • HTTP 関数。標準的な HTTP リクエストから呼び出します。
  • イベント ドリブン関数。Pub/Sub トピック上のメッセージや Cloud Storage バケット内の変更など、Cloud インフラストラクチャのイベントによってトリガーされます。

詳しくは、HTTP 関数の作成とイベント ドリブン関数の作成をご覧ください。

始める前に

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

    Enable the APIs

    5.

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. Make sure that billing is enabled for your Google Cloud project.

  7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

    Enable the APIs

    8.
  8. gcloud CLI をインストールして初期化します。
  9. 次のコマンドを使用して、gcloud コンポーネントを更新してインストールします。 
    gcloud components update
  10. 開発環境を準備します。

    Go 設定ガイドに移動

関数を作成する

  1. 関数コードで使用するため、ローカル システムにディレクトリを作成します。

    Linux / Mac OS X

    mkdir ~/helloworld
cd ~/helloworld

    Windows

    mkdir %HOMEPATH%\helloworld
cd %HOMEPATH%\helloworld

  2. helloworld ディレクトリに、次の内容のファイルを hello_http.go という名前で作成します。

    
// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"encoding/json"
	"fmt"
	"html"
	"net/http"

	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
)

func init() {
	functions.HTTP("HelloHTTP", HelloHTTP)
}

// HelloHTTP is an HTTP Cloud Function with a request parameter.
func HelloHTTP(w http.ResponseWriter, r *http.Request) {
	var d struct {
		Name string `json:"name"`
	}
	if err := json.NewDecoder(r.Body).Decode(&d); err != nil {
		fmt.Fprint(w, "Hello, World!")
		return
	}
	if d.Name == "" {
		fmt.Fprint(w, "Hello, World!")
		return
	}
	fmt.Fprintf(w, "Hello, %s!", html.EscapeString(d.Name))
}

    このサンプル関数は HTTP リクエストで指定された名前を使用します。名前が指定されていない場合は、「Hello, World!」という挨拶を返します。

依存関係を指定する

依存関係を追跡するための go.mod ファイルを作成します。

cd ~/helloworld
go mod init example.com/hello
go mod tidy

関数に Functions Framework ライブラリ以外の依存関係がある場合は、go.mod ファイルを編集して追加します。Go vendor ディレクトリを使用して依存関係を指定することもできます。詳細については、Go での依存関係の指定をご覧ください。

ローカルで関数をビルドしてテストする

関数をデプロイすることなく、ローカルでビルドしてテストすることを選択できます。そのためには、関数を呼び出すためのローカルの main.go モジュールを作成する必要があります。

  1. cmd サブディレクトリを作成します。

    mkdir ~/helloworld/cmd
cd ~/helloworld/cmd

  2. ~/helloworld/cmd ディレクトリの main.go というファイルに次のコード スニペットをコピーして、関数を呼び出すメイン Go モジュールを作成します。

    package main

import (
  "log"
  "os"

  // Blank-import the function package so the init() runs
  _ "example.com/hello"
  "github.com/GoogleCloudPlatform/functions-framework-go/funcframework"
)

func main() {
  // Use PORT environment variable, or default to 8080.
  port := "8080"
  if envPort := os.Getenv("PORT"); envPort != "" {
    port = envPort
  }
  if err := funcframework.Start(port); err != nil {
    log.Fatalf("funcframework.Start: %v\n", err)
  }
}

  3. 残りの依存関係を go mod tidy コマンドを使用して解決します。

    go mod tidy

  4. 次のコマンドを使用して、関数をローカルで実行します。

    export FUNCTION_TARGET=HelloHTTP
go run ~/helloworld/cmd/main.go

  5. ブラウザで http://localhost:8080 にアクセスするか、別のウィンドウから curl localhost:8080 を実行して、関数をテストします。

    詳細については、ローカル関数にリクエストを送信するをご覧ください。

関数をデプロイする

関数をデプロイするには、helloworld ディレクトリで次のコマンドを実行します。

  gcloud functions deploy go-http-function \
    --gen2 \
    --runtime=go122 \
    --region=REGION \
    --source=. \
    --entry-point=HelloHTTP \
    --trigger-http \
    --allow-unauthenticated

REGION は、関数をデプロイする Google Cloud リージョンの名前に置き換えます（us-west1 など）。

オプションの --allow-unauthenticated フラグを使用すると、認証なしで関数にアクセスできます。

デプロイした関数をテストする

  1. 関数がデプロイされたら、gcloud functions deploy コマンドの出力で uri プロパティをメモするか、次のコマンドを使用して取得します。

      gcloud functions describe go-http-function \
    --region=REGION

    REGION は、関数をデプロイした Google Cloud リージョンの名前に置き換えます（us-west1 など）。

  2. ブラウザで、この URL にアクセスします。この関数は、「Hello World!」メッセージを返します。

    この URL は Google Cloud コンソールでも確認できます。Cloud Run functions の概要ページに移動し、関数の名前をクリックして [関数の詳細] ページを開きます。[トリガー] タブを開き、関数の URL を確認します。

関数のログを表示する

コマンドライン ツールを使用してログを表示する

関数のログは、Cloud Logging UI または Google Cloud CLI で確認できます。

gcloud CLI を使用して関数のログを表示するには、logs read コマンドを使用します。

    gcloud functions logs read \
      --gen2 \
      --limit=10 \
      --region=REGION \
      go-http-function

REGION は、関数をデプロイした Google Cloud リージョンの名前に置き換えます（us-west1 など）。

出力は次のようになります。

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.473
LOG:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.370
LOG:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.280
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "h-hello_h_t_t_p-1" on port 8080.

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.108
LOG:

ロギング ダッシュボードでログを表示する

ロギング ダッシュボードで関数のログを表示するには、Cloud Run functions の概要ページを開き、リストから関数の名前をクリックして、[ログ] タブをクリックします。