MongoDB Server選択をカスタマイズ

Overview

すべてのMongoDBドライバーは、読み取りまたは書き込みのサーバーを選択するときに定義されたアルゴリズムに従います。MongoClientオブジェクトの ClusterConfiguratorプロパティを使用すると、このアルゴリズムをカスタマイズして、サーバーに最適です。

デフォルトのアルゴリズム

.NET/ C#ドライバーが 読み取り操作を実行するとき、 MongoDBデプロイを選択するために、次の手順を順番に実行します。

1. アクティブな読み込み設定 (read preference)に一致するすべてのサーバーを既知のサーバーのリストから選択します。

2. 少なくとも 1 つの読み取り可能なサーバーが存在する場合、ドライバーはユーザー定義のサーバー セレクター関数を呼び出し、前のステップのリストを渡します。

3. 関数から返されるサーバーのリストに LocalThreshold 接続設定を適用します。

4. リストに残っているサーバーからランダムにサーバーを選択し、このサーバーに対して操作を実行します。

.NET/ C#ドライバーが 書込み操作を実行する場合、まず、アクティブな読み込み設定 (read preference)に一致するサーバーだけでなく、すべての書込み可能なサーバーを選択します。残りの手順は同一です。

カスタムサーバー選択アルゴリズムを指定しない場合にドライバーが従うデフォルトのサーバー選択アルゴリズム の詳細については、 MongoDB Serverマニュアルの サーバー選択アルゴリズムを 参照してください。

他のサーバー選択アルゴリズムの指定

サーバーセレクタークラスのインスタンスを ClusterConfigurator の PreServerSelector または PostServerSelectorプロパティに渡すことで、別のサーバー選択ロジックを指定できます。PreServerSelectorプロパティは標準サーバー選択ロジックの実行前に実行されるサーバーセレクターを指定し、PostServerSelectorプロパティは標準サーバー選択ロジックの実行後に実行されるサーバーセレクターを指定します。次に、MongoClientインスタンスを作成してカスタムサーバー選択ロジックを適用するときに、ClusterConfiguratorインスタンスをMongoClientSettingsオブジェクトに渡します。

次の表は、ClusterConfiguratorプロパティに渡すことができるさまざまなタイプのサーバーセレクターを示しています。

次の例では、標準サーバー選択ロジックが実行される前に、RandomServerSelectorクラスを使用してサーバーをランダムに選択するよう MongoClient に指示します。

var settings = MongoClientSettings.FromConnectionString("<connection string>");
var clusterConfigurator = builder =>
{
    builder.ConfigureCluster(c =>
        c.With(PreServerSelector: new RandomServerSelector()));
};
settings.ClusterConfigurator = clusterConfigurator;
var client = new MongoClient(settings);

さまざまなサーバーセレクター クラスの詳細については、ServerSelector APIドキュメントを参照してください。

カスタム サーバー選択ロジックの実装

IServerSelector インターフェースから継承し、 SelectServers() メソッドをオーバーライドするクラスを作成することで、独自のカスタムサーバー選択ロジックを実装できます。次の例では、ServerType が ServerType.ReplicaSetSecondary のサーバーを選択する単純なカスタムサーバー選択クラスを示しています。

public class CustomServerSelector : IServerSelector
{
    public IEnumerable<ServerDescription> SelectServers(ClusterDescription cluster,
        IEnumerable<ServerDescription> servers)
    {
        return servers.Where(server => server.Type == ServerType.ReplicaSetSecondary);
    }
}

次に、「他のサーバー選択アルゴリズムの指定」セクションに示されているように、このクラスのインスタンスをClusterConfiguratorインスタンスの PreServerSelector または PostServerSelectorプロパティに渡すことができます。

設定を使用してサーバー選択を構成する

MongoClientオブジェクトまたは接続 URI で、次のサーバー選択設定を指定できます。

readPreference=primaryPreferred
&maxStalenessSeconds=90
&readPreferenceTags=dc:ny,rack:1

トラブルシューティング

A timeout occurred after 30000ms selecting a server using CompositeServerSelector{ Selectors = MongoDB.Driver.MongoClient+AreSessionsSupportedServerSelector, LatencyLimitingServerSelector{ AllowedLatencyRange = 00:00:00.0150000 }, OperationsCountServerSelector }.
Client view of cluster state is
{
    ClusterId : "1",
    Type : "Unknown",
    State : "Disconnected",
    Servers :
    [{
        ServerId: "{ ClusterId : 1, EndPoint : "Unspecified/localhost:27017" }",
        EndPoint: "Unspecified/localhost:27017",
        ReasonChanged: "Heartbeat",
        State: "Disconnected",
        ServerVersion: ,
        TopologyVersion: ,
        Type: "Unknown",
        HeartbeatException: "<exception details>"
    }]
}.

API ドキュメント

このガイドで使用されているクラスとメソッドの詳細については、次のAPIドキュメントを参照してください。

• MongoClient

• MongoClientSettings

• ClusterConfigurator

• ServerSelectors

• IServerSelector

• SELECTServer()