Node.js で Cloud Run の HTTP 関数を作成してデプロイする

このドキュメントでは、簡単な Cloud Run functions の HTTP 関数を作成するプロセスについて説明します。これは、次の 2 種類の Cloud Run functions のいずれかです。

  • 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. 開発環境を準備します。

    Node.js 設定ガイドに移動

関数を作成する

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

    Linux / Mac OS X

    mkdir ~/helloworld
cd ~/helloworld

    Windows

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

  2. helloworld ディレクトリに、次の内容の index.js ファイルを作成します。

    const functions = require('@google-cloud/functions-framework');

// Register an HTTP function with the Functions Framework that will be executed
// when you make an HTTP request to the deployed function's endpoint.
functions.http('helloGET', (req, res) => {
  res.send('Hello World!');
});

    このサンプル関数は、すべてのリクエストに「Hello World!」という挨拶を返します。

依存関係を指定する

Node.js における依存関係は、npm で管理され、package.json というメタデータ ファイルで表現されます。このファイルは手動で、または npm コマンドを使用して作成できます。

  • npm コマンドを使用して package.json ファイルを作成するには:

    1. helloworld ディレクトリから npm init コマンドを実行します。Enter を押して、質問への回答をデフォルトのまま確定します。

      npm init

    2. package.json ファイルを編集して、functions-framework 依存関係を追加します。

      "dependencies": {
  "@google-cloud/functions-framework": "^3.1.0"
}

  • package.json ファイルを手動で作成する場合は、次の内容をコピーします。

{
  "name": "nodejs-docs-samples-functions-hello-world-get",
  "version": "0.0.1",
  "private": true,
  "license": "Apache-2.0",
  "author": "Google Inc.",
  "repository": {
    "type": "git",
    "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
  },
  "engines": {
    "node": ">=16.0.0"
  },
  "scripts": {
    "test": "c8 mocha -p -j 2 test/*.test.js --timeout=6000 --exit"
  },
  "dependencies": {
    "@google-cloud/functions-framework": "^3.1.0"
  },
  "devDependencies": {
    "c8": "^10.0.0",
    "gaxios": "^6.0.0",
    "mocha": "^10.0.0",
    "wait-port": "^1.0.4"
  }
}

多くの Node.js クライアント ライブラリが Google Cloud プロダクトで使用でき、依存関係としてインストールできます。

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

関数をデプロイする前にローカルでテストするには、Functions Framework をローカルにインストールしてから関数を実行する必要があります。

  1. helloworld ディレクトリから次のコマンドを実行して、ローカルマシンに Functions Framework をインストールします。

    npm install @google-cloud/functions-framework

  2. 関数をローカルで実行するには、helloworld ディレクトリから次のコマンドを実行します。

    npx @google-cloud/functions-framework --target=helloGET

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

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

関数から「Hello World!」というメッセージが返されます。

関数をデプロイする

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

gcloud functions deploy hello-node-function \
  --gen2 \
  --runtime=nodejs20 \
  --region=REGION \
  --source=. \
  --entry-point=helloGET \
  --trigger-http \
  --allow-unauthenticated

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

これにより、選択したリージョンに nodejs20 ランタイムを使用してサンプル関数がデプロイされます。

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

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

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

      gcloud functions describe hello-node-function \
    --region=REGION

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

  2. ブラウザまたは次の curl コマンドを使用して、この URL にアクセスします。

    curl FUNCTION_URL

    FUNCTION_URL は、取得した uri プロパティに置き換えます。

    関数から「Hello World!」というメッセージが返されます。

関数のログを表示する

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

関数のログを表示するには、Cloud Logging UI または Google Cloud CLI を使用します。

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

    gcloud functions logs read \
      --gen2 \
      --region=REGION \
      --limit=10 \
      hello-node-function

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

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

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:42:24.956
LOG:

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:42:01.692
LOG:

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:31:47.711
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello--node--function-1" on port 8080.

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:31:46.542
LOG:

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:31:27.390
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello--node--function-1" on port 8080.

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

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