azure-application-insights.md

Azure Application Insights

Data related to the quantities of requests made against our API as well as response times. These logs can also be used to identify bottlenecks in performance and to determine endpoint metric data such as the most commonly used endpoints.

Setup

An HMPPS Azure account will be required to access application insights, please follow the HMPPS documentation. During this process you will be required to add an entry to a configuration file, it's recommended that you use an entry from someone else on the HMPPS Integration API as a template for your own.

Here's an example of a previous PR.

Steps

1. Log in to the Application Insights dashboard
2. Select an environment
   1. dev: nomisapi-t3
   2. preprod: nomisapi-preprod
   3. prod: nomisapi-prod
3. Select Logs within the window
4. Either select a preset query, or close the window to write your own
5. Filter the query on the following | where cloud_RoleName = 'hmpps-integration-api'. This will restrict the query to only display data for the HMPPS Integration API.

Example Use Case

We'd like to check how a particular endpoint is performing. Using a query such as the Operations Performance query. We can look at average response times for a given endpoint. This is beneficial as it removes any one user's networking as a factor and looks at the full data set of consumers.