Node.jsのagent.maxSocketsプロパティとは？使い方と設定例を解説

Node.jsのagent.maxSocketsプロパティは、HTTPエージェントがオリジン（ホストとポートの組み合わせ）ごとに同時に開くことができるソケットの最大数を定義するものです。デフォルト値はInfinity（無制限）に設定されており、同時接続数に上限がない状態になっています。このプロパティはNode.js標準の「http」モジュールに含まれる機能の一つです。

syntax（構文）

agent.maxSockets: number

パラメータ

• number（数値） – エージェントが保持できる同時接続ソケットの最大数を指定します。デフォルト値はInfinityです。

maxSocketsのポイント

値を適切に設定することで、サーバーへの同時リクエスト数を制御できます。特に高負荷なアプリケーションや外部APIを多数呼び出す場合、同時接続数を制限することで、相手側サーバーへの負荷を抑えたり、リソースの枯渇を防いだりする効果があります。

使用例

まず「maxSockets.js」という名前のファイルを作成し、以下のコードをコピーしてください。ファイル作成後、次のコマンドでコードを実行します。

node maxSockets.js

maxSockets.js

// agent.maxSockets メソッドのデモ例

// httpモジュールとagentkeepaliveモジュールをインポート
const http = require('http');
const agent = require('agentkeepalive');

const keepaliveAgent = new agent({
    maxSockets: 100,
    maxFreeSockets: 10,
    timeout: 60000, // アクティブなソケットを60秒間キープアライブ
    freeSocketTimeout: 30000, // 空きソケットを30秒間キープアライブ
});

const options = {
    host: 'tutorialspoint.com',
    port: 80,
    path: '/',
    method: 'GET',
    agent: keepaliveAgent,
};
console.log("Max free sockets: ", keepaliveAgent.maxSockets);
console.log('[%s] agent status changed: %j', Date(),
keepaliveAgent.getCurrentStatus());

実行結果

C:\home\node>> node maxSockets.js
Max sockets: 100
[Fri Apr 30 2021 12:28:24 GMT+0530 (India Standard Time)] agent status
changed:
{"createSocketCount":0,"createSocketErrorCount":0,"closeSocketCount":0,"errorSocketCount":0,"timeoutSocketCount":0,"requestCount":0,"freeSockets":{},"sockets":{},"requests":{}}

この例では、maxSockets: 100を指定しているため、コンソールには「Max sockets: 100」と表示されます。また、getCurrentStatus()メソッドを使うことで、作成されたソケット数、エラー数、タイムアウト数、空きソケットなどのエージェントの現在のステータスをJSON形式で確認できます。