Function Compute:インスタンスライフサイクルフック

コードの呼び出し

「コードの呼び出し」タイプのフックを設定すると、Function Compute は関数インスタンスの起動時または停止時に HTTP リクエスト POST /initialize または GET /pre-stop を関数に送信します。ビジネスコードがこのリクエストに応答する必要があります。

[パス] 列が (任意) とマークされているのは、各フックがオプション設定であるためです。作成する関数に Initializer を設定しない場合、/initialize を実装する必要はありません。この場合、HTTP サーバーが /initialize を実装していても、コード内の /initialize ロジックが呼び出されることはありません。PreStop についても同様です。

カスタムイメージで Initializer フックメソッドを使用するには、HTTP サーバーで POST メソッドを使用して /initialize パスのロジックを実装します。PreStop フックメソッドについても同様です。次のサンプルプログラムでは、Python 3.10 のカスタムランタイムを例として使用しています。

import os
from flask import Flask
from flask import request
app = Flask(__name__)
@app.route('/initialize', methods=['POST'])
def init_invoke():
    rid = request.headers.get('x-fc-request-id')
    print("FC Initialize Start RequestId: " + rid)
    # ここに独自の初期化ロジックを実装します
    print("FC Initialize End RequestId: " + rid)
    return "OK"
@app.route('/', defaults={'path': ''})
@app.route('/<path:path>', methods=['GET', 'POST', 'PUT', 'DELETE'])
def hello_world(path):
    rid = request.headers.get('x-fc-request-id')
    print("FC invoke Start RequestId: " + rid)
    # ここに独自の呼び出しロジックを実装します
    print("FC invoke End RequestId: " + rid)
    return "Hello, World!", 200, [('Function-Name', os.getenv('FC_FUNCTION_NAME'))]
@app.route('/pre-stop', methods=['GET'])
def prestop_invoke():
    rid = request.headers.get('x-fc-request-id')
    print("FC PreStop Start RequestId: " + rid)
    # ここに独自の PreStop ロジックを実装します
    print("FC PreStop End RequestId: " + rid)
    return "OK"
if __name__ == '__main__':
    app.run(host='0.0.0.0', port=9000)

フックコードは実行時に失敗することもあります。次の /initialize のサンプルは、2 つの典型的な失敗例と、それらに対する Function Compute の応答を示しています。各エラーコードのシステムの動作については、「フックのエラーコード」をご参照ください。

次の例では、ハンドラーが例外を発生させます。Function Compute はこの失敗を 500 エラーとして扱い、インスタンスを再起動します。

@app.route('/initialize', methods=['POST'])
def init():
    raise Exception("hahaha")
    return "OK", 200, []

次の例では、ハンドラーが 404 ステータスコードを返します。Function Compute はリクエストを再送しません。

@app.route('/initialize', methods=['POST'])
def init():
    return "OK", 404, []

命令の実行 (GPU アクセラレーション関数のみ)

「命令の実行」タイプでは、Function Compute は関数インスタンスの起動後に設定されたシェルコマンドまたはスクリプトを実行します。終了コードが 0 の場合はフック命令が正常に実行されたことを示し、それ以外の終了コードは失敗を示します。

/bin/bash、/bin/sh、/bin/csh、/bin/zsh などのカスタムシェル実装を使用できます。使用するシェル実装が関数のランタイム環境でサポートされていることを確認してください。

Function Compute コンソールでは、/bin/bash と /bin/sh がプリセットオプションとして提供されています。次の例では /bin/sh を使用しています。このスクリプトは、初期化のヘルスチェックを実行します。curl を使用してローカルサービスにリクエストを送信し、jq を使用して出力をフォーマットします。両方のツールがランタイム環境で利用可能であることを確認してください。

#!/bin/sh
URL="http://localhost:7860"
REQUEST_PATH="sdapi/v1/txt2img"
JSON_DATA='{
    "prompt": "",
    "steps": 1,
    "height": 8,
    "width": 8
}'
temp_file=$(mktemp)
trap 'rm -f "$temp_file"' EXIT
if ! http_code=$(curl -s -w "%{http_code}" \
    -H "Content-Type: application/json" \
    -d "$JSON_DATA" \
    -o "$temp_file" \
    -X POST "$URL"/"$REQUEST_PATH"); then
    echo "{\"status\": \"curl_error\", \"code\": $?}" \
| jq . >&2
    exit 1
fi
response=$(<"$temp_file")
echo "http code $http_code"
if [ "$http_code" -eq 200 ]; then
    echo "$response" | jq -r '.' || printf "%s\n" "$response"
    exit 0
else
    echo "$response" \
| jq -c 'if type == "object" then . else {raw: .} end' 2>/dev/null \
| jq -s '{status: "http_error", code: $code, response: .[0]}' \
        --arg code "$http_code" \
        >&2
    exit 1
fi

エラーの原因を特定しやすくするために、スクリプト内のエラー情報を標準エラー出力 (stderr) に書き込みます。たとえば、次のコードスニペットは、curl リクエストが失敗したときにエラー情報を書き込み、終了コードを 1 に設定します。失敗時の動作は同様です。命令が 0 以外の終了コードを返した場合、命令は再実行されず、システムは関連するエラーを返します。詳細については、「フックのエラーコード」をご参照ください。

if ! http_code=$(curl -s -w "%{http_code}" \
    -H "Content-Type: application/json" \
    -d "$JSON_DATA" \
    -o "$temp_file" \
    -X POST "$URL"/"$REQUEST_PATH"); then
    echo "{\"status\": \"curl_error\", \"code\": $?}" \
| jq . >&2
    exit 1
fi

コードの呼び出し

命令の実行

命令が 0 以外の終了コードを返した場合、命令は再実行されず、システムは関連するエラーを返します。スクリプトがエラー情報を stderr に書き込む場合、その出力を使用して失敗の原因を特定できます。