Azure logs for failed Azure APIM requests

Question

We are using Azure APIM for using the APIs , From backend we send geneic response such as

{ 
   "result" :[
    .....
     ],
    "status": {
        "code": 500,
        "message": "Internal Error due to xyz"
    }
}

And i want a record to see what are the different types of 500 errors we are getting at one place and its frequency.

Where in azure i can log these things or can show these things at one place.

Answer 1

To retrieve logs for failed Azure API Management (APIM) requests, you can use Azure Monitor Logs. Azure Monitor provides a centralized logging and monitoring solution for Azure resources, including APIM. Here's an overview of the steps involved:

1. Enable diagnostics logs for Azure API Management which will send the logs to Azure Monitor.

2. Create Log Analytics workspace which will be used to store the log data collected from APIM.

3. Configure diagnostic settings

   1. Go to your APIM instance in the Azure portal, navigate to the "Diagnostics settings" section, and create a new diagnostic setting.
   2. Choose the appropriate log categories, such as "GatewayLogs," "BackendLogs," or "EventHub."
   3. Select the Log Analytics workspace you created in the previous step as the destination for the logs.

4. Query logs: Once the logs are ingested into the Log Analytics workspace, you can query them using Azure Monitor Logs. Here's an example query to retrieve failed APIM requests:

    AzureDiagnostics
             | where ResourceType == "APIManagementGateway"
             | where OperationName == "GatewayLogs"
             | where ResponseStatus_s == "Failed"

5. View logs and export results: Execute the query, and the logs containing failed APIM requests will be displayed in the Azure Monitor Logs query editor.