APIv2 metrics - BlueCat Integrity - 26.1.0

Address Manager Administration Guide

ft:locale
en-US
Product name
BlueCat Integrity
Version
26.1.0

The Database tab displays metrics collected related to RESTful v2 API calls made against Address Manager.

Since the Integrity X UI is API-driven, interacting with UI elements results in API calls made to the back-end. You can select the origin of the API call to determine whether you would like to filter API metrics based on the following:
  • Both origins—API calls made from interacting with UI elements and directly calling the Address Manager v2 API directly
  • UI origins—API calls made from interacting with UI elements only
  • API origin—API calls made interacting with the Address Manager v2 API directly
Once you have selected an origin, the following graphs display metrics about Address Manager API usage:
  • Total API requests—displays the total number of RESTful v2 API requests made against the Address Manager for the given timeframe.
  • Mean API duration—displays the average time it took to execute RESTful v2 API requests against the Address Manager for the given timeframe, in milliseconds.
  • Max API duration—displays the maximum time it took to execute an RESTful v2 API request against the Address Manager for the given timeframe, in milliseconds.
  • API HTTP verbs—displays changes to the number of HTTP request methods requested against Address Manager.
  • API HTTP responses—displays changes to the number of HTTP responses returned by Address Manager.
  • API calls by client IP—displays the number of RESTful v2 API requests against Address Manager by client IP address for the given timeframe.
  • API calls by user—displays the number of RESTful v2 API requests against Address Manager by user profile for the given timeframe.
  • API calls—displays changes to the number of RESTful v2 API requests against Address Manager for the given timeframe.
  • API calls average duration—displays changes to the average duration taken to process RESTful v2 API requests against Address Manager for the given timeframe, in milliseconds.


To view APIv2 metrics:
  1. Select the Overview tab in the sidebar, then select Dashboards.
  2. Select the name of the Address Manager server that you would like to retrieve metrics for.
  3. Select the APIv2 tab.