Viewing Key Metrics for Flex Gateway APIs
API Manager and Anypoint Monitoring collect metrics on active Flex Gateway API instances. You can view charts related to these metrics and filter the data by date.
The metrics avaliable in API Manager are considered Key Metrics and are described here. Key Metrics are available with all Anypoint Platform subscriptions. For additional Flex Gateway API metrics not included in the Key Metrics section, use Anypoint Monitoring (Titanium subscriptions only). You can navigate to Anypoint Monitoring by clicking Anypoint Monitoring from Anypoint Platform.
|
The Mule API Analytics tab in API Manager is currently not available for Flex Gateway APIs. Use the Key Metrics or the additional metrics in Anypoint Monitoring. |
Key Metrics
-
Log in to Anypoint Platform.
-
In the navigation bar or the Anypoint Platform page, click API Manager.
The API Administration page appears, showing a list of APIs that are available in your organization. -
Click the API instance.
The API Summary page appears, showing general information and the status of the API instance.To see an API instance in Anypoint Monitoring, from the Key Metrics section click View more metrics in Anypoint Monitoring dashboard or navigate to Anypoint Monitoring directly.
The Key Metrics section shows four charts. If charts do not appear for your API instance, refresh your browser.
Understanding Key Metrics
The Key Metrics section of the API summary contains the following charts:
- Total Requests
-
Sum of requests in the selected time period for the given API.
Data is aggregated in one minute increments.
- Total Policy Violations
-
Sum of requests that return policy violations.
Data is aggregated in one minute increments.
- Total Errors
-
Sum of HTTP response codes that occur in the selected time period. The response codes counted in this metric are 400, 401, 402, 403, 404, 405, 408, 409, 410, 411, 412, 413, 415, 416, 417, 420, 422, 429, 500, 502, 503, 504, 504, 510, and 511.
Data is aggregated in one minute increments. In the chart, HTTP response codes are abbreviated as 4xx and 5xx.
- Average Response Time
-
Average response time of requests in the selected time period for the given API.
Data is aggregated in one minute increments.
Setting the Time Period for Key Metrics
You can view the data points collected for the last given period of time (such as the last 5 or 30 minutes) or over a given date and time range. Use the drop-down in the calendar icon to select the time period to display.
What’s Next?
-
Create alerts using the metrics related to an API instance with the Alerts feature in API Manager or with the Basic Alerts feature in Anypoint Monitoring.
-
View built-in API dashboards in Anypoint Monitoring where you can see additional metrics, filter data by date, and export data into a CSV (Titanium subscriptions only).