Reliable Services 使用

[アーティクル]
06/01/2023

Azure Service Fabric アプリケーションには、コードを実行する 1 つ以上のサービスが含まれています。ここでは、 Reliable Servicesを使用して、ステートレスとステートフルの両方の Service Fabric アプリケーションを作成する方法を説明します。

このページで、ステートレス Reliable Service を作成する方法についての説明も含まれたトレーニングビデオを確認してください。

基本的な概念

Reliable Services の使用を開始するには、いくつかの基本的な概念を理解する必要があります。

サービスの種類: 使用するサービス実装です。 StatelessService を拡張する記述したクラスと、そこで使用する他のコードまたは依存関係のほか、名前やバージョン番号によって定義されます。
名前付きサービスインスタンス: サービスを実行するには、サービスの種類の名前付きインスタンスを作成します。これは、クラスの種類のオブジェクトインスタンスを作成するのに似ています。サービスインスタンスの名前は、"fabric:/MyApp/MyService" のように、"fabric:/" スキームを使用した URI の形式になります。
サービスホスト: 作成した名前付きサービスインスタンスは、ホストプロセス内で実行する必要があります。サービスホストは単なる 1 プロセスで、ここでサービスのインスタンスを実行できます。
サービス登録: 登録はすべてを 1 つにまとめます。サービスホストでサービスの種類を Service Fabric ランタイムに登録して、Service Fabric がそのインスタンスを作成して実行できるようにする必要があります。

ステートレスサービスの作成

ステートレスサービスは、クラウドアプリケーションで現在基準となっている種類のサービスです。ステートレスと見なされるのは、確実に格納する必要があるデータや高可用性を実現する必要があるデータが、サービス自体には含まれていないためです。ステートレスサービスのインスタンスが終了すると、すべての内部状態が失われます。この種類のサービスでは、高可用性と高い信頼性を実現するために、Azure テーブルや SQL Database などの外部ストアに状態を格納する必要があります。

Visual Studio 2017 または Visual Studio 2019 を管理者として起動し、HelloWorld という名前の新しい Service Fabric アプリケーションプロジェクトを作成します。

[新しいプロジェクト] ダイアログを使用して新しい Service Fabric アプリケーションを作成する

次に、 .NET Core 2.0 を使用して、HelloWorldStateless という名前のステートレスサービスプロジェクトを作成します。

2 番目のダイアログボックスでステートレスサービスプロジェクトを作成する

これで、ソリューションには、次の 2 つのプロジェクトが含まれています。

HelloWorld。これはサービスを含むアプリケーション プロジェクトです。また、アプリケーションを説明するアプリケーションマニフェストと、アプリケーションをデプロイするのに役立つ多くの PowerShell スクリプトも含まれます。
HelloWorldStateless。これはサービスプロジェクトです。ステートレスサービスの実装が含まれています。

サービスの実装

サービスプロジェクト内にある HelloWorldStateless.cs ファイルを開きます。 Service Fabric では、どのようなビジネスロジックもサービスで実行できます。サービス API には、コードのエントリポイントが 2 つあります。

RunAsyncという変更可能なエントリポイントメソッドでは、実行時間の長いコンピューティングワークロードなどの任意のワークロードの実行を開始できます。

protected override async Task RunAsync(CancellationToken cancellationToken)
{
    ...
}

選択した通信スタック (ASP.NET Core など) を接続できる通信エントリポイント。これは、ユーザーおよびその他のサービスからの要求の受信を開始できる場所です。

protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
{
    ...
}

このチュートリアルでは、 RunAsync() エントリポイントメソッドを取り上げます。これは、コードの実行をすぐに開始できる場所です。プロジェクトテンプレートには、ローリングカウントをインクリメントする RunAsync() の実装例が含まれます。

Note

通信スタックを使用する方法の詳細については、ASP.NET Core とのサービス通信に関するページを参照してください。

RunAsync

protected override async Task RunAsync(CancellationToken cancellationToken)
{
    // TODO: Replace the following sample code with your own logic
    //       or remove this RunAsync override if it's not needed in your service.

    long iterations = 0;

    while (true)
    {
        cancellationToken.ThrowIfCancellationRequested();

        ServiceEventSource.Current.ServiceMessage(this.Context, "Working-{0}", ++iterations);

        await Task.Delay(TimeSpan.FromSeconds(1), cancellationToken);
    }
}

