Skip to content

Commit 91053d5

Browse files
authored
Merge pull request #182512 from rachana-satao/RAS-8-12-2021-azure-api-management-1890463-2
Update in Debug-APIs-US1890463
2 parents 1baed30 + 35fa86a commit 91053d5

File tree

6 files changed

+12
-13
lines changed

6 files changed

+12
-13
lines changed

articles/api-management/api-management-howto-api-inspector.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,36 @@ services: api-management
55
documentationcenter: ''
66
author: dlepow
77
editor: ''
8-
98
ms.service: api-management
109
ms.topic: tutorial
11-
ms.date: 10/30/2020
10+
ms.date: 12/10/2021
1211
ms.author: danlep
13-
12+
ms.custom: devdivchpfy22
1413
---
1514

1615
# Tutorial: Debug your APIs using request tracing
1716

18-
This tutorial describes how to inspect (trace) request processing in Azure API Management to help you debug and troubleshoot your API.
17+
This tutorial describes how to inspect (trace) request processing in Azure API Management. Tracing helps you debug and troubleshoot your API.
1918

2019
In this tutorial, you learn how to:
2120

2221
> [!div class="checklist"]
2322
> * Trace an example call
2423
> * Review request processing steps
2524
26-
:::image type="content" source="media/api-management-howto-api-inspector/api-inspector-001.png" alt-text="API inspector":::
25+
:::image type="content" source="media/api-management-howto-api-inspector/api-inspector-002.png" alt-text="API inspector":::
2726

2827
## Prerequisites
2928

3029
+ Learn the [Azure API Management terminology](api-management-terminology.md).
3130
+ Complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md).
3231
+ Complete the following tutorial: [Import and publish your first API](import-and-publish.md).
3332

34-
## Verify allow tracing setting
33+
## Verify allow tracing setting
3534

3635
The **Allow tracing** setting for the subscription used for your API must be enabled. If you're using the built-in all-access subscription, it's enabled by default. To verify in the portal, navigate to your API Management instance and select **Subscriptions**.
3736

38-
:::image type="content" source="media/api-management-howto-api-inspector/allow-tracing.png" alt-text="Allow tracing for subscription":::
37+
:::image type="content" source="media/api-management-howto-api-inspector/allow-tracing-1.png" alt-text="Allow tracing for subscription":::
3938

4039
## Trace a call
4140

@@ -44,22 +43,22 @@ The **Allow tracing** setting for the subscription used for your API must be ena
4443
1. Select **Demo Conference API** from your API list.
4544
1. Select the **Test** tab.
4645
1. Select the **GetSpeakers** operation.
47-
1. Confirm that the HTTP request header includes **Ocp-Apim-Trace: True** and a valid value for **Ocp-Apim-Subscription-Key**. If it isn't, select **+ Add Header** to add the header.
46+
1. Confirm that the HTTP request header includes **Ocp-Apim-Trace: True** and a valid value for **Ocp-Apim-Subscription-Key**. If it doesn't, select **+ Add header** to add the header.
4847
1. Select **Send** to make an API call.
4948

50-
:::image type="content" source="media/api-management-howto-api-inspector/06-debug-your-apis-01-trace-call.png" alt-text="Configure API tracing":::
49+
:::image type="content" source="media/api-management-howto-api-inspector/06-debug-your-apis-01-trace-call-1.png" alt-text="Configure API tracing":::
5150

5251
> [!TIP]
5352
> If **Ocp-Apim-Subscription-Key** isn't automatically populated in the HTTP request, you can retrieve it in the portal. Select **Subscriptions**, and open the context menu (**...**) for your suscription. Select **Show/hide keys**. You can also regenerate keys if needed. Then, add a key to the header.
5453
5554
## Review trace information
5655

57-
1. After the call completes, go to the **Trace** tab in the **HTTP Response**.
56+
1. After the call completes, go to the **Trace** tab in the **HTTP response**.
5857
1. Select any of the following links to jump to detailed trace info: **Inbound**, **Backend**, **Outbound**.
5958

60-
:::image type="content" source="media/api-management-howto-api-inspector/response-trace.png" alt-text="Review response trace":::
59+
:::image type="content" source="media/api-management-howto-api-inspector/response-trace-1.png" alt-text="Review response trace":::
6160

62-
* **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 will appear here.
61+
* **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'll appear here.
6362

6463
* **Backend** - Shows the requests API Management sent to the API backend and the response it received.
6564

@@ -70,7 +69,7 @@ The **Allow tracing** setting for the subscription used for your API must be ena
7069
7170
1. On the **Message** tab, the **ocp-apim-trace-location** header shows the location of the trace data stored in Azure blob storage. If needed, go to this location to retrieve the trace.
7271

73-
:::image type="content" source="media/api-management-howto-api-inspector/response-message.png" alt-text="Trace location in Azure Storage":::
72+
:::image type="content" source="media/api-management-howto-api-inspector/response-message-1.png" alt-text="Trace location in Azure Storage":::
7473
## Next steps
7574

7675
In this tutorial, you learned how to:
162 KB
Loading
53.8 KB
Loading
182 KB
Loading
56.8 KB
Loading
35.5 KB
Loading

0 commit comments

Comments
 (0)