診斷記錄設定參考：API 管理
適用於：所有 APIM 層
此參考說明來自 API 管理 實例的 API 診斷記錄設定。 若要啟用 API 要求的記錄，請參閱下列指引：
注意
某些設定，其中已指出，僅適用於對 Application Insights 的記錄。
| 設定 | 類型 | 描述 |
|---|---|---|
| 啟用 | boolean | 指定是否啟用此 API 的記錄。 您可以針對所有 API 或個別 API 啟用記錄。 如果啟用，個別 API 的設定會覆寫所有 API 的設定。 |
| Destination | Azure 應用程式 Insights 記錄器 | 指定要用於 Application Insights 記錄的記錄器。 |
| 取樣 ≤ | decimal | 從 0 到 100 的值（百分比）。 指定記錄的要求百分比。 0% 取樣表示記錄零個要求，而 100% 取樣表示記錄的所有要求。 預設值：100 如需 Application Insights 記錄的效能影響，請參閱 效能影響和記錄取樣。 |
| 一律記錄錯誤 | boolean | 如果啟用此設定，則不論取樣設定為何，都會記錄所有失敗。 |
| 記錄用戶端IP位址 | boolean | 如果啟用此設定，則會記錄 API 要求的用戶端 IP 位址。 |
| 詳細資訊 | 指定記錄檔的詳細資訊，以及是否記錄在追蹤原則中設定的自定義追蹤。 * 錯誤 - 失敗的要求和嚴重性自定義追蹤 error* 資訊 - 失敗和成功的要求，以及嚴重性和 error 自定義追蹤 information* 詳細資訊 - 失敗和成功的要求，以及嚴重性 error、 information和 的自定義追蹤 verbose預設資訊： |
|
| 相互關聯通訊協定 | 指定用來將多個元件所傳送的遙測相互關聯至 Application Insights 的通訊協定。 默認值：舊版 如需詳細資訊，請參閱 Application Insights 中的遙測相互關聯。 |
|
| 要記錄的標頭 | 清單 | 指定針對要求和回應記錄的標頭。 預設值：不會記錄任何標頭。 |
| 要記錄的承載 （body） 位元組數目 | 整數 | 指定記錄之前端或後端要求或回應本文的初始位元組數目。 最大值：8,192。 預設值：0 |
| 前端要求 | 指定前端要求（傳入 API 管理 閘道的要求）的記錄方式和方式。 如果啟用此設定，請指定要記錄的標頭、要記錄的承載位元元組數目，或兩者。 |
|
| 前端回應 | 指定前端回應（從 API 管理 閘道傳出回應）的記錄方式和方式。 如果啟用此設定，請指定要記錄的標頭、要記錄的承載位元元組數目，或兩者。 |
|
| 後端要求 | 指定後端要求（從 API 管理 閘道傳出的要求）是否記錄和方式。 如果啟用此設定，請指定要記錄的標頭、要記錄的承載位元元組數目，或兩者。 |
|
| 後端回應 | 指定後端回應（傳入 API 管理 閘道的回應）的記錄方式和方式。 如果啟用此設定，請指定要記錄的標頭、要記錄的承載位元元組數目，或兩者。 |
重要
如果啟用，記錄的要求或回應承載最多可達 8,192 個字元組。 API 管理也會針對傳送至 Azure 監視器的診斷記錄項目強制執行 32 KB 的限制，其中包括承載和其他屬性，例如狀態碼、標頭和時間戳記。 如果屬性的組合大小超過 32 KB，API 管理會移除所有內文和追蹤內容來修剪項目。