• Examples (iOS)
• Examples (Android)
• Examples (C++)
Server API Documentation

 

» 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.

Runtime Statistics module - global status

» 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.

Network traffic 24h diagram

On the right side of the Network traffic diagram, the Traffic details are displayed.

» 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).

Runtime Statistics module - system queues status

» 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.

NOTE 1
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.

NOTE 2
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.

 

« back to AdminTool