大网数据广告活动
Azure 网站与应用

为 Azure Functions 配置监视

· 52CE 我爱测

了解如何将函数应用连接到 Application Insights 以进行监视,以及如何配置数据收集。

Azure Functions 与 Application Insights 集成,从而使你能够更好地监视函数应用。 Application Insights(Azure Monitor 的一项功能)是一种可扩展的应用程序性能管理 (APM) 服务,该服务收集函数应用生成的数据,包括应用写入日志的信息。 通常,在创建函数应用时会启用 Application Insights 集成。 如果应用未设置检测密钥,必须先启用 Application Insights 集成。

可以使用 Application Insights 而无需任何自定义配置。 默认配置可能会产生大量数据。 如果使用的是 Visual Studio Azure 订阅,可能会达到 Application Insights 的数据上限。 若要详细了解 Application Insights 成本,请参阅管理 Application Insights 的使用情况和成本。

本文后面的部分将介绍如何配置和自定义函数发送到 Application Insights 的数据。 对于函数应用,在 host.json 文件中配置日志记录。

Note: 可以使用专门配置的应用程序设置来表示针对特定环境的 host.json 文件中的特定设置。 这使你可以有效地更改 host.json 设置,而不必在项目中重新发布 host.json 文件。 若要了解详细信息,请参阅替代 host.json 值。

配置类别

对于每个日志,Azure Functions 记录器都包含一个类别。 类别指示运行时代码或函数代码的哪个部分编写日志。 版本 1.x 和更高版本中的类别有所不同。 下表描述了运行时创建的日志的主要类别。

v2.x+

类别 表 说明
Function.<YOUR_FUNCTION_NAME> 依赖项 系统会自动收集一些服务的依赖项数据。 对于成功运行,这些日志处于 Information 级别。 若要了解详细信息,请参阅依赖项。 异常记录在 Error 级别。 运行时还会创建 Warning 级别日志,例如将队列消息发送到病毒队列时。
Function.<YOUR_FUNCTION_NAME> customMetrics****customEvents 使用 C# 和 JavaScript SDK,可以收集自定义指标并记录自定义事件。 若要了解详细信息,请参阅自定义遥测数据。
Function.<YOUR_FUNCTION_NAME> traces 包括针对特定函数运行的函数已启动和已完成日志。 对于成功运行,这些日志处于 Information 级别。 异常记录在 Error 级别。 运行时还会创建 Warning 级别日志,例如将队列消息发送到病毒队列时。
Function.<YOUR_FUNCTION_NAME>.User traces 用户生成的日志,可以是任何日志级别。 若要详细了解如何从函数写入日志,请参阅写入日志。
Host.Aggregator customMetrics 这些运行时生成的日志在一段可配置的时间内提供函数调用的计数和平均值。 默认时段为 30 秒或 1,000 个结果,以先满足的条件为准。 示例包括运行数、成功率和持续时间。 所有这些日志均在 Information 级别编写。 如果在 Warning 或更高级别进行筛选,则不会看到任何这些数据。
Host.Results requests 这些运行时生成的日志指示函数是成功还是失败。 所有这些日志均在 Information 级别编写。 如果在 Warning 或更高级别进行筛选,则不会看到任何这些数据。
Microsoft traces 反映主机调用的 .NET 运行时组件的完全限定的日志类别。
Worker traces 语言工作进程为非 .NET 语言生成的日志。 语言工作日志也可以记录在 Microsoft.* 类别中,例如 Microsoft.Azure.WebJobs.Script.Workers.Rpc.RpcFunctionInvocationDispatcher。 这些日志在 Information 级别写入。

Note: 对于 .NET 类库函数,这些类别假定你使用的是 ILogger 而不是 ILogger<T>。 若要了解详细信息,请参阅 Functions ILogger 文档。

v1.x

类别 表 说明
Function traces 用户生成的日志,可以是任何日志级别。 若要详细了解如何从函数写入日志,请参阅写入日志。
Host.Aggregator customMetrics 这些运行时生成的日志在一段可配置的时间内提供函数调用的计数和平均值。 默认时段为 30 秒或 1,000 个结果,以先满足的条件为准。 示例包括运行数、成功率和持续时间。 所有这些日志均在 Information 级别编写。 如果在 Warning 或更高级别进行筛选,则不会看到任何这些数据。
Host.Executor traces 包括用于特定函数运行的“函数已启动”和“函数已完成”日志 。 对于成功运行,这些日志属于 Information 级别。 异常在 Error 级别记录。 运行时还会创建 Warning 级别日志,例如将队列消息发送到病毒队列时。
Host.Results requests 这些运行时生成的日志指示函数是成功还是失败。 所有这些日志均在 Information 级别编写。 如果在 Warning 或更高级别进行筛选,则不会看到任何这些数据。

表列指示将日志写入 Application Insights 中的哪个表。

配置日志级别

日志级别将分配给每个日志。 该值是一个整数,指示相对重要性:

