関数インスタンスのライフサイクルフック - Function Compute

このトピックでは、Goランタイム環境で関数インスタンスのライフサイクルフックを実装する方法について説明します。

背景情報

ファンクションインスタンスのライフサイクルフックを設定した後、インスタンスの関連ライフサイクルイベントが発生すると、function Computeがフックを呼び出します。関数インスタンスに設定できるライフサイクルフックは、Initializer、PreFreeze、PreStopです。詳細は、「Functionインスタンスのライフサイクル」をご参照ください。

関数インスタンスのライフサイクルフックの課金ルールは、一般的な呼び出し要求の課金ルールと同じです。ただし、実行ログは、関数ログ、インスタンスログ、または高度なログでのみ照会できます。ライフサイクルフックのログは通話要求リストに表示されません。詳細については、「」をご参照ください。インスタンスライフサイクルフックのログを表示します。.

重要

PreFreezeおよびPreStopフックを使用する場合は、fc-runtime-go-sdkをv0.1.0以降にアップグレードします。

フックメソッドの署名

Initializerフックは、関数インスタンスが開始された後、ハンドラーが実行される前に実行されます。 Function Computeは、関数インスタンスのライフサイクル内で1回だけInitializerフックが正常に呼び出されるようにします。たとえば、Initializerフックの呼び出しに失敗した場合、システムはInitializerフックが正常に呼び出されるまでInitializerフックを再試行し、ハンドラーを実行します。 Initializerフックが繰り返し呼び出されるときに正しく設定されていることを確認してください。
関数インスタンスが凍結される前に、PreFreezeフックが実行されます。
関数インスタンスが破棄される前に、PreStopフックが実行されます。

Initializerフック、PreFreezeフック、およびPreStopフックのメソッドシグネチャは同じです。シグネチャには、Context入力パラメータのみが含まれ、応答パラメータは含まれません。構文:

function(ctx context.Context)

フックメソッドを実装する

コードにライフサイクルフックメソッドを実装し、登録に対応する関数を使用する必要があります。次のコードは、フックメソッドを登録する方法を示しています。

// Register the Initializer hook method.
fc.RegisterInitializerFunction(initialize)
// Register the PreStop hook method.
fc.RegisterPreStopFunction(preStop)
// Register the PreFreeze hook method.
fc.RegisterPreFreezeFunction(preFreeze)

サンプルプログラム:

package main

import (
    "context"
    "log"

    "github.com/aliyun/fc-runtime-go-sdk/fc"
    "github.com/aliyun/fc-runtime-go-sdk/fccontext"
)

func HandleRequest(ctx context.Context) (string, error) {
    return "hello world!", nil
}

func preStop(ctx context.Context) {
    log.Print("this is preStop handler")
    fctx, _ := fccontext.FromContext(ctx)
    fctx.GetLogger().Infof("context: %#v\n", fctx)
}

func preFreeze(ctx context.Context) {
    log.Print("this is preFreeze handler")
    fctx, _ := fccontext.FromContext(ctx)
    fctx.GetLogger().Infof("context: %#v\n", fctx)
}

func initialize(ctx context.Context) {
    log.Print("this is initialize handler")
    fctx, _ := fccontext.FromContext(ctx)
    fctx.GetLogger().Infof("context: %#v\n", fctx)
}

func main() {
    fc.RegisterInitializerFunction(initialize)
    fc.RegisterPreStopFunction(preStop)
    fc.RegisterPreFreezeFunction(preFreeze)
    fc.Start(HandleRequest)
}

説明

func initialize(ctx context.Context): Initializerフックメソッド。 ctx context.Contextパラメーターは、関数の実行時のコンテキスト情報を提供します。詳細は、「コンテキスト」をご参照ください。
func preStop(ctx context.Context): PreStopフックメソッド。 ctx context.Contextパラメーターは、関数の実行時のコンテキスト情報を提供します。詳細は、「コンテキスト」をご参照ください。
func preFreeze(ctx context.Context): PreFreezeフックメソッド。 ctx context.Contextパラメーターは、関数の実行時のコンテキスト情報を提供します。詳細は、「コンテキスト」をご参照ください。
func main(): function Computeの関数コードのエントリポイント。 Goプログラムにはmain関数が含まれている必要があります。 fc.Start(HandleRequest) をコードに追加してハンドラーを実行するメソッドを指定し、fc.RegisterInitializerFunction(initialize) を追加してInitializerフックメソッドを登録します。 PreStopとPreFreezeフックメソッドを同様の方法で登録します。
重要
- 上記のサンプルコードは、イベントハンドラーにのみ適用されます。 HTTPハンドラーを使用する場合は、コード内のfc.Start(HandleRequest) をfc.StartHttp(HandleRequest) に置き換えます。
- ライフサイクルフックメソッドは、fc.Start(HandleRequest) またはfc.StartHttp(HandleRequest) の前に登録する必要があります。それ以外の場合、登録は失敗します。

