Monitor APIs

Edit online

webMethods API Gateway provides monitoring capabilities to monitor webMethods API Gateway and API usage by collecting and analyzing data about the availability and performance of an API. This helps in identifying problems that impact users. In addition to monitoring the performance of APIs, you might also want to get an insight into how developers are using the published APIs. This data provides a better understanding of any improvements that might be necessary to enhance the API usage or performance.

The analytics dashboard in the webMethods API Gateway UI displays various charts to provide an overview of webMethods API Gateway performance and its API usage. The data for these dashboards comes from the webMethods API Gateway destination store. The dashboard has various filters that you can apply depending on what you want to monitor. webMethods API Gateway also provides the capability to view a custom dashboard.

webMethods API Gateway dashboard: Displays webMethods API Gateway-wide analytics such as Summary of APIs, API usage, API trends, the well-performing API and the nonperforming API analytics, audit logs, applications, and package-related event information. Click menu options icon on the title bar to access API Gateway-wide analytics. For details about the webMethods API Gateway dashboard, see API Gateway dashboard.
API-specific dashboard: Displays API-specific analytics such as API invocation trends by response time, success and failure rates, API performance, consumer, or application traffic for a specific API. This function can be accessed from the API details page.
Custom dashboard: Displays webMethods API Gateway-wide analytics or API-specific analytics as configured. Click menu options icon on the title bar and click Analytics to access webMethods API Gateway-wide analytics. A custom dashboard is a collection of visualizations. You can add the visualizations as per your requirement and compile the visualizations as a custom dashboard.

The dashboard view depends on the events and metrics that are generated in the webMethods API Gateway and their types. An event is a notification or alert that is generated by the webMethods API Gateway Metrics and Event notification module. Various types of event are generated based on the behavior of the transactions in the system. webMethods API Gateway generates events that are real-time events made persistent in the store and sent to configured destinations.

The events generated in the webMethods API Gateway are as follows.

Transactional event: Provides a summary of each runtime transaction in the system. It is generated when a Log Invocation policy is included for the API. For example, if an API has the policy that is attached to it, then for every call the system generates a transaction event. webMethods API Gateway provides a system global policy, Transaction logging, which is pre-configured in the product. This policy is, by default, which is deactivated. The transaction logging policy has standard filters and a log invocation policy that logs request or response payloads to a specified destination.
Error event: Provides details of an error that occurred during an API call. This event is generated whenever you face an error in the system during a runtime service invocation. This event is configured as part of the destination configuration.
Monitoring event: Provides a summary of event details along with the breach information when you face a threshold breach in any of the configured parameters. Monitoring might be done based on various parameters such as Total Request Count, Total Success Count, Response Time, and Availability. Monitoring can be done at the consumer application level too so that each consumer can be tracked individually. These events are generated when a Monitor performance and Monitor SLA Policy are included for the API. Also, the Traffic Optimization policy generates these events for every API invocation only when there is a breach in the parameters that are configured in the policy or per alert interval based on the alert frequency that is configured in the policy.
Policy violation event: Provides a summary of the policy violations that occurred in the system. When a policy attached to an API is violated, the system generates the policy violation event for alerting the provider. The Identity and Access, Authorization, and Schema Validation policies generate these events. This event is configured as part of the destination configuration. In addition, the Traffic Optimization policy generates these events for every API invocation only when you face a breach in the parameters that are configured in the policy.
Lifecycle event: Provides a summary of the life-cycle of the webMethods API Gateway instance. Whenever the instance is started or stopped, a life cycle notification is generated. This event is configured as part of the destination configuration.
Threat protection event: Provides a summary of the threat protection filter and rule violations. When a filter or rule is violated, the system generates the threat protection violation event. This is configured a part of the destination configuration.

Note: Internalization is not supported in webMethods API Gateway dashboards.

For details on runtime events and Metrics data model, see Runtime Events and Metrics Data Model.