デベロッパー

Google Cloud Functions のアンチパターンを回避する（第 5 回）: Python でバックグラウンドプロセスを正しく実行する方法

2021年12月3日

Google Cloud Japan Team

※この投稿は米国時間 2021 年 11 月 18 日に、Google Cloud blog に投稿されたものの抄訳です。

編集者注: 過去数週間にわたり、Google Cloud Functions の関数を記述するためのベストプラクティスに注目するブログ投稿シリーズを公開してきました。これらのベストプラクティスは、サポートチームがよく受ける質問や、よく見かける誤解を基にしています。こうした問題をここでは「アンチパターン」と呼び、これらを回避する方法をご紹介します。この記事は、そのシリーズの第 5 回です。

シナリオ

Python 関数でバックグラウンドプロセスが完了する前に、ログに finished with status: 'timeout' が表示されます。

よくある根本的な問題

このタイムアウトエラーは、どのランタイムを使用する関数でも発生する可能性がありますが、Python デベロッパーが Cloud Functions の関数で os.fork() または multiprocessing.Process() を使用しようとした場合に特によく発生します。

Cloud Functions の関数で非同期処理を避けるべき理由

Cloud Functions の関数によって開始されたバックグラウンドタスクは、完了することが保証されていません。そのため、関数が完了したら（関数を返したり、タイムアウトエラーが発生したりなど）、関数インスタンスはいつでも終了できます。関数実行タイムラインについて詳しくは、ドキュメントをご覧ください。

多くの場合、お客様は関数のテストを、このような実行タイムアウトが存在しないローカル環境で行っています。また、お客様のローカルマシンは Cloud Functions の関数をプロビジョニングしているマシンよりも高性能である場合があります。そのため、こうしたマルチプロセスのシナリオがローカルで機能しているのを見て、コードが Cloud Functions インスタンスでも同じように機能すると思い込んでしまうことがあります。

このような非同期処理を必要とする Python デベロッパーは、代わりに Cloud Tasks サービスを使用してバックグラウンド処理をスケジュールすることをおすすめします。次の例をご覧ください。

Python Cloud Functions の関数で Cloud Tasks を使用する

次の関数は、Cloud Tasks を使用して非同期処理をスケジュールする方法を示しています。これは、Cloud Functions の関数（名前は「create_task」）が、バックグラウンドタスクを実行する別の Cloud Functions の関数を呼び出す Cloud Task を作成する例になります。詳細については、HTTP Target タスクの作成をご覧ください。

読み込んでいます...

"""任意のペイロードで特定のキューに対するタスクを作成します。"""
from flask import escape
from google.cloud import tasks_v2
from google.protobuf import timestamp_pb2
import datetime
import json
 
 
def create_task(request):
 
   # クライアントを作成する。
   client = tasks_v2.CloudTasksClient()
 
   # TODO（デベロッパー）: これらの行のコメント化を解除し、独自の値に置き換える。
   project = '<PROJECT_ID>'
   queue = 'my-queue'
   location = '<your-region>'
   url = '<url-to-Cloud-Function-to-run-background-task>'
   payload = {'message': 'Hello from Cloud Tasks'}
   in_seconds = 60
 
   # 完全修飾されたキュー名を作成する。
   parent = client.queue_path(project, location, queue)
 
   # リクエストの本文を作成する。
   task = {
       "http_request": {  # リクエストのタイプを指定する。
           "http_method": tasks_v2.HttpMethod.POST,
           "url": url,  # タスクの送信先の完全な URL パス。
           "oidc_token": {
               "service_account_email": "<your-service-account-with-function-invoker-role>@<PROJECT_ID>.iam.gserviceaccount.com",
               "audience": url
           }
       }
   }
   if payload is not None:
       if isinstance(payload, dict):
           # 辞書を JSON 文字列に変換する。
           payload = json.dumps(payload)
           # HTTP Content-Type を application/json に指定する
           task["http_request"]["headers"] = {
               "Content-type": "application/json"}
 
       # API はペイロードがバイト型であることを想定。
       converted_payload = payload.encode()
 
       # リクエストにペイロードを追加する。
       task["http_request"]["body"] = converted_payload
 
   if in_seconds is not None:
       # 「今から数秒後」を rfc3339 DATETIME 文字列に変換する。
       d = datetime.datetime.utcnow() + datetime.timedelta(seconds=in_seconds)
 
       # タイムスタンプの protobuf を作成する。
       timestamp = timestamp_pb2.Timestamp()
       timestamp.FromDatetime(d)
 
       # タスクにタイムスタンプを追加する。
       task["schedule_time"] = timestamp
 
   # クライアントを使用してタスクを構築し送信する。
   response = client.create_task(request={"parent": parent, "task": task})
 
   print("Created task {}".format(response.name))
   return 'Task Created!'

その他の役立つヒント

こちらのチュートリアルは Node.js 用に作成されていますが、Cloud Tasks タスクのキューを作成し、タスクから関数を呼び出すためのサービスアカウントを設定する手順も説明しています。タスクにサービスアカウントを指定することで、認証が必要な Cloud Functions の関数を使用できます。
Cloud Functions の関数の呼び出しに（関数の ID ではなく）異なるサービスアカウントを使用している場合、そのサービスアカウントに Cloud Functions 起動元のロール（roles/cloudfunctions.invoker）があることを確認する必要があります。
「create_task」関数の ID に、デフォルトとは異なるサービスアカウントを使用している場合、そのサービスアカウントにタスクを作成する権限があることを確認する必要があります。Cloud Tasks へのデータ追加ロール（roles/cloudtasks.enqueuer）が必要です。

Cloud Tasks について詳しくは、本シリーズの第 3 回目のブログ記事（アウトバウンド接続の確立方法）もご確認ください。

- Cloud デベロッパーアドボケイト Sara Ford

- テクニカルソリューションエンジニア Martin Skoviera

デベロッパー

Google Cloud Functions のアンチパターンの回避（第 4 回）: Node.js の Cloud Functions 関数内で Promise を適切に処理する方法

サポートチームが見た、Google Cloud Functions のアンチパターンを回避する方法を紹介するシリーズの第 4 回目の記事です。この記事では、未定義のデータやキャッシュに保存されたデータをデータベースに保存しないために、Node.js で Promise を適切に処理していることを確認する方法を説明します。

執筆者: Google Cloud Japan Team • 所要時間: 2 分