SFS2X Docs / GettingStarted / admintool-Dashboard
» Dashboard module
The AdminTool's Dashboard module shows the fundamental status indicators that administrators should keep under control when monitoring the SmartFoxServer 2X behavior at runtime.
A video tutorial showing the runtime monitoring features of SmartFoxServer is also available in our YouTube channel.
» Global server status
The following information is available in the Global server status tab.
» Server uptime
The timer shows how long the server has been running since it was started the last time. The same information is also available in the AdminTool's header.
» CPUs usage
The diagram shows the realtime usage, in percentage, of the available CPU cores. It tells you how busy is the server at the moment: the server starts to get very busy when many concurrent requests are sent and it has to quickly respond to all of them.
» Memory usage
This diagram shows current memory usage in the Java Virtual Machine.
» Threads count and Active threads
The diagram and in particular the data table below it show the number of threads currently running and the CPU time occupied by each of them. This panel can be useful to check if your custom Extension is generating an uncontrolled number of threads causing a degradation in the server performance.
» Network traffic and Traffic details
The Network traffic diagram offers a live view of both the incoming and outgoing data transfer rates of the server. Click on the Last 24h option to switch the traffic diagram from realtime to average values calculated over 5 minutes time spans. This diagram also shows the historical data collected by the server in the previous 24 hours.
Use the handles below the chart to change the visualized time frame.
Click on the Realtime option to go back to the realime diagram.
On the right side of the Network traffic diagram, the Traffic details are displayed.
- Sessions (total): the number of total sessions established by clients.
- Sessions (split): the total number of sessions divided between socket and http (through the BlueBox service) connections.
- Sessions (maximum): the maximum number of sessions reached since SmartFoxServer was started.
- Users (total): the total number of clients connected to the server which performed a successful login (including Non-Player Characters).
- Users (split): the total number of connected users divided according to the connection type (socket or http via BlueBox); the number of NPC generated internally by the server-side Extensions is also displayed.
The number of logged in users is usually higher than the sessions number, because sessions include those client which still have to perform the login process.
- Users (maximum): the maximum number of logged users reached since SmartFoxServer was started.
- Rooms (total): the total number of Rooms currently existing in the system (both regular and game Rooms).
- Rooms (split): the total number of Rooms currently existing in the system divided according to their type (regular or game Rooms).
- Transferred data: the total amount of outgoing and incoming data transferred between the server and the clients since the server was started.
- Current data transfer rate: the current per-second data transfer rate, both outgoing and incoming.
- Average data transfer rate: the average per-second data transfer rate since the server was started, both outgoing and incoming.
- Current data transfer rate: the current data transfer rate, both incoming and outgoing.
- Dropped packets: the total number of dropped packets since the server was started, both incoming and outgoing. In particular stress conditions or bad network performance the server may drop messages to preserve performance and system memory. For example, when the maximum amount of queued outgoing messages is reached, the server will start dropping. In normal conditions dropped messages are very rare, however if their number becomes consistent it could be the symptom of a lack of bandwidth. Read this troubleshooting document for more information on dropped messages.
» Message queues status
The following information is available in the Message queues status tab.
The colors of the average value bars give an immediate visual feedback of the queues status. Please note that the average values and the queue load are calculated over the last 240 measurements provided by the server (the same displayed by the charts), as no historical data is available (see note 2 below).
» System workload
This indicator shows the current and average overall load of the system based on the weighted mean of the other three diagrams converted to a percentage value.
» Outgoing messages queue
This diagram shows the current and average size of the system's queue containing the messages to be delivered to the clients. The diagram title also shows the current number of threads processing the queue.
Please note that the diagram doesn't take the messages sent over websocket channels into account.
» System Controller requests queue
This diagram shows the current and average size of the system's queue containing the incoming requests to be processed by the SFS2X System Controller. The diagram title also shos the current number of threads processing the queue.
» Extension Controller requests queue
This diagram shows the current and average size of the system's queue containing the incoming Extension requests to be processed by the SFS2X Extension Controller. The diagram title also show the current number of threads processing the queue.
Data displayed by this module is not updated in realtime, but a refresh rate can be selected in the Interval dropdown at the top-right corner of the module; two seconds is the default value.
The Reset realtime charts button clears all the charts, except the 24h Network traffic one. For example this can be useful to start monitoring a load testing session removing all previous data.
All diagrams, except the 24h Network traffic, do not show historical data: if the module is left and then loaded again, diagrams will be reset.