Monitoring Panel

The @colyseus/monitor is a handy tool that allows you to view and inspect the current list of rooms spawned by the server.

Features

• List all active rooms
  • Force to dispose a specific room
• Inspect a specific room
  • View room’s state
  • Send/broadcast messages for a client
  • Force to disconnect a client.

Install the package

This package is installed by default on new projects created via npm create colyseus-app.

npm install --save @colyseus/monitor

pnpm add @colyseus/monitor

yarn add @colyseus/monitor

bun add @colyseus/monitor

Include it in your project:

import { monitor } from "@colyseus/monitor";
// ...
    initializeExpress: (app) => {
        // bind it as an express middleware
        app.use("/monitor", monitor());
    }
// ...

const monitor = require("@colyseus/monitor").monitor;
// ...
    initializeExpress: (app) => {
        // bind it as an express middleware
        app.use("/monitor", monitor());
    }
// ...

Restrict access to the panel using a password

You can use an express middleware to enable authentication on the monitor route, such as express-basic-middleware:

npm install --save express-basic-auth

pnpm add express-basic-auth

yarn add express-basic-auth

bun add express-basic-auth

Create a user and password using express-basic-auth.

import basicAuth from "express-basic-auth";
 
const basicAuthMiddleware = basicAuth({
    // list of users and passwords
    users: {
        "admin": "admin",
    },
    // sends WWW-Authenticate header, which will prompt the user to fill
    // credentials in
    challenge: true
});
 
app.use("/monitor", basicAuthMiddleware, monitor());

Setting custom room listing columns

app.use("/monitor", basicAuthMiddleware, monitor({
  columns: [
    'roomId',
    'name',
    'clients',
    { metadata: "spectators" }, // display 'spectators' from metadata
    'locked',
    'elapsedTime'
  ]
}));

If unspecified, the default room listing columns are: ['roomId', 'name', 'clients', 'maxClients', 'locked', 'elapsedTime'].