Obtaining job diagnostics



To troubleshoot TrueSight Server Automation jobs, you can use the following methods to obtain diagnostic information for job runs:


Running a job in debug mode

If you experience issues with job execution, use the DEBUG_MODE_ENABLED job property to provide additional diagnostic information to the job log. The additional level of logging provides you or BMC Customer Support representatives with more detailed information when diagnosing issues with job execution.

The generated debug logs are stored on the Application Servers involved in running the job in the following directory and with the following file name convention:
<installDirectory>/NSH/tmp/debug/<deploymentName>/<jobName + date>.log

The video at right demonstrates how to use the DEBUG_MODE_ENABLED job property to collect debug data for a patching job. This same technique can be used for collecting debugging data for any job type.

To set the DEBUG_MODE_ENABLED job property

  1. In the Jobs folder, select a job.
  2. Do one of the following:
    • Right-click the job and select Set Property. The Set Job Properties window is displayed. Select DEBUG_MODE_ENABLED from the Name drop-down list.
    • In the Properties tab, select DEBUG_MODE_ENABLED from the Extended properties list.
  3. Set the property value to True.
    The default value for the DEBUG_MODE_ENABLED property is False.
  4. Click OK.

    Note

    Be sure to set the DEBUG_MODE_ENABLED property back to False when not diagnosing an issue, as running the job in Debug mode has a negative impact on performance.

To view the job log

  1. Open the Jobs folder, navigate to a job or Execution Task, right-click the job or Execution Task, and select Show Results to display its job runs.
  2. Select a run of a job, right-click, and select Show Log. A window displays log messages generated by the job.
  3. To filter messages so the job log only shows servers with specific job results, use the Run Details drop-down to select Errors, Warnings, Success, or All.
  4. To display messages in a dialog box that enables you to scroll through messages one by one, double-click a message. The Log Item Details dialog box opens. Click the Up arrow or the Down arrow to scroll through messages one by one. Click Close to close the dialog box.
  5. Click Close to close the log messages window.


Generating a log package for a job run

For comprehensive information about a job run, you can generate a zip package that contains various files with log messages related to the job run. This data is useful for diagnostic purposes when you contact Customer Support.

The job log package is available for the following types of jobs in TrueSight Server Automation 8.9.00:

  • BLPackage Deploy Job
  • Patch Analysis Job

As of TrueSight Server Automation 8.9.01, the log package is available for the following additional types of jobs:

  • ACL Push Job
  • Agent Installer Job
  • Audit Job
  • File Deploy Job
  • Compliance Job
  • Component Discovery Job
  • Network Shell Script Job
  • Snapshot Job
  • Update Server Properties Job

The job log package contains files from the following sources:

  • Application Server logs, especially job run messages from these logs
  • RSCD agent logs
  • Job log (CSV export)
  • (for a Deploy Job) deploy logs
  • (for a Patch Analysis Job) archived patch analysis files (available as of TrueSight Server Automation 8.9.01)

Before you begin

To generate the log package for a job run, your role must be granted the BL_Administration.Write authorization.

To generate a log package

  1. Open the Jobs folder and navigate to a job.
  2. Right-click the job and select Show Results to display its job runs.
  3. Select a job run, right-click, and select Download Log Package.
  4. In the Download Log Package dialog box, enter a name for the package and specify the location where you want to store it.
  5. Click Save.
  6. In the next dialog box, select the target servers for which to generate data:

    1. Above the list of servers, choose one of the following filters:
      • All Failures — targets where the job run failed
      • All Successful — targets where the job ended successfully
      • All Warnings — targets where the job ended with warnings
    2. Select any number of target servers and transfer them from the list of available servers to the list of selected servers using the right arrow.

    Note

    You can select up to 30 target servers. If you do not select any target servers, the target servers where the job failed are automatically selected (up to a maximum of 10 servers).

  7. Click OK.
    The zip package is created in the specified location.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*