Skip to Content
Version 3.2 by Erik Bakker on 2022/06/23 15:16
Hide last authors
Erik Bakker 1.1 1 {{container}}{{container layoutStyle="columns"}}(((
Erik Bakker 2.1 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
Erik Bakker 1.1 3
4 Should you have any questions, please get in touch with academy@emagiz.com.
5
6 == 1. Prerequisites ==
7 * Advanced knowledge of the eMagiz platform
8 * Complete relevant API Gateway microlearnings from Crash course to Intermediate
9
10 == 2. Key concepts ==
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
Erik Bakker 2.1 13 == 3. API gateway statistics ==
Erik Bakker 1.1 14
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
17 [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-1.png]]
18
Erik Bakker 2.1 19 === 3.1 API Requests ===
Erik Bakker 1.1 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
22 [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-7.png]]
23
Erik Bakker 2.1 24 === 3.2 Static resource request ===
Erik Bakker 1.1 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
27 [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-8.png]]
28
Erik Bakker 2.1 29 === 3.3 Status per user ===
Erik Bakker 1.1 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
32 [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-6.png]]
33
Erik Bakker 2.1 34 === 3.4 Resources per user ===
Erik Bakker 1.1 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
37 [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-5.png]]
38
Erik Bakker 2.1 39 === 3.5 Status per resource ===
Erik Bakker 1.1 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
42 [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-2.png]]
43
Erik Bakker 2.1 44 === 3.7 Methods per resource ===
Erik Bakker 1.1 45 Shows what HTTP methods are used for every resource/operation
46
47 [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-3.png]]
48
Erik Bakker 2.1 49 === 3.8 Status for status resource / methods per static resource ===
Erik Bakker 1.1 50 Shows the HTTP response codes and what HTTP methods are used by the Swagger UI
51
52 [[image:Main.Images.Microlearning.WebHome@advanced-monitoring-apigateway-statistics-4.png]]
53
54 == 4. Assignment ==
55
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
57
58 == 5. Key takeaways ==
59
60 * The API Management statistics are geared towards understanding the actual use of the API gateway.
61 * That insight is handy to understand who does what and how often. Yet can also be used for trouble shooting.
62
63 == 6. Suggested Additional Readings ==
64
65 If you are interested in this topic and want more information, please read the release notes provided by eMagiz.
66
67 == 7. Silent demonstration video ==
68
69 As this is a more theoretical microlearning, we have no video that accompanies this microlearning.)))((({{toc/}}))){{/container}}{{/container}}