Monitoring
Get System Variables
Get system variables and performance metrics
GET
Overview
Get WuKongIM system runtime variables and performance metrics for system monitoring and performance analysis.Query Parameters
string
default:"in_msgs"
Sort field
in_msgs- Sort by received message countout_msgs- Sort by sent message countin_bytes- Sort by received bytesout_bytes- Sort by sent bytes
integer
default:20
Connection information limit count
integer
Specify node ID (cluster environment)
Response Fields
Server Information
string
required
Server identifier
string
required
WuKongIM version number
string
required
Git commit hash
string
required
Go language version
Runtime Information
string
required
Server start time (ISO 8601 format)
string
required
Current time (ISO 8601 format)
string
required
Runtime duration
Connection Statistics
integer
required
Current connection count
integer
required
Total connections (historical cumulative)
integer
required
Number of slow consumers
integer
required
Total subscriptions
Message Statistics
integer
required
Total received messages
integer
required
Total sent messages
integer
required
Total received bytes
integer
required
Total sent bytes
HTTP Request Statistics
object
required
HTTP request statistics
System Resources
number
required
CPU usage (percentage)
integer
required
Memory usage (bytes)
Configuration Information
object
required
System configuration information
Status Codes
Monitoring Metrics Description
Performance Metrics
Throughput Metrics
Best Practices
- Regular Monitoring: Recommended to get system variables every 30-60 seconds
- Alert Setup: Set reasonable alert thresholds for key metrics
- Trend Analysis: Record historical data to analyze system performance trends
- Capacity Planning: Perform capacity planning based on monitoring data
- Performance Optimization: Identify performance bottlenecks and optimize
- Cluster Monitoring: Monitor all node status in cluster environments

