You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/api-management-howto-api-inspector.md
+78-80Lines changed: 78 additions & 80 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,16 @@
1
1
---
2
-
title: Tutorial - Debug APIs in Azure API Management using request tracing
2
+
title: "Tutorial: Debug APIs in Azure API Management using request tracing"
3
3
description: Follow the steps of this tutorial to enable tracing and inspect request processing steps in Azure API Management.
4
4
services: api-management
5
5
author: dlepow
6
6
ms.service: azure-api-management
7
7
ms.topic: tutorial
8
-
ms.date: 11/04/2024
8
+
ms.date: 01/28/2026
9
9
ms.author: danlep
10
10
ms.custom:
11
11
- devdivchpfy22
12
12
- sfi-image-nochange
13
+
#customer intent: As a developer who works with Azure API Management, I need to understand request tracing in order to troubleshoot APIs.
13
14
---
14
15
15
16
# Tutorial: Debug your APIs using request tracing
@@ -23,18 +24,17 @@ This tutorial describes how to inspect (trace) request processing in Azure API M
23
24
In this tutorial, you learn how to:
24
25
25
26
> [!div class="checklist"]
26
-
> * Trace an example call in the test console
27
-
> * Review request processing steps
28
-
> * Enable tracing for an API
27
+
> - Trace an example call in the test console
28
+
> - Review request processing steps
29
+
> - Enable tracing for an API
29
30
30
31
:::image type="content" source="media/api-management-howto-api-inspector/api-inspector-002.png" alt-text="Screenshot showing the API inspector." lightbox="media/api-management-howto-api-inspector/api-inspector-002.png":::
31
32
32
33
## Prerequisites
33
34
34
-
+ Learn the [Azure API Management terminology](api-management-terminology.md).
35
-
+ Complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md).
36
-
+ Complete the following tutorial: [Import and publish your first API](import-and-publish.md).
37
-
35
+
- Learn the [Azure API Management terminology](api-management-terminology.md).
36
+
- Complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md).
37
+
- Complete the following tutorial: [Import and publish your first API](import-and-publish.md).
@@ -49,30 +49,28 @@ Follow these steps to trace an API request in the test console in the portal. Th
49
49
1. Select the **Find pet by ID** operation.
50
50
1. In the *petId***Query parameter**, enter *1*.
51
51
1. Optionally check the value for the **Ocp-Apim-Subscription-Key** header used in the request by selecting the "eye" icon.
52
-
> [!TIP]
53
-
> You can override the value of **Ocp-Apim-Subscription-Key** by retrieving a key for another subscription in the portal. Select **Subscriptions**, and open the context menu (**...**) for another subscription. Select **Show/hide keys** and copy one of the keys. You can also regenerate keys if needed. Then, in the test console, select **+ Add header** to add an **Ocp-Apim-Subscription-Key** header with the new key value.
54
52
55
-
1. Select **Trace**.
53
+
> [!TIP]
54
+
>
55
+
> You can override the value of **Ocp-Apim-Subscription-Key** by retrieving a key for another subscription in the portal. Select **Subscriptions**, and open the context menu (**...**) for another subscription. Select **Show/hide keys** and copy one of the keys. You can also regenerate keys if needed. Then, in the test console, select **+ Add header** to add an **Ocp-Apim-Subscription-Key** header with the new key value.
56
56
57
+
1. Select **Trace**.
57
58
58
59
## Review trace information
59
60
60
-
1. After the call completes, go to the **Trace** tab in the **HTTP response**.
61
+
1. After the call completes, go to the **Trace*- tab in the **HTTP response**.
61
62
1. Select any of the following links to jump to detailed trace info: **Inbound**, **Backend**, **Outbound**, **On error**.
***Inbound** - Shows the original request API Management received from the caller and the policies applied to the request. For example, if you added policies in [Tutorial: Transform and protect your API](transform-api.md), they appear here.
66
-
67
-
***Backend** - Shows the requests API Management sent to the API backend and the response it received.
64
+
:::image type="content" source="media/api-management-howto-api-inspector/response-trace-1.png" alt-text="Screenshot showing the review response trace.":::
68
65
69
-
***Outbound** - Shows the policies applied to the response before sending back to the caller.
70
-
71
-
***On error** - Shows the errors that occurred during the processing of the request and the policies applied to the errors.
72
-
73
-
> [!TIP]
74
-
> Each step also shows the elapsed time since the request is received by API Management.
66
+
-**Inbound** - Shows the original request API Management received from the caller and the policies applied to the request. For example, if you added policies in [Tutorial: Transform and protect your API](transform-api.md), they appear here.
67
+
-**Backend** - Shows the requests API Management sent to the API backend and the response it received.
68
+
-**Outbound** - Shows the policies applied to the response before sending back to the caller.
69
+
-**On error** - Shows the errors that occurred during the processing of the request and the policies applied to the errors.
75
70
71
+
> [!TIP]
72
+
>
73
+
> Each step also shows the elapsed time since API Management receives the request.
76
74
77
75
## Enable tracing for an API
78
76
@@ -86,77 +84,77 @@ The following high level steps are required to enable tracing for a request to A
86
84
Detailed steps follow.
87
85
88
86
> [!NOTE]
89
-
> * These steps require API Management REST API version 2023-05-01-preview or later. You must be assigned the Contributor or higher role on the API Management instance to call the REST API.
90
-
> * For information about authenticating to the REST API, see [Azure REST API reference](/rest/api/azure).
87
+
>
88
+
> - These steps require API Management REST API version 2023-05-01-preview or later. You must be assigned the Contributor or higher role on the API Management instance to call the REST API.
89
+
> - For information about authenticating to the REST API, see [Azure REST API reference](/rest/api/azure).
91
90
92
-
1.**Obtain a debug token** - Call the API Management gateway's [List debug credentials](/rest/api/apimanagement/gateway/list-debug-credentials) API. In the URI, enter "managed" for the instance's managed gateway in the cloud, or the gateway ID for a self-hosted gateway. For example, to obtain trace credentials for the instance's managed gateway, use a request similar to the following:
91
+
1.**Obtain a debug token**. Call the API Management gateway's [List debug credentials](/rest/api/apimanagement/gateway/list-debug-credentials) API. In the URI, enter "managed" for the instance's managed gateway in the cloud, or the gateway ID for a self-hosted gateway. For example, to obtain trace credentials for the instance's managed gateway, use a request similar to the following example:
93
92
94
-
```http
95
-
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/managed/listDebugCredentials?api-version=2023-05-01-preview
96
-
```
93
+
```http
94
+
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/managed/listDebugCredentials?api-version=2023-05-01-preview
95
+
```
97
96
98
-
In the request body, pass the full resource ID of the API that you want to trace, and specify `purposes` as `tracing`. By default the token credential returned in the response expires after 1 hour, but you can specify a different value in the payload. Note that the expiry time is limited to a maximum of 1 hour. For example:
In the request body, pass the full resource ID of the API that you want to trace, and specify `purposes` as `tracing`. By default the token credential returned in the response expires after 1 hour, but you can specify a different value in the payload. The expiry time is limited to a maximum of 1 hour. For example:
107
98
108
-
> [!NOTE]
109
-
> The `apiId` can only be pulled from the full resource ID, not the name displayed in the portal.
> The `apiId` can only be pulled from the full resource ID, not the name displayed in the portal.
112
109
110
+
Get apiId:
113
111
114
-
```azurecli
115
-
az apim api list --resource-group <resource-group> --service-name <service-name> -o table
116
-
```
112
+
```azurecli
113
+
az apim api list --resource-group <resource-group> --service-name <service-name> -o table
114
+
```
117
115
118
-
The debug credential is returned in the response, similar to the following:
116
+
The debug credential is returned in the response, similar to the following example:
119
117
120
-
```json
121
-
{
122
-
"token": "aid=api-name&......."
123
-
}
124
-
```
118
+
```json
119
+
{
120
+
"token": "aid=api-name&......."
121
+
}
122
+
```
125
123
126
-
1. **Add the token value in a request header** - To enable tracing for a request to the API Management gateway, send the token value in an `Apim-Debug-Authorization` header. For example, to trace a call to the Petstore API that you imported in a previous tutorial, you might use a request similar to the following:
124
+
1.**Add the token value in a request header**. To enable tracing for a request to the API Management gateway, send the token value in an `Apim-Debug-Authorization` header. For example, to trace a call to the Petstore API that you imported in a previous tutorial, you might use a request similar to the following example:
1. **Evaluate the response** - The response can contain one of the following headers depending on the state of the debug token:
135
-
* If the debug token is valid, the response includes an `Apim-Trace-Id` header whose value is the trace ID, similar to the following:
132
+
1.**Evaluate the response**. The response can contain one of the following headers depending on the state of the debug token:
136
133
137
-
```http
138
-
Apim-Trace-Id: 0123456789abcdef....
139
-
```
134
+
- If the debug token is valid, the response includes an `Apim-Trace-Id` header whose value is the trace ID, similar to the following example:
135
+
136
+
```http
137
+
Apim-Trace-Id: 0123456789abcdef....
138
+
```
140
139
141
-
* If the debug token is expired, the response includes an `Apim-Debug-Authorization-Expired` header with information about expiration date.
142
-
* If the debug token was obtained for a different API, the response includes an `Apim-Debug-Authorization-WrongAPI` header with an error message.
140
+
- If the debug token is expired, the response includes an `Apim-Debug-Authorization-Expired` header with information about expiration date.
141
+
- If the debug token was obtained for a different API, the response includes an `Apim-Debug-Authorization-WrongAPI` header with an error message.
143
142
144
-
1. **Retrieve the trace** - Pass the trace ID obtained in the previous step to the gateway's [List trace](/rest/api/apimanagement/gateway/list-trace) API. For example, to retrieve the trace for the managed gateway, use a request similar to the following:
143
+
1. **Retrieve the trace** - Pass the trace ID obtained in the previous step to the gateway's [List trace](/rest/api/apimanagement/gateway/list-trace) API. For example, to retrieve the trace for the managed gateway, use a request similar to the following example:
145
144
146
-
```http
147
-
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/managed/listTrace?api-version=2023-05-01-preview
148
-
```
145
+
```http
146
+
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/managed/listTrace?api-version=2023-05-01-preview
147
+
```
149
148
150
-
In the request body, pass the trace ID obtained in the previous step.
149
+
In the request body, pass the trace ID obtained in the previous step.
151
150
152
-
```json
153
-
{
154
-
"traceId": "0123456789abcdef...."
155
-
}
156
-
```
151
+
```json
152
+
{
153
+
"traceId": "0123456789abcdef...."
154
+
}
155
+
```
157
156
158
-
The response body contains the trace data for the previous API request to the gateway. The trace is similar to the trace you can see by tracing a call in the portal's test console.
159
-
157
+
The response body contains the trace data for the previous API request to the gateway. The trace is similar to the trace you can see by tracing a call in the portal's test console.
160
158
161
159
### Example `.http` file for VS Code REST Client extension
0 commit comments