メインコンテンツへスキップ
バージョン: 4.x

クラスターアダプター

仕組み​

クラスターアダプターは、Node.jsクラスター内でSocket.IOを使用できるようにします。

複数のクライアントに送信されるすべてのパケット（例：io.to("room1").emit()またはsocket.broadcast.emit()）は、IPCチャネルを介して他のワーカーにも送信されます。

このアダプターのソースコードはこちらにあります。

サポートされている機能​

機能socket.ioバージョンサポート
ソケット管理4.0.0✅ はい（バージョン0.1.0以降）
サーバー間通信4.1.0✅ はい（バージョン0.1.0以降）
確認応答付きブロードキャスト4.5.0✅ はい（バージョン0.2.0以降）
接続状態の復旧4.6.0❌ いいえ

インストール​

npm install @socket.io/cluster-adapter

使い方​

Node.jsクラスターでの使用​

const cluster = require("cluster");
const http = require("http");
const { Server } = require("socket.io");
const numCPUs = require("os").cpus().length;
const { setupMaster, setupWorker } = require("@socket.io/sticky");
const { createAdapter, setupPrimary } = require("@socket.io/cluster-adapter");

if (cluster.isMaster) {
  console.log(`Master ${process.pid} is running`);

  const httpServer = http.createServer();

  // setup sticky sessions
  setupMaster(httpServer, {
    loadBalancingMethod: "least-connection",
  });

  // setup connections between the workers
  setupPrimary();

  // needed for packets containing buffers (you can ignore it if you only send plaintext objects)
  // Node.js < 16.0.0
  cluster.setupMaster({
    serialization: "advanced",
  });
  // Node.js > 16.0.0
  // cluster.setupPrimary({
  //   serialization: "advanced",
  // });

  httpServer.listen(3000);

  for (let i = 0; i < numCPUs; i++) {
    cluster.fork();
  }

  cluster.on("exit", (worker) => {
    console.log(`Worker ${worker.process.pid} died`);
    cluster.fork();
  });
} else {
  console.log(`Worker ${process.pid} started`);

  const httpServer = http.createServer();
  const io = new Server(httpServer);

  // use the cluster adapter
  io.adapter(createAdapter());

  // setup connection with the primary process
  setupWorker(io);

  io.on("connection", (socket) => {
    /* ... */
  });
}

PM2での使用​

関連ドキュメントを参照してください。

reclusterでの使用​

cluster.js

const cluster = require("cluster");
const http = require("http");
const { setupMaster } = require("@socket.io/sticky");
const { setupPrimary } = require("@socket.io/cluster-adapter");
const recluster = require("recluster");
const path = require("path");

const httpServer = http.createServer();

// setup sticky sessions
setupMaster(httpServer, {
  loadBalancingMethod: "least-connection",
});

// setup connections between the workers
setupPrimary();

// needed for packets containing buffers (you can ignore it if you only send plaintext objects)
// Node.js < 16.0.0
cluster.setupMaster({
  serialization: "advanced",
});
// Node.js > 16.0.0
// cluster.setupPrimary({
//   serialization: "advanced",
// });

httpServer.listen(3000);

const balancer = recluster(path.join(__dirname, "worker.js"));

balancer.run();

worker.js

const http = require("http");
const { Server } = require("socket.io");
const { setupWorker } = require("@socket.io/sticky");
const { createAdapter } = require("@socket.io/cluster-adapter");

const httpServer = http.createServer();
const io = new Server(httpServer);

// use the cluster adapter
io.adapter(createAdapter());

// setup connection with the primary process
setupWorker(io);

io.on("connection", (socket) => {
  /* ... */
});

オプション​

名前説明デフォルト値
requestsTimeoutfetchSockets()やack付きのserverSideEmit()などのサーバー間リクエストのタイムアウト5000

最新リリース​

バージョンリリース日リリースノート差分
0.2.22022年3月リンク0.2.1...0.2.2
0.2.12022年10月リンク0.2.0...0.2.1
0.2.02022年4月リンク0.1.0...0.2.0
0.1.02021年6月リンク

完全な変更履歴