关于 appinsights-instrumentation
appinsights-instrumentation 是一个 Agent Skill,提供为 Azure Application Insights 接入遥测的指导和参考资料。它适用于询问插桩方式、SDK 配置或概念的用户,并说明何时应转由 azure-prepare 执行实际修改。
主要功能
- 01插桩指导与代码模式参考
- 02按语言和托管环境区分的接入步骤
- 03Bicep 模板与 Azure CLI 创建资源的方式
- 04ASP.NET Core、Node.js、Python 代码修改指南
- 05OpenTelemetry Distro 与 Exporter SDK 索引
适用场景
- 01了解如何为托管在 Azure 中的应用接入 Application Insights
- 02确定应用的语言、框架与托管方式后选择插桩方案
- 03查阅 OpenTelemetry SDK 的配置参考
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ microsoft/ azure-skills --skill appinsights-instrumentation安装后在 Claude Code 中输入/appinsights-instrumentation确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
LICENSE.txtexamples/appinsights.bicepreferences/aspnetcore.mdauto.mdcontainer-apps.mdnodejs.mdpython.mdreferences/sdk/azure-monitor-opentelemetry-exporter-java.mdazure-monitor-opentelemetry-exporter-py.mdazure-monitor-opentelemetry-py.mdazure-monitor-opentelemetry-ts.mdscripts/appinsights.ps1详细介绍
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 Container App
- 托管在 Azure 中的 Node.js 应用
- 托管在 Azure 中的 Python 应用
指南
收集上下文信息
了解用户想要添加遥测支持的应用所使用的(编程语言、应用框架、托管环境)组合。这决定了应用的埋点方式。阅读源代码,做出有根据的判断。对于你不确定的事项,请向用户确认。必须始终询问用户应用托管在哪里(例如,在个人电脑上、作为代码托管在 Azure App Service 中、作为容器托管在 Azure App Service 中、托管在 Azure Container App 中等)。
尽可能优先使用自动埋点
如果应用是托管在 Azure App Service 中的 C# ASP.NET Core 应用,请使用 AUTO 指南帮助用户自动为应用添加埋点。
手动埋点
通过创建 AppInsights 资源并更新应用代码,手动为应用添加埋点。
创建 AppInsights 资源
根据环境选择以下其中一种方式。
- 将 AppInsights 添加到现有 Bicep 模板中。有关要添加内容,请参阅 examples/appinsights.bicep。如果工作区中已有 Bicep 模板文件,这是最佳选择。
- 使用 Azure CLI。有关要执行的 Azure CLI 命令,请参阅 scripts/appinsights.ps1,以创建 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:可观测性指南