Introduction to Monitoring Health with Analytics
You can monitor the health and performance of any API product, route, or application managed by Kong Konnect.
Analytics provides traffic reports to help you track the performance and
behavior of your APIs and data plane nodes. Use these reports to quickly access key
statistics, monitor vital signs, and pinpoint anomalies in real time.
With Konnect Plus Analytics retains historical data for up to 3 months. If you need a longer storage period, contact a sales representative about upgrading to Kong Konnect Enterprise.
Member control planes in a control plane group have no individual analytics reporting. This means that:
- In the Gateway Manager, contextual analytics are logged in the control plane group only.
- When creating custom reports, control planes won’t show up as individual entities.
Reports will only show the control plane group.
Contextual analytics for services and routes
In the Gateway Manager, you can see
activity graphs for gateway services or routes for the past 30 days.
For gateway services and routes, the graphs show requests broken down by status codes.
Figure 1: Graph showing traffic for the last 15 minutes by status code for a gateway service.
You can also export historical data in CSV format from any graph.
Summary dashboard and custom reports
For greater insights into your service usage, access the dedicated Analytics page.
From Analytics, you can view dashboards, access historical data for a range greater than 30 days, and customize the entities in a report:
- View the Analytics summary dashboard to track traffic, errors by error code, and latency across all services in your organization.
Export historical data in CSV format for any individual service.
Create a custom report for any number of services, routes, or applications, filtered by time frame and grouped by metric.
The summary dashboard provides metrics across all services in your organization within a selected time interval for the following categories:
These categories measure trends by comparing metrics across fixed comparable time intervals and plotting the data points. For example, hour-over-hour, day-over-day, week-over-week, and month-over-month.
You can view a graph for each category by clicking Traffic, Errors, or Latency, and switching between the views.
Traffic: This graph displays the total number of HTTP requests categorized by successful and failed requests over the specified time interval.
- Successful requests contain all requests that returned a 1xx-3xx status code.
- Failed requests contain all requests that returned a 4xx-5xx status code.
- 6xx status codes are not reported.
Figure 2: Graph showing successful and failed requests over the past three hours.
Errors: This graph displays the total number of failed HTTP requests categorized by error response codes over the specified time interval. Error response codes include any 4xx-5xx status codes.
Figure 3: Graph showing errors by 4xx and 5xx error codes received over the past three hours.
Latency: This graph displays request latency, in milliseconds, of the 99th, 95th, and 50th percentiles.
Admins can monitor the latency, investigate where delays are noticed, and optimize performance for APIs.
Note: Latency data is only available for requests proxied through a data plane running Kong Gateway 184.108.40.206 or later.
Figure 4: Graph showing latency as a percentage over the past 15 minutes.
Graphs can be interacted with, including hovering over chart items to display more details, and filtering options by clicking on items in the legend.
You can select a time period using the time period drop-down menu. The intervals aggregate data at different increments of time.
Export analytics data
Export API traffic data into a CSV file for any graph in Konnect.
Follow these steps:
- On the graph, click the Export button on the top right.
- Select the time frame to include in the report. To customize the time frame,
click Custom and select a date range.
- Click Export to generate and download a CSV file.
Konnect Analytics limits the number of entities returned and displayed in any activity graph or custom report to only 50 to provide a smooth experience. A warning icon at the top of a graph or report indicates that. Please use custom reports to filter and decrease the number of entities if required.
You can assign Konnect users to specific, predefined Analytic teams. This gives you the ability to allow certain users to only view or manage the Analytics area of your Konnect instance. For more information about the Analytics Admin and Analytics Viewer teams, see the Teams Reference.