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
+35-20Lines changed: 35 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ services: api-management
5
5
author: dlepow
6
6
ms.service: azure-api-management
7
7
ms.topic: tutorial
8
-
ms.date: 05/05/2024
8
+
ms.date: 11/04/2024
9
9
ms.author: danlep
10
10
ms.custom: devdivchpfy22
11
11
---
@@ -36,11 +36,14 @@ In this tutorial, you learn how to:
36
36
37
37
## Trace a call in the portal
38
38
39
+
Follow these steps to trace an API request in the test console in the portal. This example assumes that you [imported](import-and-publish.md) a sample API in a previous tutorial. You can follow similar steps with a different API that you imported.
40
+
39
41
1. Sign in to the [Azure portal](https://portal.azure.com), and navigate to your API Management instance.
40
-
1. Select **APIs**.
41
-
1. Select **Demo Conference API** from your API list.
42
+
1. Select **APIs** > **APIs**.
43
+
1. Select **Petstore API** from your API list.
42
44
1. Select the **Test** tab.
43
-
1. Select the **GetSpeakers** operation.
45
+
1. Select the **Find pet by ID** operation.
46
+
1. In the *petId***Query parameter**, enter *1*.
44
47
1. Optionally check the value for the **Ocp-Apim-Subscription-Key** header used in the request by selecting the "eye" icon.
45
48
> [!TIP]
46
49
> 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.
@@ -55,7 +58,7 @@ In this tutorial, you learn how to:
***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.
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 appear here.
59
62
60
63
***Backend** - Shows the requests API Management sent to the API backend and the response it received.
61
64
@@ -69,25 +72,31 @@ In this tutorial, you learn how to:
69
72
70
73
## Enable tracing for an API
71
74
72
-
You can enable tracing for an API when making requests to API Management using `curl`, a REST client such as Visual Studio Code with the REST Client extension, or a client app.
75
+
The following high level steps are required to enable tracing for a request to API Management when using `curl`, a REST client such as Visual Studio Code with the REST Client extension, or a client app. Currently these steps must be followed using the [API Management REST API](/rest/api/apimanagement):
76
+
77
+
1. Obtain a token credential for tracing.
78
+
1. Add the token value in an `Apim-Debug-Authorization` request header to the API Management gateway.
79
+
1. Obtain a trace ID in the `Apim-Trace-Id` response header.
80
+
1. Retrieve the trace corresponding to the trace ID.
73
81
74
-
Enable tracing by the following steps using calls to the API Management REST API.
82
+
Detailed steps follow.
75
83
76
84
> [!NOTE]
77
-
> The following 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.
85
+
> * 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.
86
+
> * For information about authenticating to the REST API, see [Azure REST API reference](/rest/api/azure).
78
87
79
-
1. Obtain trace credentials by calling the [List debug credentials](/rest/api/apimanagement/gateway/list-debug-credentials) API. Pass the gateway ID in the URI, or use "managed" for the instance's managed gateway in the cloud. For example, to obtain trace credentials for the managed gateway, use a call similar to the following:
88
+
1.**Obtain a token credential** - 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:
80
89
81
90
```http
82
91
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/managed/listDebugCredentials?api-version=2023-05-01-preview
83
92
```
84
93
85
-
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.
94
+
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. For example:
@@ -96,21 +105,27 @@ Enable tracing by the following steps using calls to the API Management REST API
96
105
97
106
```json
98
107
{
99
-
"token": "aid=api-name&p=tracing&ex=......."
108
+
"token": "aid=api-name&......."
100
109
}
101
110
```
102
111
103
-
1. 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 demo conference API, use a call similar to the following:
112
+
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:
1. Depending on the token, the response contains different headers:
109
-
* If the token is valid, the response includes an `Apim-Trace-Id` header whose value is the trace ID.
117
+
118
+
1. Depending on the token, the response contains one of the following headers:
119
+
* If the token is valid, the response includes an `Apim-Trace-Id` header whose value is the trace ID, similar to the following:
120
+
121
+
```http
122
+
Apim-Trace-Id: 0123456789abcdef....
123
+
```
124
+
110
125
* If the token is expired, the response includes an `Apim-Debug-Authorization-Expired` header with information about expiration date.
111
-
* If the token was obtained for wrong API, the response includes an `Apim-Debug-Authorization-WrongAPI` header with an error message.
126
+
* If the token was obtained for a different API, the response includes an `Apim-Debug-Authorization-WrongAPI` header with an error message.
112
127
113
-
1. To retrieve the trace, pass the trace ID obtained in the previous step to the [List trace](/rest/api/apimanagement/gateway/list-trace) API for the gateway. For example, to retrieve the trace for the managed gateway, use a call similar to the following:
128
+
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:
114
129
115
130
```http
116
131
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/managed/listTrace?api-version=2023-05-01-preview
@@ -120,7 +135,7 @@ Enable tracing by the following steps using calls to the API Management REST API
120
135
121
136
```json
122
137
{
123
-
"traceId": "<trace ID>"
138
+
"traceId": "0123456789abcdef...."
124
139
}
125
140
```
126
141
@@ -134,7 +149,7 @@ For information about customizing trace information, see the [trace](trace-polic
| Resiliency Request Timeouts | Revision | Total requests that timed out waiting for a response |`ResiliencyRequestTimeouts`| n/a |
37
-
| Resiliency Requests Pending Connection Pool | Replica | Total requests pending a connection pool connection |`ResiliencyRequestsPendingConnectionPool`| n/a |
38
-
| Total Reserved Cores | None | Total cores reserved for the container app |`TotalCoresQuotaUsed`| n/a |
39
-
40
-
The metrics namespace is `microsoft.app/containerapps`.
24
+
| CPU Usage | Replica, Revision | CPU consumed by the container app, in nano cores (1,000,000,000 nanocores = 1 core) |`UsageNanoCores`| Nanocores |
25
+
| Memory Working Set Bytes | Replica, Revision | Container app working set memory used in bytes |`WorkingSetBytes`| Bytes |
26
+
| Network In Bytes | Replica, Revision | Network received bytes |`RxBytes`| Bytes |
| Resiliency Request Timeouts | Revision | Total requests that timed out waiting for a response |`ResiliencyRequestTimeouts`| Count |
37
+
| Resiliency Requests Pending Connection Pool | Replica | Total requests pending a connection pool connection |`ResiliencyRequestsPendingConnectionPool`| Count |
38
+
| Total Reserved Cores | None | Total cores reserved for the container app |`TotalCoresQuotaUsed`| Count |
39
+
| Average Response Time (Preview) | Status Code, Status Code Category | Average response time per status code |`ResponseTime`| Milliseconds |
40
+
| CPU Usage Percentage (Preview) | Replica | Percentage of CPU limit used, in percentage points |`CpuPercentage`| Percent |
41
+
| Memory Percentage (Preview) | Replica | Percentage of memory limit used, in percentage points |`MemoryPercentage`| Percent |
42
+
43
+
The metrics namespace is `Microsoft.App/containerapps`.
41
44
42
45
> [!NOTE]
43
46
> Replica restart count is the aggregate restart count over the specified time range, not the number of restarts that occurred at a point in time.
44
47
48
+
Container Apps environments provides this basic metric. You can only view this metric in [Azure Monitor metrics](https://ms.portal.azure.com/?feature.allrts=true#view/Microsoft_Azure_Monitoring/AzureMonitoringBrowseBlade/~/metrics).
49
+
50
+
| Title | Dimensions | Description | Metric ID | Unit |
51
+
|--|--|--|--|--|
52
+
| Workload Profile Node Count (Preview) | Workload Profile Name | The node count per workload profile |`NodeCount`| Count |
53
+
54
+
The metrics namespace is `Microsoft.App/managedEnvironments`.
55
+
45
56
More runtime specific metrics are available, [Java metrics](./java-metrics.md).
@@ -102,6 +102,16 @@ When calling the Azure DNS REST API, you need to specify each TXT string separat
102
102
103
103
The multiple strings in a DNS record shouldn't be confused with the multiple TXT records in a TXT record set. A TXT record set can contain multiple records, *each of which* can contain multiple strings. Azure DNS supports a total string length of up to 4096 characters in each TXT record set (across all records combined).
104
104
105
+
### DS records
106
+
107
+
The delegation signer (DS) record is a [DNSSEC](dnssec.md) resource record type that is used to secure a delegation. To create a DS record in a zone, the zone must first be signed with DNSSEC.
108
+
109
+
### TLSA records
110
+
111
+
A TLSA (Transport Layer Security Authentication) record is used to associate a TLS server certificate or public key with the domain name where the record is found. A TLSA record links the public key (a TLS server certificate) to the domain name, providing an additional layer of security for TLS connections.
112
+
113
+
To use TLSA records effectively, [DNSSEC](dnssec.md) must be enabled on your domain. This ensures that the TLSA records can be trusted and properly validated
The listed services and frameworks can generally acquire event streams and reference data directly from a diverse set of sources through adapters. Kafka Streams can only acquire data from Apache Kafka and your analytics projects are therefore locked into Apache Kafka. To use data from other sources, you're required to first import data into Apache Kafka with the Kafka Connect framework.
63
-
64
-
If you must use the Kafka Streams framework on Azure, [Apache Kafka on HDInsight](../hdinsight/kafka/apache-kafka-introduction.md) provides you with that option. Apache Kafka on HDInsight provides full control over all configuration aspects of Apache Kafka, while being fully integrated with various aspects of the Azure platform, from fault/update domain placement to network isolation to monitoring integration.
0 commit comments