Downloading Logs for an Application

You can now download all logs related to an application as the .zip file. This .zip file contains logs of each Node on which the application is deployed, logs from the Hosts managing those Nodes and System Node logs. The default name of .zip file is [APPLICATION_NAME]-[USERNAME]-[TIMESTAMP].logs.zip. Example: jv.helloworld1.soa-root-30_Nov_2017_16-40-24-036.logs.zip. If you are downloading the logs of multiple applications together, the default name of .zip file is AllSelectedApps-[USERNAME]-[TIMESTAMP].logs.zip

Note: If the host or node on which application is deployed is not running then logs for that host or node are not downloaded in the .zip file. Message is displayed in the SystemNode.log file that downloading logs for the host or node is skipped.
If an application is using its own log configuration then those files are also included in the same .zip file.
Note: For more information on creating new logging configuration for application, see Creating Logging Configuration for Host or Node
Along with log files, the.zip file contains viewaction.html page, which is used to display user actions for an application.

GUI

To download logs using Administrator GUI:

  1. Click Infrastructure > Enterprise status.
  2. Click Application tab. The list of all applications in Enterprise is displayed.

  3. Select the application for which you want to download logs:
    1. To download logs for individual application, Click Download link in Download Log column.
    2. To download logs for multiple applications, select the check boxes corresponding to those applications and click Download Log button at the top.
The .zip file is downloaded to Downloads folder of your machine.

Example: The directory structure of the .zip file is as shown in the following image.

CLI

You can use Administrator CLI to download an application's logs by invoking download-logs target of application_build.xml file located in the sample directory ( CONFIG_HOME\admin\<Enterprise_Name>\samples or TIBCO_HOME\administrator\3.4\samples). The application_data.xml file contains application details such as application name, name of the Node or Host on which the application is running.

Sample application_data.xml:

<Environment name="DevEnvironment" xsi:type="amxdata:Environment" >
<Node name="DevNode" xsi:type="amxdata:Node"/>
<Application folderPath="/" name="jv.helloworld1.soa" 
resourceTemplatesScope="application" xsi:type="amxdata:Application" />
</Environment>
By default the .zip file is downloaded to the location from which script was run (that is to the samples directory). You can change the location by specifying a different location in options as location <folder path>.
<target name="download-logs" >
<AMXAdminTask action="downloadLogs" 
objectSelector="Environment//Application" 
remote="true" 
propsFile="${instanceProperties}" 
dataFile="${dataFile}" 
force="true" failOnError="true" 
options="location C:\Users\User1\Downloads\" />
</target>
Above target downloads the .zip logs file to directory C:\Users\User1\Downloads\.
To download all user actions in the Enterprise, use the downloadAllUserActions option.
<target name="download-logs" >
<AMXAdminTask action="downloadLogs" 
objectSelector="Environment//Application"
remote="true"
propsFile="${instanceProperties}"
dataFile="${dataFile}"
force="true" failOnError="true" options="downloadAllUserActions" />
</target>

Above target downloads the .zip logs file to the samples directory. The viewaction.html in the .zip file contains all user actions in the Enterprise.

To download all user actions for an application, use the downloadAllUserActionsForApp option.
<target name="download-logs" >
<AMXAdminTask action="downloadLogs" 
objectSelector="Environment//Application"
remote="true"
propsFile="${instanceProperties}"
dataFile="${dataFile}"
force="true" failOnError="true" options="downloadAllUserActionsForApp" />
</target>
Above target downloads the .zip logs file to the samples directory. The viewaction.html in the .zip file contains user actions for the application.
To download all user actions of the Enterprise and to specify location, use options as mentioned below:
<target name="download-logs" >
<AMXAdminTask action="downloadLogs" 
objectSelector="Environment//Application"
remote="true"
propsFile="${instanceProperties}"
dataFile="${dataFile}"
force="true" failOnError="true" 
options="location C:\Users\User1\Downloads\, downloadAllUserActions" />
</target>
Above target downloads the .zip logs file to C:\Users\User1\Downloads\ directory. The viewaction.html in the .zip file contains all user actions in the Enterprise.