Skip to Content
Last modified by Erik Bakker on 2024/02/22 12:35
From version 3.2
edited by Erik Bakker
on 2022/06/23 15:16
Change comment: Update document after refactoring.
To version 1.1
edited by Erik Bakker
on 2022/06/13 11:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -advanced-active-monitoring-determining-cause-of-log-entry
1 +advanced-monitoring-apigateway-statistics
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Advanced Level.Advanced monitoring.WebHome
1 +Main.eMagiz Academy.Microlearnings.Advanced Level.Advanced monitoring API Gateway.WebHome
Content
... ... @@ -1,8 +1,13 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In your API Gateway solution, it is important to be able to review the API Gateway statistics. These statistics are available in Generation 3 based runtimes, and available via the Manage phase -> Monitoring Gen3
3 3  
3 +# Monitoring API Gateway statistics
4 +In your API Gateway solution, it is important to be able to review the API Gateway statistics. These statistics are available in Generation 3 based runtimes, and available via the Manage phase --> Monitoring Gen3
5 +
4 4  Should you have any questions, please get in touch with academy@emagiz.com.
5 5  
8 +* Last update: March 17th, 2022
9 +* Required reading time: 5 minutes
10 +
6 6  == 1. Prerequisites ==
7 7  * Advanced knowledge of the eMagiz platform
8 8  * Complete relevant API Gateway microlearnings from Crash course to Intermediate
... ... @@ -10,47 +10,52 @@
10 10  == 2. Key concepts ==
11 11  The API Gateway statistics are geared towards understanding the level of interaction between the API callers and the webservice of the API gateway. With the objective to understand the bredth and depth of the usage of the operations published
12 12  
13 -== 3. API gateway statistics ==
14 14  
19 +
20 +
21 +## 3. API gateway statistics
22 +
15 15  Navigate to the Manage phase and select Monitoring Gen3. On the left hand side select API Management Statistics which opens a page as below. Ensure to select for what environment you want to see these statics
16 16  
17 17  [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-1.png]]
18 18  
19 -=== 3.1 API Requests ===
27 +### 3.1 API Requests
20 20  This section displays the total number of requests made to the API Gateway. Can be valuable to understand if in a give timeframe requests are made or not. It contains all the requests * other sections will illustrate which requests more specifically.
21 21  
22 22  [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-7.png]]
23 23  
24 -=== 3.2 Static resource request ===
32 +### 3.2 Static resource request
25 25  This shows the number of request made by the SwaggerUI which is considered a static resource. This can help to understand how often that SwaggerUI is used.
26 26  
27 27  [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-8.png]]
28 28  
29 -=== 3.3 Status per user ===
37 +### 3.3 Status per user
30 30  This displays per application user what the HTTP response codes where. Based on that response code insight is provided around the behavior of that user such as unauthorized requests. Users are identified by part of their access credential (first part of API key or Client ID).
31 31  
32 32  [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-6.png]]
33 33  
34 -=== 3.4 Resources per user ===
42 +### 3.4 Resources per user
35 35  This displays per applciation user what resources are specifically used by that user. The colors indicate the resource which are listed as legend to the graph. By selecting a resource in the legend, you can toggle that resource to not display. The graph shows the total number of requests made.
36 36  
37 37  [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-5.png]]
38 38  
39 -=== 3.5 Status per resource ===
47 +### 3.5 Status per resource
40 40  This display shows the HTTP response codes for every resource/operation available. Could help to understand the health and/or the validity of the operation for the application users.
41 41  
42 42  [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-2.png]]
43 43  
44 -=== 3.7 Methods per resource ===
52 +### 3.7 Methods per resource
45 45  Shows what HTTP methods are used for every resource/operation
46 46  
47 47  [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-3.png]]
48 48  
49 -=== 3.8 Status for status resource / methods per static resource ===
57 +### 3.8 Status for status resource / methods per static resource
50 50  Shows the HTTP response codes and what HTTP methods are used by the Swagger UI
51 51  
52 52  [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-4.png]]
53 53  
62 +
63 +
54 54  == 4. Assignment ==
55 55  
56 56  Take a moment to review your API Gateway solution and find the Manage * Montoring section to see the API management metrics. Review if you can understand these values
... ... @@ -60,6 +60,8 @@
60 60  * The API Management statistics are geared towards understanding the actual use of the API gateway.
61 61  * That insight is handy to understand who does what and how often. Yet can also be used for trouble shooting.
62 62  
73 +
74 +
63 63  == 6. Suggested Additional Readings ==
64 64  
65 65  If you are interested in this topic and want more information, please read the release notes provided by eMagiz.