Azure Cosmos DB を ASP.NET セッション状態プロバイダーとキャッシュプロバイダーとして使用する

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

適用対象: NoSQL

Azure Cosmos DB セッションとキャッシュプロバイダーにより、その短い待機時間とグローバルスケール機能を活用して、セッション状態データを格納し、アプリケーション内の分散キャッシュとして Azure Cosmos DB を使用することができます。

セッション状態とは

セッション状態とは、同じブラウザー内で、一定期間に Web アプリケーションを参照しているユーザーを追跡するユーザーデータのことです。セッション状態は有効期限があり、特定のブラウザーによる相互作用に限定され、ブラウザー間には拡張されません。一時的なデータと見なされ、存在しない場合でもアプリケーションは中断されません。ただし、存在する場合は、Web アプリケーションが同じユーザーのブラウザー要求ごとにフェッチする必要がないため、ユーザーのエクスペリエンスが向上します。

多くの場合、これは何らかのストレージメカニズムによって支えられています。これは、場合によっては使用される Web サーバーの外部にあり、同じブラウザーからの要求を複数の Web サーバー間にまたがって負荷分散することで、より高いスケーラビリティを実現します。

最も単純なセッション状態プロバイダーは、ローカル Web サーバーのメモリにのみデータを格納し、アプリケーションがアプリケーション要求ルーティング処理を使用する必要があるメモリ内プロバイダーです。これにより、ブラウザーセッションは特定の Web サーバーに固定されます (そのブラウザーのすべての要求は、常に同じ Web サーバーに配送される必要があります)。プロバイダーは単純なシナリオではうまく機能しますが、Web アプリケーションの規模が拡大したときに、持続性の要件により負荷分散の問題が発生する可能性があります。

多くの外部ストレージプロバイダーが使用可能で、セッションの持続性を必要とせずに、複数の Web サーバーで読み取りおよびアクセスできる方法でセッションデータを格納でき、より高いスケールを実現できます。

セッション状態のシナリオ

Azure Cosmos DB は、拡張パッケージ Microsoft.Extensions.Caching.Cosmos を介して Azure Cosmos DB .NET SDK を利用することで、セッション状態プロバイダーとして使用できます。キーがセッション識別子であるキー/値のアプローチに基づいて効果的なセッションストレージとしてコンテナーを使用します。

パッケージが追加されると、スタートアッププロセスの一部として AddCosmosCache を使用できます (services.AddSession と app.UseSession は、セッション状態プロバイダーに必要な一般的な初期化のステップです)。

public void ConfigureServices(IServiceCollection services)
{
  /* Other service configurations */
  services.AddCosmosCache((CosmosCacheOptions cacheOptions) =>
  {
      CosmosClientBuilder clientBuilder = new CosmosClientBuilder("myConnectionString")
        .WithApplicationRegion("West US");
      cacheOptions.ContainerName = "myContainer";
      cacheOptions.DatabaseName = "myDatabase";
      cacheOptions.ClientBuilder = clientBuilder;
      /* Creates the container if it does not exist */
      cacheOptions.CreateIfNotExists = true; 
  });

  services.AddSession(options =>
  {
      options.IdleTimeout = TimeSpan.FromSeconds(3600);
      options.Cookie.IsEssential = true;
  });
  /* Other service configurations */
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    /* Other configurations */

    app.UseSession();

    /* app.UseEndpoints and other configurations */
}

ここでは、セッション状態を格納するデータベースとコンテナーを指定します。これらが存在しない場合は、CreateIfNotExists 属性を使用して必要に応じて作成します。

重要

CreateIfNotExists を使用する代わりに既存のコンテナーを指定する場合、そのコンテナーの有効期限が切れていないことを確認します。

SDK のクライアント構成は CosmosClientBuilder を使用してカスタマイズすることができます。また、アプリケーションですでに CosmosClient を使用して Azure Cosmos DB との他の操作を行っている場合は、それをプロバイダーに挿入することもできます。

services.AddCosmosCache((CosmosCacheOptions cacheOptions) =>
{
    cacheOptions.ContainerName = "myContainer";
    cacheOptions.DatabaseName = "myDatabase";
    cacheOptions.CosmosClient = preExistingClient;
    /* Creates the container if it does not exist */
    cacheOptions.CreateIfNotExists = true; 
});

その後、他のプロバイダーと同様の ASP.NET Core セッションを使用して、HttpContext.Session オブジェクトを使用できます。 ASP.NET 推奨事項に従って、常にセッション情報を非同期で読み込むようにしてください。

分散キャッシュのシナリオ

Azure Cosmos DB プロバイダーに分散キャッシュプロバイダーとして機能する IDistributedCache インターフェイスが実装されている場合、パフォーマンスが高い分散セッション状態プロバイダーを必要とする Web アプリケーションだけでなく、分散キャッシュを必要とするアプリケーションにも、この Cosmos DB プロバイダーを使用できます。

分散キャッシュでは、独立したインスタンスがキャッシュされたデータを共有できるように、データの整合性が必要です。 Azure Cosmos DB プロバイダーを使用する場合、次のことができます。

アプリケーション要求ルーティング処理を有効にして、特定のインスタンスに対して要求をスティッキーにできる場合は、セッション整合性で Azure Cosmos DB アカウントを使用します。
要求の持続性が必要ないように、有界整合性制約または厳密な整合性で Azure Cosmos DB アカウントを使用してください。これにより、インスタンス全体の負荷分散の観点から最大のスケールを実現します。

Azure Cosmos DB プロバイダーを分散キャッシュとして使用するには、services.AddCosmosCache 呼び出しを使用して ConfiguredService に登録する必要があります。これが完了すると、アプリケーション内の任意のコンストラクターが IDistributedCache の参照によってキャッシュを要求し、使用される依存関係の挿入によって挿入されたインスタンスを受け取ります。

public class MyBusinessClass
{
    private readonly IDistributedCache cache;

    public MyBusinessClass(IDistributedCache cache)
    {
        this.cache = cache;
    }
    
    public async Task SomeOperationAsync()
    {
        string someCachedValue = await this.cache.GetStringAsync("someKey");
        /* Use the cache */
    }
}

トラブルシューティングと診断

適用対象: NoSQL

Azure Cosmos DB プロバイダーでは、基盤になっている .NET SDK を使用しているため、潜在的な問題を理解するには、既存のパフォーマンスガイドラインとトラブルシューティングガイドがすべて適用されます。 IDistributedCache API を通じて公開することはできないため、基になる Azure Cosmos DB 操作から診断にアクセスするための独自の方法があることに注意してください。

オプションの診断デリゲートを登録すると、高待機時間などの状況をトラブルシューティングするために、診断をキャプチャして条件付きでログに記録することができます。

void captureDiagnostics(CosmosDiagnostics diagnostics)
{
    if (diagnostics.GetClientElapsedTime() > SomePredefinedThresholdTime)
    {
        Console.WriteLine(diagnostics.ToString());
    }
}

services.AddCosmosCache((CosmosCacheOptions cacheOptions) =>
{
    cacheOptions.DiagnosticsHandler = captureDiagnostics;
    /* other options */
});

次のステップ

Azure Cosmos DB セッションとキャッシュプロバイダーの詳細については、GitHub のソースコードを参照してください。
「ASP.NET Core Web アプリケーションを探索する」のサンプルを参照して、Azure Cosmos DB セッションとキャッシュプロバイダーを試してみてください。
詳細については、.NET の「分散キャッシュ」を参照してください。

Azure Cosmos DB を ASP.NET セッション状態プロバイダーとキャッシュ プロバイダーとして使用する