Reliable Services のライフサイクルの概要

Azure Service Fabric Reliable Services のライフサイクルについて考える際には、ライフサイクルの基本が最も重要です。 一般に、ライフサイクルには次が含まれます。

• スタートアップ時
  • サービスが構築されます。
  • サービスは 0 個以上のリスナーを構築して返すことができます。
  • 返されたリスナーはすべて開かれて、サービスとの通信が許可されます。
  • サービスの RunAsync メソッドが呼び出され、実行に長時間かかるタスクやバックグラウンド作業が可能になります。
• シャットダウン時
  • RunAsync に渡されるキャンセル トークンは取り消され、リスナーが閉じられます。
  • リスナーが閉じた後に、サービス オブジェクト自体が破棄されます。

これらのイベントの順序には、詳細な決まりがあります。 イベントの順序は Reliable Services がステートレスかステートフルであるかによって若干異なる場合があります。 さらに、ステートフル サービスでは、プライマリ スワップのシナリオに対処する必要があります。 このシーケンスでは、サービスがシャットダウンすることなく、プライマリのロールが別のレプリカに転送 (または別のレプリカから復帰) されます。 最後に、エラーまたは失敗の条件を考慮する必要があります。

ステートレス サービスのスタートアップ

ステートレス サービスのライフサイクルは、わかりやすいものです。 イベントの順序は次の通りです。

1. サービスが構築されます。
2. StatelessService.CreateServiceInstanceListeners() が呼び出され、返されたリスナーはすべて開かれます。 ICommunicationListener.OpenAsync() が各リスナーに呼び出されます。
3. 次に、2 つのことが並行して行われます。
   • サービスの StatelessService.RunAsync() メソッドが呼び出されます。
   • 存在する場合は、サービスの StatelessService.OnOpenAsync() メソッドが呼び出されます。 この呼び出しのオーバーライドは一般的ではありませんが利用可能です。 この時点で、拡張サービス初期化タスクを開始できます。

ステートレス サービスのシャットダウン

ステートレス サービスをシャット ダウンする場合は、同じパターンが逆の順序で実行されます。

1. 開いているすべてのリスナーが閉じられます。 ICommunicationListener.CloseAsync() が各リスナーに呼び出されます。
2. RunAsync() に渡されたキャンセル トークンが取り消されます。 キャンセル トークンの IsCancellationRequested プロパティをチェックすると true が返され、呼び出された場合、トークンの ThrowIfCancellationRequested メソッドは OperationCanceledException をスローします。 Service Fabric は RunAsync() が完了するまで待機します。
3. RunAsync() が完了すると、サービスの StatelessService.OnCloseAsync() メソッドが呼び出されます (存在する場合)。 OnCloseAsync は、ステートレス サービス インスタンスが正常にシャットダウンされるときに呼び出されます。 これは、サービスのコードがアップグレードされるか、サービス インスタンスが負荷分散のために移動されるか、または一時的なエラーが検出されたときに行われる可能性があります。 これは一般的なオーバーライド StatelessService.OnCloseAsync() ではなく、安全にすべてのリソースを閉じたり、バック グラウンド処理を停止したり、外部の状態の保存を完了したり、既存の接続を終了したりすることができます。
4. StatelessService.OnCloseAsync() が完了すると、サービス オブジェクトは破棄されます。

ステートフル サービスのスタートアップ

ステートフル サービスのパターンはステートレス サービスに似ていますが、変更点がいくつかあります。 ステートフル サービスを開始する場合のイベントの順序は次の通りです。

1. サービスが構築されます。

2. StatefulServiceBase.OnOpenAsync() が呼び出されます この呼び出しがサービスでオーバーライドされることはほとんどありません。

3. StatefulServiceBase.CreateServiceReplicaListeners() が呼び出されます。

   • サービスがプライマリ サービスである場合、返されるすべてのリスナーは開かれます。 ICommunicationListener.OpenAsync() が各リスナーに呼び出されます。
   • サービスがセカンダリ サービスである場合、ListenOnSecondary = true とマークされているリスナーのみが開かれます。 開いているリスナーがセカンダリにあるのは、あまり一般的ではありません。

4. 次に、次のことが並行して行われます。

   • サービスが現在プライマリである場合、サービスの StatefulServiceBase.RunAsync() メソッドが呼び出されます。
   • StatefulServiceBase.OnChangeRoleAsync() が呼び出されます この呼び出しがサービスでオーバーライドされることはほとんどありません。

   注

   新しいセカンダリ レプリカの場合は、StatefulServiceBase.OnChangeRoleAsync() が 2 回呼び出されます。 アイドル状態のセカンダリになる手順 2 の後で 1 回と、アクティブ セカンダリになる手順 4 の間にもう 1 回です。 レプリカとインスタンスのライフサイクルの詳細については、レプリカとインスタンスのライフサイクルに関するページをお読みください。

