logClientData()

RTMP/E

 logClientData(auser:String, apswd:String, appinst:String, client:String, mode:Array) : Object

HTTP

 http://my_server_ip_address:1111/admin/logClientData?auser=amsadmin&apswd=amsadminpassword&appinst="live/_definst_"&client="-1"&mode=[bytes-in,msgs-in]

Sends data about clients connected to an application instance to two new log files: bytes_in_xxxxx.log and msgs_in_xxxxx.log. These logs live in the rootinstall/logs folder.

Before calling this API, do the following:

  1. Load the application into Adobe Media Server.

  2. Enable all HTTP commands in the rootinstall/conf/Users.xml configuration file:

    <HTTPCommands> 
        <Allow>All</Allow> 
        <Deny/> 
    </HTTPCommands>

Availability

Flash Media Server 3.5.3

Parameters

auser

A string indicating the user name of the administrator.

apswd

A string indicating the password of the administrator.

appinst

A string indicating the path from the application name to the application instance name.

client

A string indicating the client or clients to log data for. To log data about all clients, use "-1". To log data based on Client.id, use the format: client="id:CBAYgnfG". To log data based on Client.ip, use the format client="ip:10.20.30.40".

mode

An array indicating the logs to create. Possible values are bytes-in and msgs-in.

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 timestamp property that is a Date object. The Date object indicates the time that the method was executed.

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>status</level>   <code>NetConnection.Call.Success</code>   <timestamp>3/30/2011 5:56:07 PM</timestamp>   <data />  </result>

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

Get help faster and easier

New user?