Troubleshooting the REST API


To understand errors from the REST API, examine the status code of the response along with the response body if present. If that does not help, and you have access to the application's logs, look at the log file for the REST APIs and services. The steps to set the log level for the REST APIs and services are explained as follows:

To set the log level

  1. You can configure the log level from the CMDB Portal to collect more log information. 
  2. On the CMDB Portal, select Configurations> Core Configurations > CMDB Services.
  3. Set the log level of CMDB Services component to Info or Debug as shown in the following figure:

CMDB service logging tab.png

For more information, see CMDB-Services-configuration-settings.

For setting up CMDB Engine logging, see Contents-of-the-logs


Issues with using the Graphwalk endpoint

Use the information in this topic to troubleshoot any issues that might occur when by using the Graphwalk endpoint.

Issue symptom

An error “Error parsing: graph_walk_query” occurs.

Issue scope

When searching for related CIs by using the Graphwalk API.

Resolution

Check for one or more query parameters that do not comply with the query parameter format described in the graphwalk query parameters table.

See Endpoints-in-the-REST-API.

Issue symptom

Performance degradation issues are observed when using Graphwalk API to search for CIs. 

Issue scope

Graphwalk API uses a recursive query while searching for CIs to improve performance.

Resolution

GraphWalk API uses a recursive query, but the performance might degrade due to the following limitations:

  • Recursive Query is supported only for PostgreSQL database. For other databases, the default Graphwalk query is used.
  • The maximum number of records supported is 10K. If the number of records is greater than 10K or for unlimited records (0), the default Graphwalk query is used.
  • The maximum number of levels supported is 25. If the number of levels is greater than 25 levels, the default Graphwalk query is used.

For errors related to Graphwalk API, see the following links:


Issues with CMDB Portal

Issue symptom

CMDB Portaldoes not launch.

 Issue scope

This issue is observed when configuring the Jetty server using a secured socket layer (SSL).

Resolution

 Perform the following steps:

  1. Open the arserver.config file, located in the InstallationDirectory\ARSystem folder.
  2. Add the following line in the arserver.config file.
    jvm.option.<next_no>=-Dorg.apache.activemq.broker.BouncyCastlePosition=100



 

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