Wiki source code of HTTP Statistics

Last modified by Eva Torken on 2023/10/06 15:17
Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2
3 {{warning}}
4 Please note that this Microlearning is for the new monitoring stack only.
5 {{/warning}}
6
7 In your API Gateway solution, it is important to be able to review the API Gateway operation statistics. These statistics show the overall status of request and reponses to your API Gateway and will provide support whilst monitoring your solution.
8
9 Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
10
11
12 == 1. Prerequisites ==
13 * Advanced knowledge of the eMagiz platform
14 * Complete relevant API Gateway microlearnings from Crash course to Intermediate
15
16 == 2. Key concepts ==
17 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.
18
19 == 3. Monitoring HTTP Statistics metrics ==
20
21 Below the various insights provided for HTTP traffic on an API Gateway.
22
23 === 3.1 Dashboard metrics ===
24
25 When browsing to the HTTP Statistics page, accessible via the Manage - Monitoring section, you can find a view similar to the one below.
26
27 [[image:Main.Images.Microlearning.WebHome@advanced-monitori-apigw-http-statistics-1.png]]
28
29 These are the key explainations for this view:
30
31 * Problematic requests display request from API callers that contain 1 or more unsuccessful requests
32 * All request displays all requests made in a certain interval
33 * For both view you can filter our specific API Callers to zoom in to. Use the reverse hourglass on the column header
34 * In the two graphs, you can find out the spread of successful and unsuccessful requests throught time.
35 * The time interval for research can be found at the top right of the 4 quadrants
36
37 === 3.2 Key metrics ===
38
39 Once you click on a specific API resource, you will drill down into the data. The page that follows is divided into two sections. The first one is key metrics which is described below. The other sections called "Other metrics" is explained in the expert level microlearnings.
40
41 [[image:Main.Images.Microlearning.WebHome@advanced-monitori-apigw-http-statistics-2.png]]
42
43 ==== 3.2.1 Request per user ====
44 In this view, one can see what users have used this API operation within the time interval selected. The users are listed on the horizontal axis, and each bar represents the number of requests of that user. The filtering allows to make selections of users in case there are many users that have made the request within the interval selected.
45
46 [[image:Main.Images.Microlearning.WebHome@advanced-monitori-apigw-http-statistics-7.png]]
47
48 ==== 3.2.2 Request methods ====
49 In this view, one can see the number of HTTP methods (GET, POST, PUT, etc) through time. The colored line represent the methods, and the count is listed in the Y-axis. The filtering allows to update the view based on selection of resource, user, method and response code.
50
51 [[image:Main.Images.Microlearning.WebHome@advanced-monitori-apigw-http-statistics-4.png]]
52
53 ==== 3.2.3 User request ====
54 In this view, one can see the time in which users make requests. To allow the analysis of request through time, and to identify what users have done when. The filtering allows to update the view based on selection of resource, user, method and response code.
55
56 [[image:Main.Images.Microlearning.WebHome@advanced-monitori-apigw-http-statistics-6.png]]
57
58 ==== 3.2.4 Response status ====
59 In this view, the HTTP response codes can be analyzed. The colored lines represent the different response codes - the Y-axis contains the number - the X-axis the time interval selected. The view helps to analyze what requests have a code 403 for instance, which users and/or methods where involved.
60
61 [[image:Main.Images.Microlearning.WebHome@advanced-monitori-apigw-http-statistics-5.png]]
62
63 === 3.3 Other metrics ===
64
65 The other metrics provide some additional insights beyond the key metrics. These can be used for specific scenario's to monitor the HTTP traffic. Below the various graphs offered.
66
67 ==== 3.3.1 Response times ====
68 This graph shows the maximum time measured for a request and the average time of a request. The values are handy to see what the total time from start of the request made by the API user to the moment the response is received by the API user.
69
70 [[image:Main.Images.Microlearning.WebHome@advanced-monitori-apigw-http-statistics-3.png]]
71
72 == 4. Key takeaways ==
73
74 * The landing page for HTTP statistics contains an overview of the successful and unsuccesful request as a starting point for futher analysis
75 * The key metrics provide more insights into the different aspects of a request such as users, methods, reponses and resources
76 * Using the drag and select option, it is easy to zoom in. Using the time interval selector specific timings can be selected to support analysis
77
78 == 5. Suggested Additional Readings ==
79
80 There is no additional readings for this microlearning.
81 )))((({{toc/}}))){{/container}}{{/container}}