Skip to content

Commit d5f6404

Browse files
authored
Merge pull request #580 from mulesoft/W-16869607-key-metrics-mb
W-16869607 key metrics
2 parents 854ff04 + d314203 commit d5f6404

2 files changed

Lines changed: 39 additions & 2 deletions

File tree

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[[key-metrics]]
2+
== Understanding Key Metrics
3+
4+
The *Key Metrics* section of the API summary contains the following charts:
5+
6+
Total Requests::
7+
Sum of requests in the selected time period for the given API.
8+
+
9+
Data is aggregated in one minute increments.
10+
11+
Total Policy Violations::
12+
Sum of requests that return policy violations.
13+
+
14+
Data is aggregated in one minute increments.
15+
16+
Total Errors::
17+
Sum of HTTP response codes that occur in the selected time period. The response codes counted in this metric are 400, 401, 402, 403, 404, 405, 408, 409, 410, 411, 412, 413, 415, 416, 417, 420, 422, 429, 500, 502, 503, 504, 504, 510, and 511.
18+
+
19+
Data is aggregated in one minute increments. In the chart, HTTP response codes are abbreviated as 4xx and 5xx.
20+
21+
Average Response Time::
22+
Average response time of requests in the selected time period for the given API.
23+
+
24+
Data is aggregated in one minute increments.
25+
26+
27+
== Setting the Time Period for Key Metrics
28+
29+
You can view the data points collected for the last given period of time (such as the last 5 or 30 minutes) or over a given date and time range. Use the drop-down in the calendar icon to select the time period to display.

modules/ROOT/pages/latest-overview-concept.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,21 @@ see xref:api-contracts-landing-page.adoc[].
109109

110110
=== API Instances
111111

112-
An API instance describes a configuration of an API that is deployed on one of the following runtimes: Flex Gateway, Mule Gateway, or Anypoint Service Mesh. API instances are managed by API Manager after they are created by using the add, promote, or import options. API instances remain under management until they are deleted.
112+
An API instance describes a configuration of an API that is deployed on one of the following runtimes: Flex Gateway, Mule Gateway, or Anypoint Service Mesh. API instances are managed by API Manager after they are created by using the add, promote, or import options. API instances remain under management until they are deleted. To view the API Summary for an API instance, click the API instance name.
113+
114+
For more detail, see xref:api-instance-landing-page.adoc[].
115+
116+
=== API Summary
113117

114118
The API Summary shows key information about a deployed API instance:
115119

116120
image::api-instance-summary.png[API Summary page]
117121

118-
For details, see xref:api-instance-landing-page.adoc[].
122+
=== Key Metrics
123+
124+
The API Summary page includes a Key Metrics section.
125+
126+
include::partial$key-metrics.adoc[leveloffset=+2]
119127

120128
=== API Alerts
121129

0 commit comments

Comments
 (0)