ウォームアップ リクエストを構成してパフォーマンスを改善する

新たに作成されたインスタンスにアプリのコードが読み込まれる際のリクエストとレスポンスのレイテンシを短縮するには、ウォームアップ リクエストを使用します。

App Engine は、作成されたばかりのインスタンスにアプリのコードを頻繁に読み込む必要があります。次の場合にインスタンスの読み込みが起こる可能性があります。

• 別のバージョンのアプリを再デプロイするとき。
• リクエスト数が現在実行中のインスタンス セットの容量を超え、その不足分を補うために新しいインスタンスが作成されるとき。
• 基盤となるインフラストラクチャやハードウェアのメンテナンスまたは修復が行われるとき。

アプリのコードを新しいインスタンスに読み込むと、読み込みリクエストが発生することがあります。読み込みリクエストのために、ユーザーのリクエスト レイテンシが増加する可能性がありますが、ウォームアップ リクエストを使用することによりこのレイテンシを回避できます。ウォームアップ リクエストは、実際のリクエストがインスタンスに到達するよりも先にアプリのコードを新しいインスタンスに読み込みます。

アプリケーションでウォームアップ リクエストが有効化されていると、App Engine は新しいインスタンスがアプリケーションで必要になるタイミングを検知し、ウォームアップ リクエストを開始して新しいインスタンスを初期化しようとします。しかし、この検出がいつもうまくいくとは限りません。そのため、アプリでウォームアップ リクエストが有効になっていても、読み込みリクエストが発生する場合があります。たとえば、アプリがトラフィックを処理していなければ、アプリへの最初のリクエストはウォームアップ リクエストではなく、常に読み込みリクエストになります。

App Engine アプリケーションに対する他のリクエストと同様、ウォームアップ リクエストもインスタンス時間を消費します。ウォームアップ リクエストが有効になっていても、読み込みリクエストの代わりにウォームアップ リクエストでアプリケーションの初期化が行われているだけなので、ほとんどの場合インスタンス時間が増えていることには気づきません。ウォームアップ リクエスト中に事前キャッシングなどの他の処理も行うと、インスタンス時間が増える可能性があります。min_idle_instances を 0 より大きい値に設定すると、それらのインスタンスの初回起動時にウォームアップ リクエストが発生する可能性がありますが、それ以降も使用できます。

ウォームアップ リクエストを有効にする

ウォームアップ リクエストは App Engine スケジューラによって使用されます。スケジューラは、ユーザーが指定した構成に基づいてインスタンスの自動スケーリングを制御します。ウォームアップ リクエストが有効な場合、App Engine は /_ah/warmup に対して GET リクエストを発行します。このリクエストのハンドラを実装すると、アプリケーション データを事前にキャッシュに保存するなど、アプリケーション固有のタスクを実行できます。

より多くのインスタンスが必要であると判断すると、スケジューラはインスタンスを起動します。ウォームアップ リクエストは、スケジューラがインスタンスの起動に使うため、有効化されていなくてもログに表示されることがあります。

ウォームアップ リクエストは必ず呼び出されるとは限りません。代わりに読み込みリクエストが送信されることがあります。たとえば、インスタンスが初めて起動されるインスタンスである場合や、トラフィックが急激に上昇する場合です。ただし、ウォームアップ リクエストが有効になっている場合は、すでにウォームアップされているインスタンスにリクエストを送信する「ベスト エフォート方式」が試行されます。

ウォームアップ リクエストを有効にするには、app.yaml ファイル内の inbound_services ディレクティブの下に warmup 要素を追加します。次に例を示します。

inbound_services:
- warmup

ハンドラを作成する

/_ah/warmup に送信されるリクエストを処理するハンドラを作成します。ハンドラでは、アプリで必要とされる任意のウォームアップ ロジックが実行されます。

// Sample warmup demonstrates usage of the /_ah/warmup handler.
package main

import (
	"context"
	"fmt"
	"log"
	"net/http"
	"os"
	"time"

	"cloud.google.com/go/storage"
)

var startupTime time.Time
var client *storage.Client

func main() {
	// Perform required setup steps for the application to function.
	// This assumes any returned error requires a new instance to be created.
	if err := setup(context.Background()); err != nil {
		log.Fatalf("setup: %v", err)
	}

	// Log when an appengine warmup request is used to create the new instance.
	// Warmup steps are taken in setup for consistency with "cold start" instances.
	http.HandleFunc("/_ah/warmup", func(w http.ResponseWriter, r *http.Request) {
		log.Println("warmup done")
	})
	http.HandleFunc("/", indexHandler)

	port := os.Getenv("PORT")
	if port == "" {
		port = "8080"
		log.Printf("Defaulting to port %s", port)
	}

	log.Printf("Listening on port %s", port)
	if err := http.ListenAndServe(":"+port, nil); err != nil {
		log.Fatal(err)
	}
}

// setup executes per-instance one-time warmup and initialization actions.
func setup(ctx context.Context) error {
	// Store the startup time of the server.
	startupTime = time.Now()

	// Initialize a Google Cloud Storage client.
	var err error
	if client, err = storage.NewClient(ctx); err != nil {
		return err
	}

	return nil
}

// indexHandler responds to requests with our greeting.
func indexHandler(w http.ResponseWriter, r *http.Request) {
	if r.URL.Path != "/" {
		http.NotFound(w, r)
		return
	}
	uptime := time.Since(startupTime).Seconds()
	fmt.Fprintf(w, "Hello, World! Uptime: %.2fs\n", uptime)
}