...
Connection | Connections to the WCS server |
---|---|
connections | Overall number of connections |
connections_rtmfp | Number of RTMFP connections (Flash) |
connections_websocket | Number of WebSocket connections |
Port | Ports listened by the WCS server |
ports_media_free | Free media ports |
ports_media_busy | Busy media ports |
ports_media_quarantine | Media ports in quarantine |
ports_wcs_agents_free | Free CDN used ports |
ports_wcs_agents_busy | Busy CDN used ports |
ports_wcs_agents_quarantine | CDN used ports in quarantine |
Stream | Audio and video stream sessions on the WCS server |
streams_rtsp_in | Number of active RTSP sessions sending traffic |
streams_rtsp_out | Number of active RTSP sessions receiving traffic |
streams_websocket_out | Number of active streams played by WebSocket |
streams_rtmp_out | Number of active RTMP streams |
streams_webrtc_in | Number of active streams published via WebRTC |
streams_webrtc_out | Number of active streams played via WebRTC |
streams_rtmfp_in | Number of active streams published via RTMFP |
streams_rtmfp_out | Number of active streams played via RTMFP |
streams_viewers | Number of active clients playing published streams |
streams_synchronization | Streams published synchronization |
Native resources | Information about resource usage |
native_resources | Information about encoding/decoding of the media stream |
Core | System parameters (obtained using Java methods) and parameters of the WCS server |
core_threads | Number of active threads of the WCS server process |
core_java_threads | Current number of live threads |
core_java_committedMemory | Amount of guaranteed available virtual memory, in bytes |
core_java_freePhysicalMemorySize | Amount of free physical memory, in bytes |
core_java_arch | Operating system architecture |
core_java_availableProcessors | Number of processors available for the Java virtual machine |
core_java_freeSwapSpaceSize | Amount of free swap space, in bytes |
core_java_maxFileDescriptorCount | Maximum number of file descriptors |
core_java_open_file_descriptors | Number of file descriptors opened in the Java virtual machine |
core_java_cpu_usage | "Recent CPU usage" for a process in the Java virtual machine |
core_java_totalPhysicalMemorySize | Amount of physical memory, in bytes |
core_java_totalSwapSpaceSize | Amount of swap space, in bytes |
core_java_uptime | Uptime since Java virtual machine started, in milliseconds |
core_heap_memory_used | Heap memory usage |
core_rss_memory | Memory usage |
core_open_file_descriptors | Number of opened file descriptors |
core_cpu_usage | CPU time percentage used by processes |
core_gc | Information about "garbage collecting" |
core_gc_manager | Information about "garbage collecting" in the Manager |
core_heap_memory_used | Heap memory used |
core_java_committedMemory | Heap memory committed |
core_java_version | Java version |
Call | SIP calls on the WCS server |
sip_calls | Number of SIP calls |
sip_calls_established | Number of active SIP calls |
sip_calls_in | Number of incoming SIP calls |
sip_calls_out | Number of outgoing SIP calls |
sip_calls_per_second (cps) | Number of SIP calls per minute |
SIP | |
sip_registered | Number of client in the REGISTERED state |
Recording | Audio and video file recording |
recording_sessions | Number of active recording sessions |
System | system parameters |
system_java_cpu_usage | "Recent CPU usage" for the entire system (obtained using Java methods) |
system_java_load_average | Average system load for the last minute (obtained using Java methods) |
system_uptime | Uptime since starting of the Linux server |
system_memory_total | Available RAM, in kilobytes |
system_memory_free | Amount of physical RAM not used by the system, in kilobytes |
system_cpu_usage | CPU time percentage used by the processes of the core |
Network Stats (Mbit/s) | Network traffic statistics |
global_bandwidth_in | Incoming connection channel bandwidth |
global_bandwidth_out | Outgoing connection channel bandwidth |
Version info | WCS version info |
wcs_version | Current version of the WCS server |
wcs_client_version | Current version of the WCS API |
Errors info | Error information (obtained based on caught Java exceptions) |
java.io.IOException | Number of IO errors |
java.lang.ArrayIndexOutOfBoundsException | Number of array out of bounds errors |
java.lang.IllegalArgumentException | Number of invalid function argument errors |
com.flashphoner.server.license.activation.A.C | Number of errors while activating the license |
java.lang.NullPointerException | Number of null pointer jump errors |
Degraded streams | Degraded streams information |
degraded_streams | Degraded streams quantity |
degraded_streams_percent | Degraded streams percentage of total number of streams on server |
Transcoding stats | Streams transcoding information |
transcoding_video_decoding_resolutions | List of resolutions decoded in "resolution/streams count" form |
transcoding_video_decoding_average_time | Average decoding time in "resolution/time, ms" form |
transcoding_video_decoding_max_time | Maximum decoding time in "resolution/time, ms" form |
transcoding_video_decoding_average_queue_size | Average decoding queue size in "resolution/queue size" form |
transcoding_video_decoding_max_queue_size | Maximum decoding queue size in "resolution/queue size" form |
transcoding_video_encoding_resolutions | List of resolutions encoded in "resolution/streams count" form |
transcoding_video_encoding_average_time | Average encoding time in "resolution/time, ms" form |
transcoding_video_encoding_max_time | Maximum encoding time in "resolution/time, ms" form |
transcoding_video_encoding_average_queue_size | Average encoding queue size in "resolution/queue size" form |
transcoding_video_encoding_max_queue_size | Maximum encoding queue size in "resolution/queue size" form |
transcoding_video_decoding_load | Integral decoding load value |
transcoding_video_encoding_load | Integral encoding load value |
Transcoding video full info | Stream transcoding details (JSON format only) |
Buffer stats | Pacer buffer usage information (JSON format only) |
CDN stats | CDN information |
cdn_version | CDN version supported by server |
cdn_role | Server role in CDN |
cdn_group | CDN group server belongs to |
Custom stats | Parameters collected with custom script |
Every parameter can be requested separately, for example:
...
- buffer_output_audio_average - audio frames in buffer average count by all subscribers
- buffer_output_video_average - video frames in buffer average count by all subscribers
- buffer_output_audio - audio frames in buffer count for the subscriber
- buffer_output_video - video frames in buffer count for the subscriber
- overflows - buffer overflows count, the buffer is cleared after each overflow
Parameters collected with custom script
Since build 5.2.579 it is possible to collect statistics data unavalable from within JVM using an external custom script.
Script name shold be set by the following parameter
Code Block | ||
---|---|---|
| ||
custom_stats_script=/path/to/custom_stats.sh |
By default, if script name only is specified, the script should be placed to /usr/local/FlashphonerWebCallServer/bin folder
The script should return parameters as follows
Code Block | ||
---|---|---|
| ||
key1=value1
key2=value2
... |
The script example returning Java version and last line from GC log
Code Block | ||||
---|---|---|---|---|
| ||||
#!/bin/bash
ver=$(java -version 2>&1 | grep "version")
echo "java_ver=$ver"
gc_log=$( ls -t /usr/local/FlashphonerWebCallServer/logs/gc-core* | head -1)
echo "gc=$(tail -n1 $gc_log)"
exit 0 |
This script will add to the statistics page the following data
Code Block | ||
---|---|---|
| ||
-----Custom info-----
java_ver=java version "1.8.0_181"
gc=2020-04-17T12:24:03.430+0700: 643.627: [GC (Allocation Failure) 2020-04-17T12:24:03.430+0700: 643.627: [ParNew: 34632K->910K(38080K), 0.0039108 secs] 58661K->24939K(122752K), 0.0041517 secs] [Times: user |
Parameters returned by the script are available in all statistics formats.
Note that using it is not allowed to use pauses, long or high load operations in the script because this adds more latency to statistics output.