Category | Metric | Description |
Summary | Overall events | Displays a pie chart that lists different events being monitored and each of these event categories is depicted with different colors. |
Application activity | Displays the application activity in API Gateway during the specified time. | |
Runtime events | Displays the run time event details such as time when the event was generated, API Name, the application that generated the event, event type, description of the alert generated due to the event, status, and the source of event. | |
Payload size | Displays the payload size of the request and responses during data transfer in the specified time. This data is picked up from the transactional event that is triggered when a log invocation policy is applied to the API. | |
Package performance | Displays a pie chart depicting package performance during the specified time. The different colors in the pie chart depict different packages this API belongs to. | |
Trends | Events over time | Displays the trending of events generated by the APIs across API Gateway over time. |
API trend by success | Displays the trending of APIs based on their success rate in the performance metrics. | |
API trend by failure | Displays the trending of APIs based on their failure rate in the performance metrics. | |
Overall error trends | Displays a graph depicting the performance of all the APIs in the system based on the error event generated. Each of these event categories is depicted with different colors. | |
Applications | Events per application | Displays a pie chart that depicts the activity of events per application being monitored and each of these categories is depicted with different colors. |
Violations per application | Displays the number of violations per application based on the events generated such as monitoring, SLA violation, and policy violations. | |
Activity rate of consumed packages | This bar chart displays the package that the selected application has consumed (when an application is chosen in the filter). Hover the cursor over the bar chart to see the number of invocations to the package using the specified application. | |
Activity rate for consumed APIs | Displays the activity rate for all the APIs that are consumed by the application during the specified time. | |
Runtime events | Displays the run time event details such as API Name, event type, date when the event was created, the agent on which the event was generated, description of the alert generated due to the event, the source of event, and the application that generated the event. | |
Packages | Package invocations | Displays the number of package invocations during the specified time. |
Trending subscription for package | Displays the trending subscriptions for the package based on the number of invocations. The different colors in the donut pie chart depict the trending behavior of the different applications in the package. | |
Trending APIs in the package | Displays the number of invocations for an API for an application for the selected package over the specified time interval. | |
Threat protection | Threat protection filters | Displays the graphical representation of the events based on the filter violations during the specified time. |
Threat protection rules | Displays the graphical representation of the events based on the rule violations during the specified time. | |
Threat protection events | Displays the threat protection event details such as Time, filter name, rule name, resource path, server host, and request time. | |
Audit logs | Time | Displays the time the event occurred. |
User | Displays the name of the user who caused the event. | |
Status | Displays the current status of the transaction. The available values are: SUCCESS FAILURE | |
Source machine | Displays the host name of the machine on which the event occurred. | |
Object type | Displays the type of API Gateway object on which the event occurred. The available values are: ACCESS_PROFILE_MANAGEMENT ALIAS_MANAGEMENT ANALYTICS_MANAGEMENT API_MANAGEMENT APPLICATION_MANAGEMENT APPROVALS_MANAGEMENT GROUPS_MANAGEMENT PACKAGE_MANAGEMENT PLAN_MANAGEMENT PROMOTION_MANAGEMENT POLICY_MANAGEMENT USER_MANAGEMENT | |
Object | Displays the UUID that uniquely identifies the object in the database. | |
Message | Displays the success message or error message as a result of the event. | |
Client IP address | Displays the IP address of the machine on which the event occurred. | |
Action | Displays the type of action for the event. The available values are: LOGIN LOGOUT CREATE UPDATE DELETE ACTIVATE DEACTIVATE | |
Payload | Displays the content of data payload for the event. | |
Cache statistics: | Cache counts | Displays the hit, miss, and eviction count for API invocations across API Gateway. |
Cache usage statistics | Displays the cache usage size and the free size as a bar chart. | |
Application logs | Application logs saved search | Displays a table that lists the cumulative logs collected across sources with details of each log that is collected in the time interval specified in the filter. These are the details displayed in the form of a table: Time. Specifies the date and time when the log was collected. node. Specifies the node from which the log is generated. fileType. Specifies the file type to which the logs belong. The following are the file types to which a log can belong: APIGatewayServerLogs APIGatewayUILogs PlatformLogs OSGILogs WrapperLogs InternalDataStoreLogs DashboardLogs logLevel. Specifies the log level. message. Displays the actual message for the event for which the log was saved. correlationId. Specifies the correlation id that applies to the API Gateway server logs with which you can identify a particular request. You can expand each entry to view details of the actual log in the tabular or a JSON format. In addition you can create a filter to display the logs based on their id, index, type, correlation id, and so on. This helps in analyzing the events effectively. |
Source vs log level | Displays the log data per source per log level for the specified time interval. The data is displayed in the form of a pie chart. Hover the cursor over the piechart to view the following details. The inner section of the pie chart displays the number of logs collected per file type. The corresponding outer section displays the log levels for the logs collected for that file type. | |
Log level tag cloud | Displays the log levels available and shortcut filters to filter the logs by log levels. Click on one of the log levels. You now see the logs for the specified log level in the table under Application logs saved search and the distribution of the selected logs per sources that produced them in the pie chart under Source vs log level. | |
API usage details | API Gateway invocation usage | This bar chart displays the trending of API invocations across API Gateway. Hover the cursor over the bar chart to see the number of API invocations for the current month. |
API Gateway invocation usage details | Displays the details of the number of API invocations for each month. | |
API usage details | Displays the API invocation details for each API such as API Name, API usage for each month and year. |