プラットフォームは、サービスのインスタンスが配置され実行準備ができたときに、このメソッドを呼び出します。ステートレスサービスの場合、これは単にサービスインスタンスが開いたことを意味します。サービスインスタンスを終了する必要がある場合のために、キャンセルトークンが提供されています。 Service Fabric では、サービスインスタンスの開始から終了のサイクルは、サービスのライフタイムで何度も発生する可能性があります。これは、さまざまな理由で発生する可能性があります。

システムがリソース分散のためにサービスインスタンスを移動している。
コードでエラーが発生している。
アプリケーションまたはシステムがアップグレードされている。
基礎となるハードウェアで障害が発生している。

この調整は、サービスの可用性を高めて適切なバランスを取るために、システムによって管理されます。

RunAsync() は同期的なブロックを行いません。 RunAsync の実装では、タスクを返すか、長時間にわたって実行される操作またはブロック操作を待機して、ランタイムを続行できるようにします。前の例の while(true) ループでは、タスクを返す await Task.Delay() が使用されています。ワークロードで同期的にブロックする必要がある場合は、RunAsync 実装で Task.Run() を使用して新しいタスクをスケジュールする必要があります。

ワークロードの取り消しは、提供されたキャンセルトークンを使用して協調的に調整されます。システムはタスクが完了 (正常に完了、キャンセル、または失敗) するまで待機してから、次に進みます。システムからキャンセルが要求された場合は、キャンセルトークンを利用して作業を完了し、できるだけ早く RunAsync() を終了することが重要です。

このステートレスサービスの例では、カウントはローカル変数に格納されます。これはステートレスサービスであるため、保存される値は、サービスインスタンスの現在のライフサイクルのみで保持されます。このサービスを移動または再起動すると、値は失われます。

ステートフルサービスの作成

Service Fabric には、新しい種類のステートフルなサービスが導入されています。ステートフルサービスは、サービス内に状態を確実に維持でき、それを使用するコードと同じ場所に配置できます。 Service Fabric によって状態の可用性が高まるため、外部ストアに状態を維持する必要がなくなります。

サービスが移動または再起動した場合でも、カウンター値をステートレスから高可用と永続性に変換するには、ステートフルサービスが必要です。

先ほどと同じ HelloWorld アプリケーションで、アプリケーションプロジェクトの [サービス] を右クリックし、[追加] -> [新しい Service Fabric サービス] を選択することで、新しいサービスを追加できます。

Service Fabric アプリケーションにサービスを追加します。

[.NET Core 2.0] -> [ステートフルサービス] の順に選択し、HelloWorldStateful という名前を付けます。 [OK] をクリックします。

[新しいプロジェクト] ダイアログを使用して新しい Service Fabric のステートフルサービスを作成する

これで、アプリケーションには、ステートレスサービス HelloWorldStateless とステートフルサービス HelloWorldStateful の 2 つのサービスが含まれるようになります。

ステートフルサービスのエントリポイントは、ステートレスサービスと同じです。主な違いは、状態プロバイダーを使用して状態を確実に保存できることです。 Service Fabric には、Reliable Collection という状態プロバイダー実装が用意されています。Reliable Collection では、Reliable State Manager を使用してレプリケートされたデータ構造を作成できます。ステートフル Reliable Service では、この状態プロバイダーを既定で使用します。

HelloWorldStateful で、次の RunAsync メソッドを含む HelloWorldStateful.csを開きます。

