Debug Deployments

You can use execution information logs to identify the source of errors across all deployments at runtime and after the deployment completes. Every process is shown separately, and provides the option to download the log per deployment or per step. Execution information is gathered from all agents and the assigned actions and flows assigned to the deployment.
ra64
You can use execution information logs to identify the source of errors across all deployments at runtime and after the deployment completes. Every process is shown separately, and provides the option to download the log per deployment or per step. Execution information is gathered from all agents and the assigned actions and flows assigned to the deployment.
 The feature is not supported If you have upgraded to 
Release Automation (Nolio)
 6.4, but the agents are not upgraded.
For more information, Upgrade All Agents, in Upgrade CA Release Automation.
 
 
3
 
3
 
 
Execution Information Logs
To identify deployment errors across processes or steps, generate execution information logs.
Follow these steps:
 
  1. Select 
    Releases
    ,
     Deployments
  2. Select the deployment, and click the download icon that is found in the status column.
  3. Select one of the following types of execution information log.
    Entire deployment
    Collects logs of all the deployment steps from all agents.
    This step by all agents 
    Collect logs of a specific step from all agents.
    This agent for this step
    Collect logs of a specific step from a specific agent.
    Select to 
    Open with
    , or to 
    Save File
    .
  4. Extract, then open the file to view the execution information log.
If a specific file is not found on the agent an error message opens, and an extra file is added to the log. The name of the file is, errors.txt. This error can be soured from the following reasons.
  • The file was deleted from the agent. The execution log housekeeping job purged the file. For more information, see Purge Execution Logs.
  • The agent version does not support the debug feature.
  • An internal error has occurred.
How to Use the Execution Information Logs
The execution information log zip file contains files and folders in the following format.
  image2017-3-1 9:40:47.png  
The legend file contains an overview of each deployment step with the following information:
Date and time of the download.
The Step ID
The Step Name, Process Name, and Tag
Server Type, and the Step Status at the time of the download
The path to where the information can be viewed in the log file
 
Example
 
2017-02-28T06:18:38.290
Step ID: 895
log files can be found at the following locations. If log files not found, check download_errors.txt
Step Name: "Application Server (PRE)", Process Name: "Pre - Tomcat Express" (Latest), Server Type: "Application Server", Status: FINISHED
Log File: ratestingN87970_job_150/ratestingN87970_job_150_JobServerID_154.log
2017-02-28T06:18:38.290
Step ID: 891
log files can be found at the following locations. If log files not found, check download_errors.txt
Step Name: "DB Server (PRE)", Process Name: "Pre - MySQL Express" (Latest), Server Type: "DB Server", Status: FINISHED
Log File: ratestingN87970_job_151/ratestingN87970_job_151_JobServerID_155.log
2017-02-28T06:18:38.290
Step ID: 896
log files can be found at the following locations. If log files not found, check download_errors.txt
Step Name: "Application Server (DEPLOY)", Process Name: "Deploy - Tomcat Express" (Latest), Server Type: "Application Server", Status: FINISHED
Log File: ratestingN87970_job_152/ratestingN87970_job_152_JobServerID_156.log
2017-02-28T06:18:38.306
Step ID: 893
log files can be found at the following locations. If log files not found, check download_errors.txt
Step Name: "DB Server (DEPLOY)", Process Name: "Deploy - MySQL Express" (Latest), Server Type: "DB Server", Status: FINISHED
Log File: ratestingN87970_job_153/ratestingN87970_job_153_JobServerID_157.log
2017-02-28T06:18:38.306
Step ID: 892
log files can be found at the following locations. If log files not found, check download_errors.txt
Step Name: "DB Server (POST)", Process Name: "Post - MySQL Express" (Latest), Server Type: "DB Server", Status: FINISHED
Log File: ratestingN87970_job_154/ratestingN87970_job_154_JobServerID_158.log
2017-02-28T06:18:38.322
Step ID: 894
log files can be found at the following locations. If log files not found, check download_errors.txt
Step Name: "Application Server (POST)", Process Name: "Post - Tomcat Express" (Latest), Server Type: "Application Server", Status: FINISHED
Log File: ratestingN87970_job_155/ratestingN87970_job_155_JobServerID_159.log
Each log folder is named in the following format: Agent_<Agent Name> _
Job
_<Job ID>, for example, Agent_ratestingN87970_Job_150
If step 150 ran on several agents, you would get multiple directories. 
For example:
Agent_ratestingN87980_Job_150
Agent_ratestingN87999_Job_150
Agent_ratestingN88770_Job_150
Each job folder contains a detailed log for each deployment step, listing the flows and the actions as they are performed. The log file is named in the following format:
Agent_<Agent Name> _
Job
_<Job ID>._JobServerID_<Job Server ID>.log
For example:
  image2017-3-1 10:48:0.png  
When steps are run on more than one server types, the Server ID is the unique identifier of the step for the server type.
The log indicates when flows and actions have started and stopped, the parameter values collected, and flow iterations. For every agent step, a folder is created and contains all the log file. 
Flows and actions are assigned unique identifying numbers, for example, (P477.F3732.E3742.E3751.E3748). Use the identifier to search the log file for every step that uses the flow or the action.
The identifying number is built in a hierarchal format. For example, if Flow A, contains Flow B, and Flow B contains the Actions X and Y, the identifier can be:
Flow A: P657.F4485.E4491
Flow B: P657.F4485.E4491.D2231
Action X: P657.F4485.E4491.D2231. F3356
Action Y: P657.F4485.E4491.D2231. F3357
Example
 
