Troubleshooting Compliance job performance issues
Issue symptoms
- A TrueSight Server Automation Compliance Job is running slower than expected against one or more Target Servers with errors.
- The Compliance Job may also be encountering a JOB_TIMEOUT or a JOB_PART_TIMEOUT due to the longer than expected run time.
Issue scope
The issue may be related to specific Target Servers, specific rules or may be an overall Compliance Job performance issue.
Diagnosing and reporting an issue
Task | Action | Steps | Reference |
|---|---|---|---|
1 | Understand the problem scope. |
| Template name and version details: |
2 | Review Component Template for unnecessary template parts. | During a Compliance Job run, the following order of events occur: 1) All Template Parts are first collected from the Target. 2) Compliance Rules are evaluated. A common cause of Compliance performance problems can be that the Component Template has Template parts defined which are not used by Compliance Rules. This can result in the Template Part being unnecessarily collected from the Target Servers when they are not required for Compliance Rule evaluation. Review the Template Parts of the Component Template and remove any parts not used by Compliance Rules. | |
3 | Test the individual Compliance Rule from the TrueSight Server Automation Console | Can the performance issue be reproduced using the "Test Rule" functionality of the TrueSight Server Automation Console? Testing the rule from the TrueSight Server Automation Console allows the user to reproduce and troubleshoot the behavior outside the context of a Compliance Job. See steps in the Reference section on the right for details on testing a Compliance Rule from the TrueSight Server Automation Console. |
For more information, see Testing-a-compliance-rule. |
4 | Test the command(s) run by the rule directly on the Target Server | If the Compliance Job performance issues are confined to specific rule(s)on specific Target(s) , can the commands used by the rules be run directly on the Targets? If so, does this manual run encounter the same performance issues? This step may not apply if the performance issues are not related to specific rules/Targets but are a general issue with the Compliance Job. For example, if the Compliance Rule is checking the permissions of a file, this can be validated directly on the Target Server and also via a Live Browse from the TrueSight Server Automation Console. For example,
See reference section on the right for an example of checking file permissions directly from a Target Server and from the TrueSight Server Automation Console. Different Compliance Rules will check for other conditions which can similarly be tested directly on the Target. For example,
| Checking file permission directly from Target Server: To check the file permission by Live Browsing the Target Server:
|
5 | Enable Debug Logging | The log4j.properties or log4j2.xml file (depending on the version) on an Application Server can be modified to enable debug-level logging for two specific Compliance Level logger classes. See detailed steps in reference section on the right. An Application Server restart is not required after enabling this debug. For simplicity, the debug-level logging can be enabled on just one Application Server and a Job Routing rule can then be added to route the next run of the Compliance Job to this specific Application Server. Once the additional debug-level logging has been enabled, and the job routing rule has been created, rerun the Compliance Job to generate the additional debug-level logging in the Application Server log. | Logging properties file location: <installation_directory>/NSH/br/deployments/<deployment>
See KA 000389694 for additional details. |
6 | Generate Compliance Job Log Package | Generate the Compliance Job Log Package for review by BMC Customer Support. Right-click a failed Compliance Job Run (where debug-level logging had been enabled in step 4) and select "Download Log Package" to capture the required logs. (refer to screenshot on the right for details) |
Once process is complete it will show a popup window confirming the logs are downloaded/generated: Reference Video: |
7 | Analyze log files to understand where the performance issues(s) were encountered. | Analyze log files to understand where the performance issues(s) were encountered. Identify a specific WorkItem-Thread which is executing the slow Compliance rule on a slow Target Server and follow the debug log entries for that WorkItem-Thread to determine the bottleneck. If unable to identify and resolve the problem, see Step 8 to create a BMC Support Case. | See KA 000389694 for additional details. |
8 | Creating a BMC Support Case. | Provide the following information and log files when creating a case with BMC Customer Support:
|










