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