RTMP/E
getActiveVHostStats([verbose]:Boolean) : Object
HTTP
http://www.example.com:1111/admin/getActiveVHostStats?auser=username&apswd=password[&verbose=value][&adaptor=name]
Returns aggregate performance data for all instances for all applications for the active virtual hosts on any active core processes. To return data for virtual hosts on an adaptor, use the optional adaptor parameter. Whenever a virtual host functions among multiple cores, this method displays the statistics for the active core processes. Only server administrators can call this method.
Availability
Flash Media Server 3.0
Parameters
verbose
Boolean; true displays the statistics for the applications running on the active virtual host along with the aggregate statistics for the virtual host; false displays only the aggregate statistics of the active virtual host and not the statistics per virtual host. The default value is true.
auser
A String indicating the user name of the administrator.
apswd
A String indicating the password of the administrator.
adaptor
A String indicating the user name of the adaptor. If not specified, the value is _defaultRoot_.
Returns
RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object containing the active virtual host performance data. The data object has the following properties:
Property |
Description |
|---|---|
msg_in |
Number; total number of messages processed by this virtual host. |
msg_out |
Number; total number of messages sent by this virtual host. |
msg_dropped |
Number; total number of messages dropped by this virtual host. |
bytes_in |
Number; total number of bytes read by this virtual host. |
bytes_out |
Number; total number of bytes written by this virtual host. |
accepted |
Number; total number connections accepted by this virtual host. |
rejected |
Number; total number of connections rejected by this virtual host. |
connected |
Number; total number of connections currently active. |
total_apps |
Number; total number of applications that have been created. |
total_connects |
Number; total number of connections to the server. |
total_disconnects |
Number; total number of disconnections from the server. |
total_instances_loaded |
Number; total number of instances that have been loaded. This property does not represent the total number of active instances loaded. To get the number of active instances loaded, subtract the value of total_instances_unloaded from total_instances_loaded. |
total_instances_unloaded |
Number; total number of instances that have been unloaded. |
bw_in |
Number; current bandwidth in, in bytes per second. |
bw_out |
Number; current bandwidth out, in bytes per second. |
server_bytes_in |
Number; total number of rtmp bytes read by an SSAS NetConnection |
server_bytes_out |
Number; total number of rtmp bytes sent by an SSAS NetConnection |
tunnel_bytes_in |
Number; total number of bytes read through the tunnel. |
tunnel_bytes_out |
Number; total number of bytes written through the tunnel. |
tunnel_requests |
Number; number of current requests. |
tunnel_idle_requests |
Number; number of currently idle requests. |
tunnel_idle_responses |
Number; number of currently idle responses. |
normal_connects |
Number; total number of normal connections. |
virtual_connects |
Number; total number of connections through a remote edge. |
group_connects |
Number; total number of remote edges that are connected. |
service_connects |
Number; total number of service connections. |
service_requests |
Number; total number of services requested. |
admin_connects |
Number; total number of administrator connections. |
debug_connects |
Number; total number of debug connections. |
swf_verification_attempts |
A counter of the number of SWF verification attempts made. Represents the total SWF verification credentials passed to the server for checking. There may be more than one credential presented per connection. |
swf_verification_exceptions |
A counter of the number of SWF verification exceptions made. Exceptions are allowed through explicit configuration in the Application.xml file that allows certain user agents to bypass the requirement for SWF verification. Every connection allowed as an exception is counted here. |
swf_verification_failures |
A counter of the number of SWF verification failures. Failures result from the presentation of SWF verification credentials that are found not to be a match for any loaded credential. Each failure corresponds to a disconnection of the presenting connection. |
swf_verification_unsupported_rejects |
A counter of the number of SWF verification unsupported rejections. When a version of Flash Player that doesn’t support SWF verification connects to an application that requires SWF verification, the unsupported rejection count is increased. Also, the connecting client is disconnected. |
swf_verification_matches |
A counter of the total number of matches. When an authentic SWF verification credential is presented, this number increases. There may be more than one match per connection. |
swf_verification_remote_misses |
A counter of the proxy/remote server process’s missed SWF verification attempts. Whenever a proxy/remote server receives a SWF verification attempt it looks to its local cache for valid SWF verification. If it does not locate a match it logs a remote miss and defers to the origin to answer the verification attempt. |
If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.
HTTP
If the call succeeds, it returns XML with the following structure:
<result> <level></level> <code></code> <timestamp></timestamp> <data></data> </result>Nested in the data element are elements with each of the properties listed in the RTMP/E returns section.
If the call fails, it returns something like the following:
<result> <level>error</level> <code>Admin.API.InvalidMethod</code> <description>getactivevhoststatss - No such method found!</description> <timestamp>9/13/2007 7:55:58 PM</timestamp> </result>Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).
