appinsights-instrumentation

AppInsights 檢測指南

此技能提供指引與參考資料，協助您使用 Azure Application Insights 檢測 Web 應用程式。

⛔ 要新增元件？

如果使用者想要將 App Insights 新增至應用程式，請改為叫用 azure-prepare。
此技能提供參考資料，而 azure-prepare 負責協調實際的變更。

使用時機

• 使用者詢問如何檢測（指引、模式、範例）
• 使用者需要 SDK 設定說明
• azure-prepare 在研究階段叫用此技能
• 使用者想了解 App Insights 概念

應改用 azure-prepare 的時機

• 使用者說「為我的應用程式新增遙測」
• 使用者說「新增 App Insights」
• 使用者想要修改專案
• 任何要求變更或新增元件的請求

先決條件

工作區中的應用程式必須是以下類型之一

• 裝載於 Azure 的 ASP.NET Core 應用程式
• 裝載於 Azure 的 Node.js 應用程式

指導方針

收集環境資訊

找出使用者嘗試新增遙測支援的應用程式的（程式語言、應用程式架構、裝載方式）組合。這會決定應用程式可以如何檢測。閱讀原始碼以做出合理推測。對於不確定的部分，務必與使用者確認。您必須始終詢問使用者應用程式的裝載位置（例如，在個人電腦上、在 Azure App Service 中以程式碼形式、在 Azure App Service 中以容器形式、在 Azure Container App 中等）。

盡可能優先使用自動檢測

如果應用程式是裝載於 Azure App Service 的 C# ASP.NET Core 應用程式，請使用自動指南協助使用者進行自動檢測。

手動檢測

透過建立 AppInsights 資源並更新應用程式程式碼來手動檢測應用程式。

建立 AppInsights 資源

使用以下符合環境的選項之一。

• 將 AppInsights 新增至現有的 Bicep 範本。請參閱 examples/appinsights.bicep 了解要新增的內容。如果工作區中已有 Bicep 範本檔案，這是最佳選項。
• 使用 Azure CLI。請參閱 scripts/appinsights.ps1 了解要執行哪些 Azure CLI 命令來建立 App Insights 資源。

無論選擇哪個選項，都建議使用者在有意義的資源群組中建立 App Insights 資源，以便更輕鬆地管理資源。一個好的選擇是與 Azure 中託管應用程式的資源相同的資源群組。

修改應用程式程式碼

• 如果應用程式是 ASP.NET Core 應用程式，請參閱 ASPNETCORE 指南了解如何修改 C# 程式碼。
• 如果應用程式是 Node.js 應用程式，請參閱 NODEJS 指南了解如何修改 JavaScript/TypeScript 程式碼。
• 如果應用程式是 Python 應用程式，請參閱 PYTHON 指南了解如何修改 Python 程式碼。

SDK 快速參考

• OpenTelemetry Distro：Python | TypeScript
• OpenTelemetry Exporter：Python | Java

平台特定指南

• Container Apps：可觀測性指南