在 Azure Functions 中为 .NET 和 .NET Core 应用启用 Snapshot Debugger

项目
10/15/2024

Snapshot Debugger 当前适用于按 Windows 服务计划在 Azure Functions 上运行的 ASP.NET 和 ASP.NET Core 应用。

建议在使用 Snapshot Debugger 时在“基本”或更高的服务层级上运行应用程序。对于大多数应用程序：

“免费”和“共享”服务层级没有足够的内存或磁盘空间用于保存快照。
消耗层当前不可用于 Snapshot Debugger。

Snapshot Debugger 作为 Azure Functions 运行时的一部分预安装，因此无需添加额外的 NuGet 包或应用程序设置。

先决条件

在 Functions 应用中启用 Application Insights 监视。

启用快照调试器

若要在 Functions 应用中启用 Snapshot Debugger，请将 snapshotConfiguration 属性添加到 host.json 文件并重新部署函数。例如：

{
  "version": "2.0",
  "logging": {
    "applicationInsights": {
      "snapshotConfiguration": {
        "isEnabled": true
      }
    }
  }
}

为应用程序生成可触发异常的流量。然后等待 10 到 15 分钟，这样快照就会发送到 Application Insights 实例。

可以通过检查 .NET 函数应用文件来验证 Snapshot Debugger 是否已启用。例如，在以下简单的 .NET 函数应用中，.NET 应用程序的 .csproj、{Your}Function.cs 和 host.json 显示 Snapshot Debugger 已启用：

Project.csproj

<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
    <TargetFramework>netcoreapp2.1</TargetFramework>
    <AzureFunctionsVersion>v2</AzureFunctionsVersion>
</PropertyGroup>
<ItemGroup>
    <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="1.0.31" />
</ItemGroup>
<ItemGroup>
    <None Update="host.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
    <None Update="local.settings.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    <CopyToPublishDirectory>Never</CopyToPublishDirectory>
    </None>
</ItemGroup>
</Project>

{Your}Function.cs

using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;

namespace SnapshotCollectorAzureFunction
{
    public static class ExceptionFunction
    {
        [FunctionName("ExceptionFunction")]
        public static Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Function, "get", Route = null)] HttpRequest req,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            throw new NotImplementedException("Dummy");
        }
    }
}

Host.json

{
  "version": "2.0",
  "logging": {
    "applicationInsights": {
      "samplingExcludedTypes": "Request",
      "samplingSettings": {
        "isEnabled": true
      },
      "snapshotConfiguration": {
        "isEnabled": true
      }
    }
  }
}

为其他云启用 Snapshot Debugger

目前，在由世纪互联运营的 Azure 的区域需要进行终结点修改。

以下示例显示了使用由世纪互联运营的 Azure 云代理终结点更新的 host.json：

{
  "version": "2.0",
  "logging": {
    "applicationInsights": {
      "samplingExcludedTypes": "Request",
      "samplingSettings": {
        "isEnabled": true
      },
      "snapshotConfiguration": {
        "isEnabled": true,
        "agentEndpoint": "https://snapshot.monitor.azure.cn"
      }
    }
  }
}

以下是支持的 Snapshot Debugger 代理终结点的替代项：

properties	由世纪互联运营的 Azure
AgentEndpoint	`https://snapshot.monitor.azure.cn`

禁用快照调试器

若要在 Functions 应用中禁用 Snapshot Debugger，请通过将 snapshotConfiguration.isEnabled 属性设置为 false 来更新 host.json 文件。

{
  "version": "2.0",
  "logging": {
    "applicationInsights": {
      "snapshotConfiguration": {
        "isEnabled": false
      }
    }
  }
}

后续步骤

在 Azure 门户中查看快照。
根据 Functions 应用上的用例来自定义 Snapshot Debugger 配置。有关详细信息，请参阅 host.json 中的快照配置。
排查 Snapshot Debugger 问题。

通过