LogLevel 代码 说明
跟踪 0 包含最详细消息的日志。 这些消息可能包含敏感应用程序数据。 这些消息默认情况下处于禁用状态,并且绝不应在生产环境中启用。
调试 1 在开发过程中用于交互式调查的日志。 这些日志应主要包含对调试有用的信息,并且没有长期价值。
信息 2 跟踪应用程序的常规流的日志。 这些日志应具有长期价值。
警告 3 突出显示应用程序流中的异常或意外事件的日志,但不会导致应用程序执行停止。
错误 4 突出显示当前执行流因失败而停止的日志。 这些错误应指示当前活动中的失败,而不是应用程序范围的失败。
严重 5 描述不可恢复的应用程序/系统崩溃或需要立即引起注意的灾难性故障的日志。
无 6 为指定的类别禁用日志记录。

文件配置 * 上的host.js* 确定函数应用发送到 Application Insights 多少日志记录。

对于每个类别,均可以指示要发送的最小日志级别。 host.json 设置因 Functions 运行时版本而异。

下面的示例根据以下规则定义日志记录:

  • 对于 Host.Results 或 Function 的日志,仅记录 Error 或更高级别的事件。
  • 对于 Host.Aggregator 的日志,记录所有生成的指标 (Trace)。
  • 对于所有其他日志(包括用户日志),仅记录 Information 级别及更高级别的事件。

v2.x+

{
  "logging": {
    "fileLoggingMode": "always",
    "logLevel": {
      "default": "Information",
      "Host.Results": "Error",
      "Function": "Error",
      "Host.Aggregator": "Trace"
    }
  }
}

v1.x

{
  "logger": {
    "categoryFilter": {
      "defaultLevel": "Information",
      "categoryLevels": {
        "Host.Results": "Error",
        "Function": "Error",
        "Host.Aggregator": "Trace"
      }
    }
  }
}

如果 host.json 包含以相同字符串开头的多个日志,则首先匹配定义更多的日志。 考虑以下示例,该示例在运行时中记录 Error 级别上除 Host.Aggregator 之外的所有内容:

v2.x+

{
  "logging": {
    "fileLoggingMode": "always",
    "logLevel": {
      "default": "Information",
      "Host": "Error",
      "Function": "Error",
      "Host.Aggregator": "Information"
    }
  }
}

v1.x

{
  "logger": {
    "categoryFilter": {
      "defaultLevel": "Information",
      "categoryLevels": {
        "Host": "Error",
        "Function": "Error",
        "Host.Aggregator": "Information"
      }
    }
  }
}

可以使用日志级别设置 None 来阻止为某个类别写入任何日志。

配置聚合器

如前一部分中所述,运行时聚合一段时间内有关函数执行的数据。 默认时段为 30 秒或 1,000 次运行,以先满足的条件为准。 可以在 host.json 文件中配置此设置。 下面是一个示例:

{
    "aggregator": {
      "batchSize": 1000,
      "flushTimeout": "00:00:30"
    }
}

配置采样

Application Insights 具有采样功能,可以防止在峰值负载时为已完成的执行生成过多的遥测数据。 当传入执行的速率超过指定的阈值时,Application Insights 开始随机忽略某些传入执行。 每秒执行的最大次数的默认设置为 20(版本 1.x 中为 5)。 可以在 host.json 中配置采样。 下面是一个示例:

v2.x+

{
  "logging": {
    "applicationInsights": {
      "samplingSettings": {
        "isEnabled": true,
        "maxTelemetryItemsPerSecond" : 20,
        "excludedTypes": "Request;Exception"
      }
    }
  }
}

可以从采样中排除某些类型的遥测。 在此示例中,采样中排除了类型为 Request 和 Exception 的数据。 这可确保记录所有函数执行(请求)和异常,而其他类型的遥测仍会受到采样的限制。

v1.x

{
  "applicationInsights": {
    "sampling": {
      "isEnabled": true,
      "maxTelemetryItemsPerSecond" : 5
    }
  }
}

若要了解详细信息,请参阅 Application Insights 中的采样。

配置缩放控制器日志

此功能为预览版。

可以让 Azure Functions 缩放控制器将日志发出到 Application Insights 或 Blob 存储,以便更好地了解缩放控制器为函数应用做出的决策。

若要启用此功能,请将名为 SCALE_CONTROLLER_LOGGING_ENABLED 的应用程序设置添加到函数应用设置中。 此设置的值必须采用基于以下规范的 <DESTINATION>:<VERBOSITY> 格式:

<DESTINATION> 日志发送到的目标。 有效值为 AppInsights 和 Blob。使用 AppInsights 时,请确保在函数应用中启用 Application Insights。将目标设置为 Blob 时,将在名为 azure-functions-scale-controller 的 blob 容器中创建日志,该容器位于 AzureWebJobsStorage 应用程序设置中设置的默认存储帐户中。
<VERBOSITY> 指定日志记录级别。 支持的值为 None、Warning 和 Verbose。设置为 Verbose 时,缩放控制器将记录辅助角色计数每次更改的原因,以及有关将这些因素纳入决策的触发器的信息。 详细日志包含触发器警告和缩放控制器运行前后触发器使用的哈希。

