IP Traffic & Time Metrics
This report appears as the IP Traffic Metrics sub-report under the Clients tab of the Metrics page. It lists, in a tree structure, the IP addresses generating traffic in the selected environment, which API Proxies each IP used, and which endpoints it called under each of those proxies; it also shows the request counts and the time the request spent inside the gateway (Min./Max./Avg.) for every level.
Since an API Proxy can be loaded into multiple environments, metrics must also be evaluated according to the environment it is loaded into. Therefore, in all analytics screens, metrics are filtered by first selecting environment information.
Metric data cannot be displayed for environments where Elasticsearch integration is not configured. In this case, a warning message is displayed on the screen.
Filtering
The filter row at the top of the Metrics page is shared across all sub-reports:
| Option | Description |
|---|---|
| Environment Selection | You can select the environment you want to see metrics for |
| Project Selection | (Only in the Admin menu) You can filter metrics by selecting multiple projects |
| Date Range | You can determine the time range you want to see your metrics for (default: last 1 hour) |
| Refresh Button | Re-queries and updates the data for the currently displayed report only |
The sub-report row also includes an Export to Excel button that exports the data of the currently displayed report.
Table Column Descriptions
The table is a tree structure keyed by IP address: the arrow icon on the left of each row expands/collapses one level below it.
- Level 1 (root row): An IP address that generated traffic.
- Level 2: An API Proxy that IP address sent requests to.
- Level 3 (deepest level): An endpoint (method/endpoint) under that API Proxy that the IP called.
The columns are grouped into six sections.
Information
| Column | Description |
|---|---|
| IP Address / API Proxy / Method | Its meaning depends on the row's tree depth: at the root row it shows the IP address, when expanded it shows the API Proxy names underneath it, and when an API Proxy row is expanded it shows the endpoint (method/endpoint) name called under that proxy |
| Project (Admin menu only) | Name of the project the API Proxy belongs to; populated only on the API Proxy row, blank on the IP and endpoint rows |
Traffic Metrics (count)
Number of requests, for the node (IP / API Proxy / endpoint) on that row, in the selected environment and date range, by result:
| Column | Description |
|---|---|
| Successful | Number of requests resulting in a successful response |
| Blocked | Number of requests blocked by policies (e.g., security, rate limiting) |
| Error | Number of requests resulting in an error |
| Total | Sum of Successful + Blocked + Error |
Request Pipeline Time (ms)
Processing time of the request policies the request passes through after reaching the gateway and before being routed to the backend:
| Column | Description |
|---|---|
| Min. | Shortest time measured in this segment (ms) |
| Max. | Longest time measured in this segment (ms) |
| Avg. | Average time measured in this segment (ms) |
Routing Time (ms)
Time elapsed from sending the request to the backend until the response is received back (backend round-trip time):
| Column | Description |
|---|---|
| Min. | Shortest time measured in this segment (ms) |
| Max. | Longest time measured in this segment (ms) |
| Avg. | Average time measured in this segment (ms) |
Response Pipeline Time (ms)
Processing time of the response policies the response coming back from the backend passes through before being delivered to the client:
| Column | Description |
|---|---|
| Min. | Shortest time measured in this segment (ms) |
| Max. | Longest time measured in this segment (ms) |
| Avg. | Average time measured in this segment (ms) |
Total Time (ms)
Sum of Request Pipeline + Routing + Response Pipeline times; the total time from the request reaching the gateway until the response is returned to the client:
| Column | Description |
|---|---|
| Min. | Shortest total time measured for this node (ms) |
| Max. | Longest total time measured for this node (ms) |
| Avg. | Average total time measured for this node (ms) |