Monitoring performance of data planes in federated API management

Monitor the business metrics of all data planes in a unified view or focus on a specific data plane. You can identify the most and least performing data planes and runtimes.

Before you begin

Make sure that you have API platform provider or API product manager user role to perform the task.

Procedure

Data planes can be monitored in the following ways:
  • On the Insights page, click the Data planes tab to monitor the performance of all data planes.
By default, the Data planes tab renders the metrics of all the data planes pertaining to the last 1 hour. If you want to render the metrics for a different time range, select the predefined or custom time range from the time range menu and click Apply.
  • On the Catalog page, click the Data planes tab and click the monitor icon under the Action column corresponding to the data plane for which you want to view the performance metrics.
By default, the data plane specific monitoring Insights tab renders the metrics of the selected data plane for the last 1 hour. If you want to render the metrics for a different time range, select the predefined or custom time range from the Time Range menu and click Apply.

To view the list of recent activities of the data plane, click the Activities tab. To view the associated runtimes, click Relations tab.

Note: As Developer portal and CMS portal does not send performance metrics to federated API management, only the Status and Availability widgets are applicable for Developer portal and CMS portal runtime types. Therefore, data is populated only in these two widgets. If the data plane consists solely of the Developer portal and CMS portal runtime types and no other runtime types, only the Status and Availability widgets are rendered; the remaining widgets do not render.

For third-party gateways, if should.send.metrics property is disabled, performance metrics will not be displayed in the respective metrics section.