ステートフル サービスのシャットダウン

ステートレス サービスと同様に、シャットダウン中のライフサイクル イベントは起動時と同じですが、順序が逆です。 ステートフル サービスのシャットダウン時には、次のイベントが発生します。

1. 開いているすべてのリスナーが閉じられます。 ICommunicationListener.CloseAsync() が各リスナーに呼び出されます。

2. StatefulServiceBase.OnCloseAsync() メソッドが呼び出されます。 この呼び出しのオーバーライドは一般的ではありませんが利用可能です。

3. RunAsync() に渡されたキャンセル トークンが取り消されます。 キャンセル トークンの IsCancellationRequested プロパティをチェックすると true が返され、呼び出された場合、トークンの ThrowIfCancellationRequested メソッドは OperationCanceledException をスローします。 Service Fabric は RunAsync() が完了するまで待機します。

   注

   このレプリカがプライマリ レプリカの場合にのみ、RunAsync が完了するのを待つ必要があります。

4. StatefulServiceBase.RunAsync() が完了すると、サービス オブジェクトは破棄されます。

ステートフル サービスのプライマリ スワップ

ステートフル サービスの実行中、通信リスナーを開き、RunAsync メソッドを呼び出すのはそのステートフル サービスのプライマリ レプリカだけです。 セカンダリ レプリカは構築されますが、それ以上の呼び出しは行われません。 ステートフル サービスの実行中に、障害やクラスターの負荷分散の最適化の結果として、現在プライマリであるレプリカが変更される場合があります。 レプリカに生じるライフサイクル イベントの観点から見ると、これはどういうことでしょうか。 ステートフルなレプリカに起こる動作は、それがスワップ中に降格されているレプリカであるか、昇格されているものかによって変わります。

降格されているプライマリの場合

降格されているプライマリ レプリカの場合、Service Fabric では、このレプリカでメッセージの処理を終了して、途中のバックグラウンド作業をすべて終了する必要があります。 その結果、この手順はサービスのシャットダウン時と似たものになります。 1 つ違う点は、サービスがセカンダリのままであるために、サービスが破棄されたり閉じられたりしないということです。 次の API が呼び出されます。

1. 開いているすべてのリスナーが閉じられます。 ICommunicationListener.CloseAsync() が各リスナーに呼び出されます。
2. RunAsync() に渡されたキャンセル トークンが取り消されます。 キャンセル トークンの IsCancellationRequested プロパティをチェックすると true が返され、呼び出された場合、トークンの ThrowIfCancellationRequested メソッドは OperationCanceledException をスローします。 Service Fabric は RunAsync() が完了するまで待機します。
3. ListenOnSecondary = true としてマークされたリスナーが開かれます。
4. サービスの StatefulServiceBase.OnChangeRoleAsync() が呼び出されます。 この呼び出しがサービスでオーバーライドされることはほとんどありません。

昇格されているセカンダリの場合

同様に、Service Fabric では、昇格されているセカンダリ レプリカで送信中のメッセージのリッスンを開始して、完了する必要があるバックグラウンド タスクをすべて開始する必要があります。 その結果、レプリカ自体が既に存在している点以外、この手順はサービスの作成時と似たものになります。 次の API が呼び出されます。

1. ICommunicationListener.CloseAsync() は、開いているすべてのリスナー (ListenOnSecondary = true でマークされている) に対して呼び出されます。
2. すべての通信リスナーが開かれます。 ICommunicationListener.OpenAsync() が各リスナーに呼び出されます。
3. 次に、次のことが並行して行われます。
   • サービスの StatefulServiceBase.RunAsync() メソッドが呼び出されます。
   • StatefulServiceBase.OnChangeRoleAsync() が呼び出されます この呼び出しがサービスでオーバーライドされることはほとんどありません。

ステートフル サービスのシャットダウンとプライマリの降格における一般的な問題

Service Fabric は、さまざまな理由でステートフル サービスのプライマリを変更します。 最も一般的な理由は、クラスターの再分散とアプリケーションのアップグレードです。 これらの操作の際 (および通常のサービス シャットダウンの際にサービスが削除されたかどうかを確認する場合) には、サービスが CancellationToken に対応することが重要です。