ライフサイクルフックの設定

Function Computeコンソールの使用

[Initializer Hook] 、[PreFreeze Hook] 、および [PreStop Hook] パラメーターは、Function Computeコンソールの [Function Details] ページで設定できます。Function Computeの例:

db-go-lifecycle

詳細は、「Functionインスタンスのライフサイクル」をご参照ください。

Serverless Devsの使用

Serverless Devsを使用する

Serverless Devsを使用してライフサイクルフックを設定できます。この場合、Initializerフック、PreFreezeフック、およびPreStopフックをs.yamlファイルに追加する必要があります。

初期化フックの設定
initializerフィールドとinitializationTimeoutフィールドをfunctionパラメーターに追加します。
PreFreezeフックの設定
handlerとtimeoutを含むinstanceLifecycleConfig.preFreezeフィールドをfunctionパラメーターに追加します。
PreStopフックの設定
handlerとtimeoutを含むinstanceLifecycleConfig.preStopフィールドをfunctionパラメーターに追加します。

重要

handlerフィールドは、空でない文字列として構成する必要があります。 s.yamlファイルでデフォルト値 "true" を使用すると、二重引用符は削除できません。

サンプルコード：

edition: 1.0.0
name: hello-world  #  The name of the project.
access: default    #  The alias of the key.

vars: # The global variables.
  region: cn-shanghai # The ID of the region.
  service:
    name: fc-example
    description: 'fc example by serverless devs'

services:
  helloworld: # The name of the service or module.
    component: fc
    props: # The property value of the component.
      region: ${vars.region}
      service: ${vars.service}
      function:
        name: golang-lifecycle-hook-demo
        description: 'fc example by serverless devs'
        runtime: go1
        codeUri: ./target
        handler: main
        memorySize: 128
        timeout: 60
        initializationTimeout: 60
        initializer: "true"
        instanceLifecycleConfig:
          preFreeze:
            handler: "true"
            timeout: 30
          preStop:
            handler: "true"
            timeout: 30

Serverless DevsのYAML構文の詳細については、「Serverless Devsコマンド」をご参照ください。

インスタンスライフサイクルフックのログを表示します。

ライフサイクルフックのログは、[関数ログ] で表示できます。

Function Computeコンソールにログインします。左側のナビゲーションウィンドウで、[サービスと機能] をクリックします。
上部のナビゲーションバーで、リージョンを選択します。 [サービス] ページで、目的のサービスをクリックします。
[関数] ページで、目的の関数の名前をクリックします。表示される [関数の詳細] ページで、[関数のテスト] タブをクリックします。

[テスト関数] タブで、[テスト関数] をクリックします。 [ログ] > [関数ログ] を選択します。

[関数ログ] タブでは、呼び出しログ、および関数のInitializerフックとPreFreezeフックのログを表示できます。例:

2022-10-09 19:26:17 FunctionCompute dotnetcore3.1 runtime inited.
2022-10-09 19:26:17 FC Initialize Start RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Initialize start
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Handle initializer: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Initialize end
2022-10-09 19:26:17 FC Initialize End RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 FC Invoke Start RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Handle request: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 FC Invoke End RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 FC PreFreeze Start RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] PreFreeze start
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Handle PreFreeze: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] PreFreeze end
2022-10-09 19:26:17 FC PreFreeze End RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******

各関数インスタンスは一定期間キャッシュされ、すぐには破棄されません。PreStopフックのログをすぐに表示することはできません。 PreStopフックをすばやくトリガーするには、関数設定または関数コードを更新します。更新が完了すると、関数ログでPreStopフックのログを表示できます。例:

2022-10-09 19:32:17 FC PreStop Start RequestId: 03be685c-378b-4736-8b08-a67c1d*****
2022-10-09 19:32:17 2022-10-09 19:32:17 03be685c-378b-4736-8b08-a67c1d***** [INFO] PreStop start
2022-10-09 19:32:17 2022-10-09 19:32:17 03be685c-378b-4736-8b08-a67c1d***** [INFO] Handle PreStop: 03be685c-378b-4736-8b08-a67c1d*****
2022-10-09 19:32:17 2022-10-09 19:32:17 03be685c-378b-4736-8b08-a67c1d***** [INFO] PreStop end
2022-10-09 19:32:17 FC PreStop End RequestId: 03be685c-378b-4736-8b08-a67c1d*****

サンプルプログラム

Function Computeは、Initializerフックを呼び出すためのサンプルプログラムを提供します。サンプルプログラムでは、Goランタイム環境でInitializerフックを使用してMySQL接続プールを初期化する方法の例を示します。サンプルプログラムでは、関数の環境変数を使用してMySQLデータベースを構成します。詳細については、s.yamlファイルをご参照ください。 Initializerフックは、環境変数に基づいてデータベース構成を取得し、MySQL接続プールを作成してから、接続をテストします。

詳細については、「go-initializer-mysql」をご参照ください。