Navigator APIs Overview

Locating the Version Information for the Navigator API

1. Click Help.
2. Select API Documentation to display the API documentation.
3. Scroll to the bottom of the page. The version number is the last item on this page:
   
   
   
   

The API is structured into resource categories. Click a category to display the resource endpoints.

Enable Debug Mode

The counter n displays the number of API calls captured in the debug file for the current session interaction. Here is an example from a downloaded debug file showing one of the responses after reloading the page:

Download Debug File or Files

As you perform actions with the Cloudera Navigator console, the counter refreshes and keeps tracks of current calls only (stateless nature of REST). In other words, download the debug file for any given action or selection that you want to examine.

Debug files use a naming convention that includes the prefix "api-data" followed by the name of the host and the UTC timestamp of the download time and the JSON file extension. The pattern is as follows:

api-data-fqdn-yyyy-mm-ddThh-mm-ss.json

For example:

api-data-fqdn-2.example.com-2017-06-15T09-00-32.json

Disable Debug Mode

Set Debug Logging Levels

The Cloudera Navigator Debug Mode allows you to configure the logging levels for individual methods in the application code. For example, to increase the logging detail for API calls, you would set the logging level for the org.apache.cxf.interceptor class to "DEBUG" level. If you are collecting debugging information for a specific issue, Cloudera support will provide the class name.

To set the logging level for a Cloudera Navigator application class:

1. Log in to the Cloudera Navigator console.
2. Add /debug to the Navigator URL:

   http://fqdn-a.example.com:7187/debug

   The debugging console appears.

3. Click Configure Logging.
4. In the Logger drop-down menu, select a Navigator class, such as org.apache.cxf.interceptor for API calls.
5. Set the logging level for the class.

   For example, for the API call logging, select DEBUG.

6. Click Submit.

When changed in Debug Mode, logging levels will return to their default values after restarting the Navigator Metadata Server. To permanently change the logging levels, use Cloudera Manager to add an entry in the Navigator Metadata Server Logging Advanced Configuration Snippet. Create the entry as follows:

log4j.logger.<classname>=<level>

For example, to set the API logging level to "DEBUG", include the following string in the Advanced Configuration Snippet:

log4j.logger.org.apache.cxf.interceptor=DEBUG

See Modifying Configuration Properties Using Cloudera Manager.