Creating custom dashboards

Edit online
Pre-requisites:

You must have the Manage custom dashboards functional privilege assigned to manage the custom dashboards in Global analytics.

The Custom dashboards has two options:

  • View. To view custom dashboards. You can select the custom dashboard that you want to view from the drop-down list.
  • Build. To build custom dashboards. Here, you can create and add visualizations to build custom dashboards.
Note:
  • It is recommended to not modify any default visualizations. If you modify any default visualizations, an upgrade or restart of webMethods API Gateway server overwrites the modifications.
  • Improper visualizations or long running queries in the visualizations can impact the performance of the Elasticsearch.

You can create custom dashboards for both webMethods API Gateway-wide analytics and API-specific analytics from the Menu options > Analytics page. You can create the visualizations and dashboards in the Kibana interface, and the dashboards are rendered in webMethods API Gateway user interface.

To create custom dashboards

  1. Click Menu options > Analytics.
  2. Click Custom dashboards > Build.
  3. Build custom dashboard. For instructions, see Kibana documentation.
    For API-specific custom dashboard, type apiId:"*" in the search box and then save the dashboard. This filter creates a custom dashboard specific to API-specific analytics.
    Editing dashboard
To view the custom dashboard for webMethods API Gateway-wide analytics, click View and select the dashboard from the drop-down list.

To view the custom dashboard for API-specific analytics, click APIs > API name > Analytics. Select the custom dashboard from the drop-down list.