使用 Visual Studio 连接服务添加 Azure Application Insights

在 Visual Studio 中,通过使用连接服务功能可将以下任何项连接到 Azure Application Insights:

  • .NET Framework 控制台应用
  • ASP.NET 模型-视图-控制器 (MVC) (.NET Framework)
  • ASP.NET Core
  • .NET Core(包括控制台应用、WPF、Windows 窗体、类库)
  • .NET Core 辅助角色
  • Azure Functions
  • 通用 Windows 平台应用
  • Xamarin
  • Cordova

连接服务功能可将所有需要的引用和连接代码添加到项目,并相应地修改配置文件。

先决条件

使用连接服务连接到 Azure Application Insights

  1. 在 Visual Studio 中打开项目。

  2. 解决方案资源管理器中,右键单击连接服务节点,并在上下文菜单中选择添加连接服务

  3. 在“连接服务”选项卡中,选择“服务依赖项”的 + 图标。

    显示“添加服务依赖项”屏幕的屏幕截图。

    如果未看到“连接的服务”节点,请选择项目>连接的服务>添加

  4. 在“添加依赖项”页中,选择“Azure Application Insights”。

    显示“添加 Azure Application Insights”屏幕的屏幕截图。

    如果还没有登录,请登录到 Azure 帐户。 如果没有 Azure 帐户,可以注册免费试用版

  5. 配置 Azure Application Insights 屏幕中,选择现有 Azure Application Insights 组件,然后选择下一步

    如果需要创建新组件,请转到下一步。 否则,请跳到步骤 7。

    显示“连接到现有 Application Insights 组件”屏幕的屏幕截图。

  6. 创建 Application Insights 组件:

    1. 选择屏幕底部的创建新的 Application Insights 组件

    2. 填写“Application Insights: 新建屏幕,然后选择“创建”。

      显示“新建 Azure App Insights 组件”屏幕的屏幕截图。

    3. 显示“配置 Azure Application Insights”屏幕时,新组件将显示在列表中。 在列表中选择新组件,并选择下一步

  7. 输入检测密钥名称或选择默认值,然后选择是希望连接字符串存储在本地机密文件中,还是存储在 Azure Key Vault 中。

    显示“指定连接字符串”屏幕的屏幕截图。

  8. “更改摘要”屏幕显示了在完成该过程后将对项目进行的所有修改。 如果更改看起来正常,请选择“完成”。

    显示“更改摘要”屏幕的屏幕截图。

  9. 连接显示在“连接服务”选项卡的“服务依赖项”部分下。

    显示“服务依赖项”屏幕的屏幕截图。

使用连接服务连接到 Azure Application Insights

注意

对于 .NET Framework 项目,连接的服务 UI 略有不同。 若要查看差异,请与此页面的 Visual Studio 2019 版本进行比较。

  1. 在 Visual Studio 中打开项目。

  2. 在“解决方案资源管理器”中,右键单击“连接的服务”节点,并在上下文菜单中选择“添加”,打开可用服务的菜单。

    显示“连接的服务”上下文菜单选项的屏幕截图。

    如果未看到“连接的服务”节点,请选择项目>连接的服务>添加

  3. 选择 Azure Application Insights。 随即显示连接到依赖项页。 应看到两个选项,一个用于本地模拟器,即 Application Insights SDK(本地),另一个用于连接到实时 Azure Application Insights 服务。 可以从本地模拟器开始降低成本并简化早期开发。 稍后可以通过重复执行这些步骤并选择另一个选项来迁移到实时服务。

    显示 Application Insights 选项的屏幕截图。

    如果选择在本地使用 Application Insights SDK,请单击下一步以查看更改摘要屏幕,其中显示了项目出现了哪些修改。 NuGet 包引用和本地模拟器的连接代码被添加到项目中。

    如果要连接到 Azure 服务,请继续执行下一步;如果尚未登录,请先登录到 Azure 帐户,然后再继续。 如果没有 Azure 帐户,可以注册免费试用版

  4. 配置 Azure Application Insights 屏幕中,选择现有 Azure Application Insights 组件,然后选择下一步

    如果需要创建新组件,请转到下一步。 否则,请跳到步骤 7。

    显示“连接到现有 Application Insights 组件”屏幕的屏幕截图。

  5. 创建 Application Insights 组件:

    1. 选择屏幕底部的创建新的 Application Insights 组件

    2. 填写“Application Insights: 新建屏幕,然后选择“创建”。

      显示“新建 Azure App Insights 组件”屏幕的屏幕截图。

    3. 显示“配置 Azure Application Insights”屏幕时,新组件将显示在列表中。 在列表中选择新组件,并选择下一步

  6. 输入连接设置的名称和检测密钥名称,或接受默认值。

    显示“提供连接配置设置”屏幕的屏幕截图。

    注意

    为了提高安全性,在 Visual Studio 17.12 及更高版本中,此步骤将创建连接设置名称;以前的版本创建连接字符串。 存储在本地文件系统中的连接字符串可能会导致安全风险(如果无意中公开)。

  7. 单击“其他设置”,然后选择是要将连接字符串存储在本地机密文件中,还是存储在 Azure 密钥库中。

    显示“连接到 Application Insights - 其他设置”屏幕的屏幕截图。

  8. 更改摘要屏幕显示了在完成该过程后将对项目进行的所有修改。 如果更改看起来正常,请选择“完成”。

    显示“更改摘要”屏幕的屏幕截图。

  9. 在“解决方案资源管理器”中,双击“连接的服务”节点以打开“连接的服务”选项卡。连接显示在“服务依赖项”部分下:

    显示“服务依赖项”部分的屏幕截图。

    如果单击添加的依赖项旁边的三个点,可以看到各种选项(例如“连接”)以重新打开向导并更改连接。 还可以单击窗口右上角的三个点,查看用于启动本地依赖项、更改设置等的选项。

  10. 打开启动代码文件(模板中的 Program.cs),注意添加了一行代码,如下所示

    builder.Services.AddApplicationInsightsTelemetry(builder.Configuration["APPLICATIONINSIGHTS_CONNECTION_STRING"]);
    

后续步骤

对于 ASP.NET Core 项目,请通过适用于 ASP.NET Core 应用程序的 Application Insights了解如何为应用启用监视。

对于 ASP.NET 项目,请参阅为 ASP.NET 网站配置 Application Insights

这些链接会转到你已完成的初始设置步骤之后的文章部分。