protected override async Task RunAsync(CancellationToken cancellationToken)
{
    // TODO: Replace the following sample code with your own logic
    //       or remove this RunAsync override if it's not needed in your service.

    var myDictionary = await this.StateManager.GetOrAddAsync<IReliableDictionary<string, long>>("myDictionary");

    while (true)
    {
        cancellationToken.ThrowIfCancellationRequested();

        using (var tx = this.StateManager.CreateTransaction())
        {
            var result = await myDictionary.TryGetValueAsync(tx, "Counter");

            ServiceEventSource.Current.ServiceMessage(this.Context, "Current Counter Value: {0}",
                result.HasValue ? result.Value.ToString() : "Value does not exist.");

            await myDictionary.AddOrUpdateAsync(tx, "Counter", 0, (key, value) => ++value);

            // If an exception is thrown before calling CommitAsync, the transaction aborts, all changes are
            // discarded, and nothing is saved to the secondary replicas.
            await tx.CommitAsync();
        }

        await Task.Delay(TimeSpan.FromSeconds(1), cancellationToken);
    }

RunAsync

RunAsync() は、ステートフルサービスとステートレスサービスで同様に動作します。ただし、ステートフルサービスでは、プラットフォームは、 RunAsync()を実行する前に、ユーザーに代わって追加の作業を行います。この作業には、Reliable State Manager と Reliable Collection が使用できる状態にあることの確認が含まれる場合があります。

Reliable Collection と Reliable State Manager

var myDictionary = await this.StateManager.GetOrAddAsync<IReliableDictionary<string, long>>("myDictionary");

IReliableDictionary は、サービスに状態を確実に格納するために使用できるディクショナリ実装です。 Service Fabric と Reliable Collection を使用すると、データをサービスに直接格納できるため、外部の永続ストアが必要ありません。 Reliable Collection により、データの可用性が向上します。 Service Fabric では、サービスの複数の レプリカ を作成して管理することでこれを実現します。また、これらのレプリカとその状態遷移の管理の複雑さを取り除く API も提供します。

Reliable Collection にはカスタム型を含むすべての .NET 型を格納できます。ただし次の点にご注意ください。

Service Fabric がノード全体で状態をレプリケートして状態の可用性を高め、Reliable Collection が各レプリカでデータをローカルディスクに保存します。これは、Reliable Collection で保存されるすべてのデータはシリアル化可能である必要があることを意味します。既定では、Reliable Collection は DataContract を使用してシリアル化します。そのため、既定のシリアライザーを使用する場合は、使用する型がデータコントラクトシリアライザーでサポートされていることを確認することが重要です。
Reliable Collection でトランザクションをコミットすると、可用性が高めるためにオブジェクトがレプリケートされます。 Reliable Collection に格納されるオブジェクトは、サービスのローカルメモリに保持されます。これは、オブジェクトへのローカルな参照があることを意味します。

トランザクションの Reliable Collection を更新せずに、これらのオブジェクトのローカルインスタンスを変更しないようにしてください。オブジェクトのローカルインスタンスの変更は自動的にレプリケートされないためです。オブジェクトをディクショナリに再挿入するか、ディクショナリで update メソッドのいずれかを使用する必要があります。

Reliable Collection の管理は Reliable State Manager が行います。サービス内のどの場所でも、Reliable Collection の名前を指定することで、Reliable State Manager に Reliable Collection をいつでも要求できます。 Reliable State Manager により、参照を確実に取得できます。 Reliable Collection インスタンスへの参照をクラスメンバー変数やプロパティに保存することはお勧めしません。サービスのライフサイクル中、参照が常にインスタンスに設定されていることを保証するために特に注意を払う必要があります。この作業は Reliable State Manager によって処理され、繰り返されるアクセスのために最適化されます。

トランザクション処理と非同期処理

using (ITransaction tx = this.StateManager.CreateTransaction())
{
    var result = await myDictionary.TryGetValueAsync(tx, "Counter-1");

    await myDictionary.AddOrUpdateAsync(tx, "Counter-1", 0, (k, v) => ++v);

    await tx.CommitAsync();
}

Reliable Collection には、統合言語クエリ (LINQ) を除き、対応する System.Collections.Generic と System.Collections.Concurrent が実行する操作と同じ操作が多数あります。 Reliable Collection での操作は非同期です。 Reliable Collection での書き込み操作では、データをレプリケートしてディスクに保持するために I/O 操作が実行されるためです。

Reliable Collection の操作は トランザクションであるため、複数の Reliable Collection と操作で状態の整合性を維持できます。たとえば、1 つのトランザクション内で Reliable Queue から作業項目をデキューし、その項目の操作を実行してから、結果を Reliable Dictionary に保存するとします。これはアトミック操作として扱われので、操作全体が成功するか、操作全体がロールバックされることが保証されます。項目をデキューしたが、結果を保存する前にエラーが発生した場合は、トランザクション全体がロールバックされ、項目は処理のためにキューに残ります。

アプリケーションの実行

HelloWorld アプリケーションに戻ります。ここからサービスを構築してデプロイできます。 F5キーを押すと、アプリケーションがビルドされ、ローカルクラスターにデプロイされます。

サービスが開始されたら、生成された Event Tracing for Windows (ETW) イベントを [診断イベント] ウィンドウで確認できます。アプリケーションのステートレスサービスとステートフルサービスの両方のイベントが表示されるのでご注意ください。 [一時停止] ボタンをクリックして、ストリームを一時停止できます。その後、メッセージを展開して、メッセージの詳細を調べることができます。

Note

アプリケーションを実行する前に、ローカル開発クラスターが実行されていることを確認します。ローカル環境の設定については、ファーストステップガイドをご覧ください。

Visual Studio で診断イベントを表示する