取り消しを適切に処理しないサービスでは、いくつかの問題が発生する可能性があります。 サービスが正常に停止するのを Service Fabric が待機するため、それらの操作の速度が遅くなります。 最終的には、アップグレードがタイムアウトしてロールバックし、アップグレードに失敗することにつながります。 キャンセル トークンに対応しないことにより、クラスターが不均衡になることもあります。 クラスターが不均衡になる原因は、ノードの負荷が高くなってもサービスの移動に時間がかかるためサービスを分散できないためです。

サービスがステートフルなため、サービスが Reliable Collection を使用する可能性も高くなります。 Service Fabric では、プライマリが降格されたときに最初に発生することの 1 つは、基になる状態への書き込みアクセスの取り消しです。 これは、サービスのライフサイクルに影響を与える第 2 の一連の問題につながります。 レプリカが移動中なのかあるいはシャットダウンされているのかと、そのタイミングに基づいて、コレクションが例外を返します。 これらの例外を正しく処理する必要があります。 Service Fabric によってスローされる例外は、永続的なカテゴリ (FabricException) と一時的なカテゴリ (FabricTransientException) に分類されます。 永続的な例外はログに記録してスローするべきですが、一時的な例外は再試行ロジックに基づいて再試行することもできます。

ReliableCollections とサービスのライフサイクル イベントを組み合わせて使用した結果の例外を処理することは、Reliable Service のテストと検証の重要な部分です。 運用環境にデプロイする前にアップグレードとカオス テストを実行するときは、サービスに常に負荷がかかっている状態で行うことをお勧めします。 このような基本の手順を行うことで、サービスが正しく実装され、ライフサイクル イベントを正しく処理できるようになります。

サービスのライフサイクルに関するメモ

• RunAsync() メソッドおよび CreateServiceReplicaListeners/CreateServiceInstanceListeners の呼び出しは両方とも省略可能です。 サービスには、これらのいずれかまたは両方を含めることも、どちらも含めないこともできます。 例えば、サービスがユーザーの呼び出しに応答してすべての処理を実行する場合、RunAsync() を実装する必要はありません。 通信リスナーおよびそれに関連付けられたコードのみが必要です。 同様に、サービスにはバックグラウンドの作業しかない場合があり、この場合 RunAsync() の実装のみが必要なため、通信リスナーを作成して返す必要はありません。
• サービスは、正常に RunAsync() を完了して戻ることができます。 完了は、エラー条件ではありません。 RunAsync() の完了は、サービスのバックグラウンド処理が完了したことを示します。 ステートフル リライアブル サービスで、レプリカがプライマリからセカンダリへ一度降格して再度プライマリに昇格した場合、RunAsync() が再度呼び出されます。
• サービスが予期しない例外をスローして RunAsync() を終了した場合はエラーです。 サービス オブジェクトがシャットダウンされ、正常性のエラーが報告されます。
• これらのメソッドから制御が戻るときに時間制限はありませんが、Reliable Collection への書き込みはすぐにできなくなるため、実際の処理を完了できません。 取り消し要求を受信したらできるだけ短時間で制御が戻るようにすることをお勧めします。 サービスが適切な時間内にこれらの API 呼び出しに応答しない場合、Service Fabric はサービスを強制的に終了する場合があります。 通常、これはアプリケーションのアップグレード中か、サービスの削除中のみに発生します。 このタイムアウト時間は既定で 15 分です。
• OnCloseAsync() パスで障害が起きると、OnAbort() が呼び出されます。これは、サービスが要求したリソースすべてをクリーンアップし解放するための最後のベストエフォートの機会になります。 これは一般に、ノードで永続的なエラーが検出されたときや Service Fabric が内部エラーのために、サービス インスタンスのライフ サイクルを確実に管理できないときに呼び出されます。
• OnChangeRoleAsync() は、ステートフル サービス レプリカのロールが、プライマリやセカンダリなどに変更されるときに呼び出されます。 プライマリ レプリカには書き込み状態が与えられます (Reliable Collection の作成と Reliable Collection への書き込みが可能)。 セカンダリ レプリカには読み取り状態が与えられます (既存の Reliable Collection からの読み取りのみが可能)。 ステートフル サービスの作業のほとんどは、プライマリ レプリカで実行されます。 セカンダリ レプリカでは、読み取り専用の検証、レポートの生成、データ マイニングなど、読み取り専用のジョブを実行できます。

次のステップ

• Reliable Services 入門
• Reliable Service の概要
• レプリカとインスタンス