Advanced Analytics Explorer

Uses: Kong Gateway Advanced Analytics
Related Documentation
OpenAPI Specifications
Incompatible with
on-prem
Tags

The Explorer interface displays API usage data gathered by Konnect Analytics from your Data Plane nodes. You can use this tool to:

The Analytics Explorer also lets you save the output as a custom report.

Enabling data ingestion

Manage data ingestion from any Control Plane Dashboard using the Advanced Analytics toggle. This toggle lets you enable or disable data collection for your API traffic per Control Plane.

Modes:

  • On: Both basic and advanced analytics data is collected, allowing in-depth insights and reporting.
  • Off: Advanced analytics collection stops, but basic API metrics remain available in Gateway Manager, and can still be used for custom reports.

Metrics

Traffic metrics provide insight into which of your Services are being used and how they are responding. Within a single report, you have the flexibility to choose one or multiple metrics from the same category.

Metric

Category

Description

Request Count Count Total number of API calls within the selected time frame. This includes requests that were rejected due to rate limiting, failed authentication, and so on.
Requests per Minute Rate Number of API calls per minute within the selected time frame.
Response Latency Latency The amount of time, in milliseconds, that it takes to process an API request. Users can select between average (avg) or different percentiles (p99, p95, and p50). For example, a 99th percentile response latency of 10 milliseconds means that every 1 in 100 requests took at least 10 milliseconds from request received until response returned.
Upstream Latency Latency The amount of time, in milliseconds, that Kong Gateway was waiting for the first byte of the upstream service response. Users can select between different percentiles (p99, p95, and p50). For example, a 99th percentile response latency of 10 milliseconds means that every 1 in 100 requests took at least 10 milliseconds from sending the request to the upstream service until the response returned.
Kong latency Latency The amount of time, in milliseconds, that Kong Gateway was waiting for the first byte of the upstream service response. Users can select between different percentiles (p99, p95, and p50). For example, a 99th percentile response latency of 10 milliseconds means that every 1 in 100 requests took at least 10 milliseconds from the time the Kong Gateway received the request up to when it sends it back to the upstream service.
Request Size Size The size of the request payload received from the client, in bytes. Users can select between the total sum or different percentiles (p99, p95, and p50). For example, a 99th percentile request size of 100 bytes means that the payload size for every 1 in 100 requests was at least 100 bytes.
Response Size Size The size of the response payload returned to the client, in bytes. Users can select between the total sum or different percentiles (p99, p95, and p50). For example, a 99th percentile response size of 100 bytes means that the payload size for every 1 in 100 response back to the original caller was at least 100 bytes.

Time intervals

The time frame selector controls the time frame of data visualized, which indirectly controls the granularity of the data. For example, the “5M” selection displays five minutes in one-second resolution data, while longer time frames display minute, hour, or days resolution data.

  • Relative time frames are dynamic and the report captures a snapshot of data relative to when a user views the report.
  • Custom time frames are static and the report captures a snapshot of data during the specified time frame. You can see the exact range below the time frame selector. For example:

     Jan 26, 2023 12:00 AM - Feb 01, 2023 12:00 AM (PST)
    

The following table describes the time intervals you can select:

Interval

Aggregation increment frequency

Notes

Last 15 minutes 1 minute Data is aggregated in one minute increments.
Last hour 1 minute Data is aggregated in one minute increments.
Last six hours 1 minute Data is aggregated in one minute increments.
Last 12 hours 1 hour Data is aggregated in one hour increments.
Last 24 hours 1 hour Data is aggregated in one hour increments.
Last seven days 1 hour Data is aggregated in one hour increments.
Last 30 days Daily Data is aggregated in daily increments.
Current week 1 hour Logs any traffic in the current calendar week.
Current month 1 hour Logs any traffic in the current calendar month.
Previous week 1 hour Logs any traffic in the previous calendar week.
Previous month Daily Logs any traffic in the previous calendar month.

System-defined groups

Empty is an optional, system-defined group that indicates that API calls don’t have an entity like Consumers or Routes, selected for grouping. Empty allows you to group API calls that don’t match specific groupings so you can gain more comprehensive insights. You can filter by Is Empty or Is Not Empty.

Some common use cases for Empty include:

  • Identifying the number of API calls that don’t match a Route.
  • Identifying API calls without an associated Consumer to keep track of any security holes.

FAQs

  • API
  • API Product
  • API Product Version
  • Application
  • Consumer
  • Control Plane
  • Control Plane Group
  • Data Plane Node
  • Data Plane Node Version
  • Gateway Services
  • Response Source
  • Portal
  • Route
  • Status Code
  • Status Code Group
  • Upstream Status Code
  • Upstream Status Code Group

“None” is a field that can capture data that doesn’t belong to a specific category.

  • Save as a Report: This function creates a new custom report based on your current view, allowing you to revisit these specific insights at a later time.
  • Export as CSV: If you prefer to analyze your data using other tools, you can download the current view as a CSV file, making it portable and ready for further analysis elsewhere.
Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!