2017-02-26 11:48:16,819 - Starting Step Application Server (PRE)(Server type ID:316)Agent: ratestingN87970 =================================================================================================
2017-02-26 11:48:16,834 - Starting Flow "Pre(P657.F4485.E4491)"=================================================================================================
2017-02-26 11:48:16,850 - Resolving parameters of Input fields for Create working directory(P657.F4485.E4491.E4497):Create Folder
Working directory = c:\temp
=================================================================================================
2017-02-26 11:48:16,850 - Starting Action Create working directory(P657.F4485.E4491.E4497)
Action Type: Create Folder
Pause on Fail: true
Input fields:
New Folder Path = c:\temp
Fail If Exist = false
=================================================================================================
2017-02-26 11:48:16,850 - Ending Action Create working directory(P657.F4485.E4491.E4497)
Action Type: Create Folder
Action State: true
Action Description: Finished successfully: Folder created c:\temp
=================================================================================================
2017-02-26 11:48:16,865 - Resolving parameters of Input fields for Create backup directory(P657.F4485.E4491.E4495):Create Folder
Release Start Time = 1488127695740
Working directory = c:\temp
=================================================================================================
2017-02-26 11:48:16,865 - Starting Action Create backup directory(P657.F4485.E4491.E4495)
Action Type: Create Folder
Pause on Fail: true
Input fields:
New Folder Path = c:\temp/1488127695740
Fail If Exist = false
=================================================================================================
2017-02-26 11:48:16,865 - Ending Action Create backup directory(P657.F4485.E4491.E4495)
Action Type: Create Folder
Action State: true
Action Description: Finished successfully: Folder created c:\temp/1488127695740
=================================================================================================
2017-02-26 11:48:16,865 - Starting Flow "Backup configuration files(P657.F4485.E4491.E4496)"
=================================================================================================
2017-02-26 11:48:16,865 - Starting Flow "Backup applications war file(P657.F4485.E4491.E4494)"
=================================================================================================
2017-02-26 11:48:16,912 - Starting Iteration of "Backup configuration files(P657.F4485.E4491.E4496)"
Input fields:
Loop Folder = <Express_Config>
<item>
<Deploy_Path>C:\apache-tomcat-7.0.75\webapps\activiti-explorer\WEB-INF\classes</Deploy_Path>
<Definition_Name>db.properties</Definition_Name>
</item>
</Express_Config>
Output fields:
Iter Counter = 1
Iteration description: Folder loop continues, iteration #1
Process Test Execution Logs
When a process test is run, you can download the execution log of the process test to review the information.
To generate execution logs of a completed process test,
Follow the steps:
 
  1. Select 
    Release
    Process Design
    .
  2. Select the process that you want to test, and click 
    Test
    .
  3. When the test completes, select to download from one of following two locations.
    1. On the right next to the 
      Play
       / 
      Stop
       icons
    2. In the 
      Details
       pane, next to the agent status
  4. Select one of the following types of execution information to download.
    1.  
      Entire Test (all agents that run this test).
       
    2.  
      This agent that runs this step.
       
    The process test execution information is downloaded.
Execution Log Control
Turn Off Execution Logs
 
Control how often agents write execution information to limit the agent disk space usage. Execution logs can be turned off per agent without effecting the UI. The property file configurable is located under conf: applicationlog.properties
Store Execution Logs
 
To protect the overcapacity of disk space by the agent, the system stops writing to the log file when it reaches the maximum capacity of XXX MB per job. You can increase the logs capacity by modifying the following parameter values. The property file configurable is located under conf: applicationlog.properties
Define the following parameters to control how much execution information is stored.
Max Folder Size
 
This parameter holds the number of megabytes of execution logs data to be stored on the agent. 
(Default: 50 MB) 
 
Max File Size
 
This parameter holds the number of MB to be written to a single log. 
(Default: 2500 KB)
 
Max Backup Index
 
This parameter holds the number of extra logs per job to be written. When the parameter is set to 0, only one file is written (".log"). For example, if the index is set to 2, 3 files, ".log", ".log1", and "Log 2", are written, each at the size that is defined in the File Size parameter. When the job files reach the limit, the agent stops writing, and creates a file with the name: jobId{jobId}_serverType{ServerType}_reach max file size limit with the message: "The logging for this job has reached to a maximum of XXX MB, and as such the logging stops". XXX = ("Max Backup Index + 1) * Max File Size). 
(Default: 0) 
 
Purge Execution Logs
 
Define how often an agent purges execution log information.
Purging Percentage 
 
This parameter holds the percentage of the folder size to be purged once it reaches to the max folder size. For example, if the max folder size equals 50, when the folder reaches the max folder size, 10 MB is purged. 
(Default: 20)
 
Pause between purge
 
This parameter sets the number of minutes to wait between cleanups. 
(Default: 10)
 
Note: 
While the cleanup process is paused, the folder size might exceed the size that is defined in the parameter.