Tip: 请记住,在启用缩放控制器日志记录的同时,它会影响 监视函数应用的潜在成本。 请考虑启用日志记录,直到收集了足够的数据来了解规模控制器的行为方式,然后再将其禁用。

例如,以下 Azure CLI 命令会启用从缩放控制器到 Application Insights 的详细日志记录:

az functionapp config appsettings set --name <FUNCTION_APP_NAME> \
--resource-group <RESOURCE_GROUP_NAME> \
--settings SCALE_CONTROLLER_LOGGING_ENABLED=AppInsights:Verbose

在此示例中,请将 <FUNCTION_APP_NAME> 和 <RESOURCE_GROUP_NAME> 分别替换为函数应用名称和资源组名称。

以下 Azure CLI 命令通过将详细程度设置为 None 来禁用日志记录:

az functionapp config appsettings set --name <FUNCTION_APP_NAME> \
--resource-group <RESOURCE_GROUP_NAME> \
--settings SCALE_CONTROLLER_LOGGING_ENABLED=AppInsights:None

还可以通过使用以下 Azure CLI 命令删除 SCALE_CONTROLLER_LOGGING_ENABLED 设置来禁用日志记录:

az functionapp config appsettings delete --name <FUNCTION_APP_NAME> \
--resource-group <RESOURCE_GROUP_NAME> \
--setting-names SCALE_CONTROLLER_LOGGING_ENABLED

启用缩放控制器日志记录后,便可以 查询缩放控制器日志。

启用 Application Insights 集成

对于将数据发送到 Application Insights 的函数应用,它需要知道 Application Insights 资源的检测密钥。 该密钥必须位于名为 APPINSIGHTS_INSTRUMENTATIONKEY 的应用设置中。

在 Azure 门户中创建函数应用时,请在命令行中使用 Azure Functions Core Tools 或 Visual Studio Code,默认情况下会启用 Application Insights 集成。 Application Insights 资源的名称与函数应用的相同,并且在同一区域或最接近的区域中创建。

门户中的新函数应用

若要查看正在创建的 Application Insights 资源,请选择该资源,展开“Application Insights”窗口。 可以更改“新建资源名称”,或者在 Azure 地理位置中选择另一个需要在其中存储数据的“位置” 。

在创建函数应用时启用 Application Insights

选择“创建”时,Application Insights 资源通过函数应用创建,该函数应用在应用程序设置中设置了 APPINSIGHTS_INSTRUMENTATIONKEY。 一切准备就绪。

添加到现有函数应用

如果 Application Insights 资源不是使用函数应用创建的,请使用以下步骤来创建资源。 然后,可以添加该资源中的检测密钥,作为函数应用中的应用程序设置。

  1. 在 Azure 门户中,搜索并选择“函数应用”,然后选择你的函数应用。

  2. 选择窗口顶部的“未配置 Application Insights”横幅。 如果看不到此横幅,则应用可能已启用 Application Insights。

    从门户启用 Application Insights

  3. 展开“更改资源”,使用下表中指定的设置创建 Application Insights 资源。

    设置 建议的值 描述
    新资源名称 唯一的应用名称 使用与函数应用相同的名称是最方便的,该名称在订阅中必须独一无二。
    位置 西欧 尽可能使用函数应用所在的同一区域,或与该区域接近的区域。

    创建 Application Insights 资源

  4. 选择“应用”。

    Application Insights 资源在与函数应用相同的资源组和订阅中创建。 创建资源后,关闭 Application Insights 窗口。

  5. 在函数应用中,选择“设置”下的“配置”,然后选择“应用程序设置”。 如果看到名为 APPINSIGHTS_INSTRUMENTATIONKEY 的设置,则表明已为在 Azure 中运行的函数应用启用 Application Insights 集成。 如果出于某种原因,该设置不存在,请使用 Application Insights 检测密钥作为值来添加该设置。

Note: 早期版本的 Functions 使用了内置监视功能,现不再建议使用该功能。 为此类函数应用启用 Application Insights 集成时,还必须禁用内置日志记录功能。

禁用内置日志记录

启用 Application Insights 时,请禁用使用 Azure 存储的内置日志记录。 内置日志记录对于使用轻工作负载测试非常有用,但不适合在高负载生产环境中使用。 对于生产监视,建议使用 Application Insights。 如果在生产环境中使用内置日志记录,日志记录可能因 Azure 存储限制而不完整。

若要禁用内置日志记录,请删除 AzureWebJobsDashboard 应用设置。 有关如何在 Azure 门户中删除应用设置的信息,请参阅如何管理函数应用的“应用程序设置”部分。 在删除应用设置之前,请确保同一函数应用中没有任何现有的函数将此设置用于 Azure 存储触发器或绑定。

后续步骤

若要详细了解监视,请参阅:

历史资料。此文对应 2022-08-12 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体、发布器占位标签和导航标记。

资料来源与适用范围

资料来源
Microsoft / Azure 中文运维文档历史快照
适用范围
历史中文快照 2022-08-12;详见原文产品版本;文档日期 8/31/2020
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。