RTMP/E

 getServerStats() : Object

HTTP

 http://www.example.com:1111/admin/getServerStats?auser=username&apswd=password

Retrieves the server status and statistics about the operation of the server. Information reported includes the length of time the server has been running and I/O and message cache statistics.

You must be a server administrator to perform this operation.

If you only need information about the I/O characteristics of the server, use the getIOStats() method instead.

Availability

Flash Communication Server 1.0.

Parameters

auser

A String indicating the user name of the administrator.

apswd

A String indicating the password of the administrator.

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. The data object has the following properties:

Property

Description

cpu_Usage

Number; approximate percentage of CPU in use by the Adobe Media Server processes—not by the entire system. This number includes all the CPUs on the server. For example, on a dual core system, if this value is 100, Adobe Media Server is using approximately 50% on each CPU.

launchTime

ActionScript Date object; time the server was started.

memory_Usage

Number; approximate percentage of total physical system memory in use.

msg_cache

Adobe Media Server message packet cache statistics, returned as an object with the following properties:

allocated: Number; total number of message objects allocated.

reused: Number; total number of objects reused.

size: Number; size of the cache, in number of message packets.

num_cores

Number; total number of core processes.

physical_Mem

Number; total physical memory used by edge and core server processes, in bytes.

server_bytes_in

Number; total number of RTMP bytes read by a Server-Side ActionScript NetConnection.

server_bytes_out

Number; total number of RTMP bytes sent by Server-Side ActionScript NetConnection.

up_time

Number; length of time, in seconds, that the server has been running.

The data object also has an io property. The io property is an object containing the following properties about input and output statistics:

Property

Description

admin_connects

Number; number of admin connections.

bw_in

Number; incoming bandwidth.

bw_out

Number; outgoing bandwidth.

bytes_in

Number; total number of bytes read by the server.

bytes_out

Number; total number of bytes written by the server.

connected

Number; total number of active socket connections to the server.

debug_connects

Number; number of debug connections.

group_connects

Number; number of connected groups.

group_join

Number; the number of requests to join a group.

group_leave

Number; the number of requests to leave a group.

msg_dropped

Number; total number of messages dropped by the server.

msg_in

Number; total number of messages processed by the server.

msg_out

Number; total number of messages sent by the server.

normal_connects

Number; number of Flash Player connections to the server.

reads

Number; total number of system read calls.

rtmfp_forwards

Count of forwards sent to directly connected clients in response to a successful local lookup.

rtmfp_lookups

Number; count of peer lookups performed on behalf of directly connected clients.

rtmfp_redirects

Number; count of redirects sent to directly connected clients in response to a successful local lookup.

rtmfp_remote_forwards

Count of forwards sent to directly connected clients on behalf of another server that handled the initiating lookup (for example, an edge server sends a forward to a client on behalf of a lookup handled at the origin server).

rtmfp_remote_forward_requests

Count of forward requests sent to other servers (e.g. origin performs lookup and sends a forward request to the edge the target client is directly connected to).

rtmfp_remote_lookups

Number; count of peer lookups performed on behalf of a separate server and client (for example, an origin server performing a lookup on behalf of a downstream edge server).

rtmfp_remote_lookup_requests

Number; count of lookup requests sent to an alternate server (for example, an edge server requested that an upstream origin server perform a lookup on its behalf).

rtmfp_remote_redirects

Number; count of redirects sent to directly connected clients on behalf of another server that handled the initiating lookup (for example, an edge server sends a redirect to a client on behalf of a lookup handled at the origin server).

rtmfp_remote_redirect_requests

Number; count of redirect requests sent to other servers (for example, the origin server performs a lookup and sends a redirect request to the edge server that the initiating client is directly connected to).

service_connects

Number; number of service connections.

service_requests

Number; number of requests made for services.

swf_verification_attempts

Number; count 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

Number; count 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

Number; count 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_matches

Number; count 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

Number; count 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.

swf_verification_unsupported_rejects

Number; count 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.

total_connects

Number; total number of socket connections to the server.

total_disconnects

Number; total number of socket disconnections from the server.

virtual_connects

Number; number of virtual connections proxied on groups.

working_threads

Number; number of working threads.

writes

Number; total number of system writes.

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 for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

 <result>   <level></level>   <code></code>   <description></description>   <timestamp></timestamp>  </result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

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

See also

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy