Ana içeriğe geç

IP Traffic & Time Metrics

Metrics — Clients tab, IP Traffic Metrics sub-report, blurred IP, and expanded API Proxy rows
Info

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.

Warning

Metric data cannot be displayed for environments where Elasticsearch integration is not configured. In this case, a warning message is displayed on the screen.

Metrics Page

This report is the IP Traffic Metrics sub-report on the Clients tab of the Metrics page (documented as IP Traffic & Time Metrics). Open it via Administration > Reports > Metrics or Analytic > Reports > Metrics in the project menu, then select IP Traffic Metrics on the Clients tab.

The table is a three-level tree keyed by IP; expand an IP row to see API Proxies it used and drill down to method/endpoint breakdown.

Filtering

The filter row at the top of the Metrics page is shared across all tabs and sub-reports:

OptionDescription
EnvironmentSelect the environment whose metrics you want to view
Project(Administration only) Filter metrics by selecting multiple projects
Date RangeTime range for metric calculation (default: last 1 hour)
RefreshRe-queries the currently displayed sub-report
Excel ExportExport on the shared filter row; downloads the list for the active sub-report

Report-specific filters

Visible on the sub-report row only while IP Traffic Metrics is selected:

OptionDescription
IP AddressLimit results to a specific IP address
ProxyLimit results to selected API Proxies

The sub-report row includes Choose Your Refresh Time (default: Manual) and a refresh button.

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

ColumnDescription
IP AddressClient IP at the root row; API Proxy name or method/endpoint path at lower levels
Project(Administration only) Project name on API Proxy rows; blank on the IP root row

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:

ColumnDescription
SuccessfulNumber of requests resulting in a successful response
BlockedNumber of requests blocked by policies (e.g., security, rate limiting)
ErrorNumber of requests resulting in an error
TotalSum 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:

ColumnDescription
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):

ColumnDescription
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:

ColumnDescription
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:

ColumnDescription
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)