How to debug report problems in CA Performance Management

Document ID : KB000101388
Last Modified Date : 13/06/2018
Show Technical Document Details
Introduction:
When reports don't provide the expected output in a reproducible scenario debug is often required to delve deeper into the potential cause.
Background:
This data is often required to determine a root cause and solution for report problems.

If a problem is defect related requiring engineering engagement, this data would be required in most circumstances.
Environment:
CA Performance Management releases r3.5 and older have one process

CA Performance Management releases r3.6 and newer provide a simpler more intuitive method to gather the logging.
Instructions:

Generic RIB Debug logging procedure for DataAggregator reports issues...

Procedure for Release 3.6 and up:

(This can also be found in the Troubleshooting section of the user documentation)

  1. Log in as a user who has the "Generate URLs from Views" role right.
  2. Open the dashboard that contains the problematic view.
  3. Click the Edit (gear) icon on the view, and select Generate URL.
    The Generate URL dialog opens.
  4. Enable Detailed View Logging.
  5. Click Preview.
  6. Take a screenshot of the preview and save it to file.
  7. Run CARE on the Performance Center host and the Data Aggregator host.
  8. Provide the archive files from CARE and the screenshot file to CA Support.

 

Procedure for Releases prior to 3.6:

Setup required to collect debug.

1) Create a new dashboard page (or context page tab), add only one <ViewBeingDebugged> view to the new tab, and configure it as it was when the problem was reproduced before.  Save the new page or tab and confirm that it shows the issue.  Leave this browser window open. We will return to it later in this procedure.

2) If unable to create a new dashboard and reproduce the problem, we can enable RIB blue bars to determine the query being made.

  In a new tab of the browser, go to:

    http://<CAPCHOST>:8181/pc/center/admin/debug/attrs

  Find RIBModel.InfoEnabled, and change the value to true. Click the Update button.

  Go back to view exhibiting the issue, and reload the page.  Confirm there is now a blue bar on the view that can be expanded.

Enable DA RIB debug logging.

1) On DA host, edit the file /opt/IMDataAggregator/apache-karaf-*/etc/org.ops4j.pax.logging.cfg

  Uncomment the following lines (remove the '#' character)

  #log4j.category.com.ca.im.dm.ribsource=TRACE,sift
  #log4j.additivity.com.ca.im.dm.ribsource=false

Enable PC RIB debug logging.

1) Enable trace logging for the view on PC console.

  In a new tab of the browser, go to:

    http://<CAPCHOST>:8181/pc/center/admin/config/logs?listing=all

  For each of the following classes (ignore if missing​), set Level to "TRACE":

   com.ca.im.portal.plugins.rib.models.RIBCalendarHeatChartModel
    com.ca.im.portal.plugins.rib.models.RIBHorizontalTimeBarChartModel
    com.ca.im.portal.plugins.rib.models.RIBMultiChartModel
    com.ca.im.portal.plugins.rib.models.RIBTableModel
    com.ca.im.portal.plugins.rib.models.RIBXYChartModel
    com.ca.im.portal.plugins.rib.models.composite.RIBChartTableModel
    com.ca.im.portal.plugins.rib.models.custom.RIBOnDemandTrendModel
    com.ca.im.portal.plugins.rib.models.custom.RIBTableChartModelMultiItem

  Click the "Update" button near the top left of the page to apply the change.

2) Enable debug logging for RIB on DM

  In a new tab of the browser, go to:

    http://<CAPCHost>:8481/dm/admin/config/logs?listing=all
    
  Note: If can't get to 8481, you can go though 8181:

    http://<CAPCHOST>:8181/pc/center/admin/debug/servers/dm/admin/config/logs?listing=all

  For the following, choose Level = "DEBUG" from the listbox at right side:

   com.ca.im.rib.engine.Engine
   com.ca.im.rib.engine.portal.id.ItemIDTranslator

  Click the "Update" button near the top left of the page to apply the change.

Reproduce the issue.

1) Return to the CAPC page/tab where you added the <ViewBeingDebugged> view in step 1.

2) Reproduce the issue. Capture a screenshot (and/or PDF) and CSV output from the view having the problem.

Collect the data for Sustaining team.

1) Collect the following log files and return to us:

  DA machine:

    /opt/IMDataAggregator/apache-karaf-*/data/log/aggregator.reporting.log

    /opt/IMDataAggregator/apache-karaf-*/data/log/karaf.log

  CAPC machine:

    /opt/CA/PerformanceCenter/DM/logs/DMService.log

    /opt/CA/PerformanceCenter/PC/logs/PCService.log.

Disable debugging.

1) Disable DA RIB debug logging.

  On DA host, edit the file /opt/IMDataAggregator/apache-karaf-*/etc/org.ops4j.pax.logging.cfg

  Comment the following lines (prepend the '#' character)

  #log4j.category.com.ca.im.dm.ribsource=DEBUG,sift
  #log4j.additivity.com.ca.im.dm.ribsource=false

2) Disable the RIB blue bars (if enabled).

  Go back to the tab with address:

    http://<CAPCHOST>:8181/pc/center/admin/debug/attrs

  Find RIBModel.InfoEnabled, and change the value to false. Click the Update button.

3) Disable PC debug logging.

  Go back to the tab with address:

    http://<CAPCHost>:8181/pc/center/admin/config/logs?listing=all

  For each of the following classes (ignore if missing), set Level to "INHERITED":

   com.ca.im.portal.plugins.rib.models.RIBCalendarHeatChartModel
   com.ca.im.portal.plugins.rib.models.RIBHorizontalTimeBarChartModel
   com.ca.im.portal.plugins.rib.models.RIBMultiChartModel
   com.ca.im.portal.plugins.rib.models.RIBTableModel
   com.ca.im.portal.plugins.rib.models.RIBXYChartModel
   com.ca.im.portal.plugins.rib.models.composite.RIBChartTableModel
   com.ca.im.portal.plugins.rib.models.custom.RIBOnDemandTrendModel
   com.ca.im.portal.plugins.rib.models.custom.RIBTableChartModelMultiItem

  Click the "Update" button near the top left of the page to apply the change.

4) Disable PC debug logging.

  Go back to the tab with address:

    http://<CAPCHOST>:8481/dm/admin/config/logs?listing=all

  Note: If can't get to 8481, you can go though 8181:

    http://<CAPCHOST>:8181/pc/center/admin/debug/servers/dm/admin/config/logs?listing=all

  For "com.ca.im.rib.engine.Engine", choose Level = "INHERITED" from the listbox at right side.

  Click the "Update" button near the top left of the page to apply the change.

Additional Information:
Note the two sets of instructions above. One for r3.6 and newer releases, one for r3.5 and older.