Monitor your API
Understanding the usage and performance of your APIs is crucial for enhancing their functions, diagnosing issues, and making informed business decisions. Addressing the following queries contributes to API improvements and informed decision-making.
- How are your APIs performing over time?
- Which APIs are frequently used or under-used?
- When is API response time optimal?
webMethods API Gateway offers comprehensive monitoring capabilities to address these challenges. It collects and analyses data that concerns the availability and performance of both the webMethods API Gateway and the APIs themselves. This proactive approach enables the swift identification of issues that might potentially impact users (API developers and product owners).
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 dashboard has various filters that you can apply depending on what you want to monitor.
webMethods API Gateway dashboard
Displays webMethods API Gateway-wide analytics. You can view the following widgets with detailed information in the webMethods API Gateway dashboard. You can use this information that depends on what you want to monitor:
- Summary
- This widget contains the following information.
- Overall events
- Application activity
- Runtime events
- Payload size
- Activities
- Trends
- This widget contains the following information.
- Event over time
- API trend by success
- API trend by failure
- Overall error trends
- Applications
- This widget contains the following information.
- Events per application
- Violations per application
- Activity rate of consumed packages
- Activity rate of consumed APIs
- Runtime events
- Packages
- This widget contains the following information.
- Package invocations APIs
- Trending subscription for package
- Trending APIs in package
- Threat protection
- This widget contains the following information.
- Threat protection filters
- Threat protection rules
- Threat protection events
- Audit logs
- This widget contains the following information.
- Gateway audit logs
You can use the information in each of the widgets depending on what you want to monitor.
API-specific dashboard
Displays API-specific analytics. You can view the following widgets with detailed information in the API-specific dashboard.
- Events over time
- API invocations
- API invocation - status wise
- Native service performance
- Gateway Vs Provider time
- API Trend by response
- API invocation pattern
- Success Vs Failure
- Response code trend
- Runtime events
- Service cache results
- Method level invocations
You can use the information in each of the widgets depending on what you want to monitor.