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 应用服务中作为代码、在 Azure 应用服务中作为容器、在 Azure 容器应用中等等）。

尽可能优先使用自动检测

如果应用是托管在 Azure 应用服务中的 C# ASP.NET Core 应用，请使用自动指南帮助用户自动检测应用。

手动检测

通过创建 AppInsights 资源并更新应用程序代码来手动检测应用。

创建 AppInsights 资源

使用以下适合环境的选项之一。

• 将 AppInsights 添加到现有的 Bicep 模板。请参阅示例/appinsights.bicep了解要添加的内容。如果工作区中存在现有的 Bicep 模板文件，这是最佳选择。
• 使用 Azure CLI。请参阅脚本/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

平台特定指南

• 容器应用：可观测性指南