Amazon CloudFront
开发人员指南 (API 版本 2016-09-29)
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

测试和调试 Lambda@Edge 函数

本主题包括介绍测试和调试 Lambda@Edge 函数的策略的部分。请务必单独测试 Lambda@Edge 函数代码以确保它完成预期的任务,并进行集成测试以确保该函数在 CloudFront 中正常工作。

在集成测试期间或在部署函数后,您可能需要调试 CloudFront 错误,例如,HTTP 5xx 错误。错误可能是从 Lambda 函数返回的无效响应、触发该函数时的执行错误或者由于 Lambda 服务限制执行而产生的错误。本主题中的部分使用相同的策略以确定问题是哪种故障类型,并采取相同的措施以纠正该问题。

注意

如果在纠正错误时查看 CloudWatch 日志文件或指标,请注意它们显示或存储在最接近执行函数的位置的区域。因此,如果您的网站或 Web 应用程序用户位于英国,并且 Lambda 函数与您的分配关联,您必须更改区域以查看伦敦 AWS 区域的 CloudWatch 指标或日志文件。有关更多信息,请参阅本主题后面的确定 Lambda@Edge 区域

测试 Lambda@Edge 函数

可以使用两个步骤测试 Lambda 函数:单独测试和集成测试。

测试单独功能

在将 Lambda 函数添加到 CloudFront 之前,请确保先使用 Lambda 控制台中的测试功能或其他方法测试该功能。有关在 Lambda 控制台中进行测试的更多信息,请参阅AWS Lambda Developer Guide中的使用控制台创建 Lambda 函数中的调用 Lambda 函数并验证结果、日志和指标​。

在 CloudFront 中测试您的函数的运行情况

请务必完成集成测试,其中,您的函数与一个分配关联并根据 CloudFront 事件运行。确保为正确的事件触发函数,并为 CloudFront 返回有效且正确的响应。例如,确保事件结构正确无误,仅包含有效的标头,等等。

在 Lambda 控制台上重复对函数进行集成测试时,请在修改代码或更改调用函数的 CloudFront 触发器时参阅 Lambda@Edge 教程中的步骤。例如,确保您使用带编号的函数版本,如本教程中的以下步骤所述: 步骤 4:添加 CloudFront 触发器以运行函数

在进行更改和部署时,请注意需要几分钟的时间以在所有区域中复制更新的函数和 CloudFront 触发器。这通常需要几分钟,但最长需要 15 分钟。

您可以转到 CloudFront 控制台并查看您的分配,以确认复制是否完成:

  • 转到 CloudFront 控制台 (https://console.aws.amazon.com/cloudfront/)。

查看分配的状态是否已从正在进行恢复为已部署,这意味着已复制函数。然后,按照下一节中的步骤验证函数是否正常工作。

请注意,控制台中的测试仅验证逻辑,并不应用 Lambda@Edge 特定的服务限制。

确定 CloudFront 中的 Lambda 函数错误

在确认您的函数逻辑正常工作后,在 CloudFront 中运行函数时,您可能仍会看到 HTTP 5xx 错误。可能返回 HTTP 5xx 错误的原因有很多,其中包括 Lambda 函数错误或 CloudFront 中的其他问题。

  • 如果您使用 Lambda@Edge 函数,则可以在 CloudFront 控制台中使用图表帮助跟踪导致错误的原因,然后进行修复。例如,您可以查看是 CloudFront 还是 Lambda 函数导致了 HTTP 5xx 错误,然后,对于特定函数,您可以查看相关的日志文件来调查问题。

  • 要对 CloudFront 中的常规 HTTP 错误进行问题排查,请参阅以下主题中的问题排查步骤:对来自源的错误响应进行故障排除

导致 Lambda 函数在 CloudFront 中出现错误的原因

Lambda 函数导致 HTTP 5xx 错误可能有很多原因,您应采取的故障排除措施取决于错误类型。错误可以归类如下:

Lambda 函数执行错误。

如果由于在函数中存在未处理的异常或在代码中存在错误,CloudFront 没有从 Lambda 中收到响应,则会导致执行错误。例如,如果代码包含回调(错误)。有关更多信息,请参阅 AWS Lambda Developer Guide 中的 Lambda 函数错误

向 CloudFront 返回无效的 Lambda 函数响应

在运行函数后,CloudFront 从 Lambda 中收到响应。如果响应的对象结构不符合 Lambda@Edge 事件结构,或响应包含无效的标头或其他无效的字段,则会返回错误。

由于 Lambda 服务限制,CloudFront 中的执行受到限制

Lambda 服务限制在每个区域中执行,并在达到限制时返回错误。

如何确定故障类型

为了帮助您在调试和处理以解决 CloudFront 返回的错误时确定重点,确定 CloudFront 返回 HTTP 错误的原因会有所帮助。要开始使用,您可以使用 AWS 管理控制台上 CloudFront 控制台的 Monitoring (监控) 部分中提供的图表。有关在 CloudFront 控制台的 Monitoring (监控) 部分中查看图表的更多信息,请参阅监控 CloudFront 和设置警报

在您希望跟踪错误是由源还是由 Lambda 函数返回时,以及在错误源自 Lambda 函数时需要缩小问题类型的范围时,下列图表会非常有用。

错误率图表

Overview (概览) 选项卡上,您可以看到各个分配的一个图表是 Error rates (错误率) 图表。此图表显示相对于传入到您分配的请求总数,错误率的百分比。图表显示总错误率、4xx 错误总数、5xx 错误总数以及来自 Lambda 函数的 5xx 错误总数。根据错误类型和卷,您可以采取措施来调查和排查造成错误的原因。


								CloudFront 分配的错误率图表
  • 如果您看到 Lambda 错误,可以通过查看函数返回的特定类型错误来进一步进行调查。Lambda@Edge errors (Lambda@Edge 错误) 选项卡包含按类型分类函数错误的图表,帮助您确定特定函数的问题。

  • 如果您看到 CloudFront 错误,您可以进行故障排查和处理来修复原始错误,或者更改 CloudFront 配置。有关更多信息,请参阅 对来自源的错误响应进行故障排除

执行错误和无效函数响应图表

Lambda@Edge errors (Lambda@Edge 错误) 选项卡包含针对特定分配按类型对 Lambda@Edge 错误进行分类的图表。例如,一个图表按 AWS 区域显示所有执行错误。要更轻松地解决问题,在相同页面上,您可以通过按区域打开并查看特定函数的日志,查找特定问题。在 View execution error logs (查看执行错误日志)View invalid function response logs (查看无效函数相应日志) 下,选择一个区域(对于执行错误,还要选择一个函数),然后选择 View logs (查看日志)


								Lambda@Edge 函数执行的错误率图表

								Lambda@Edge 函数执行的错误率图表

此外,阅读本章中的下列部分,了解有关问题排查和修复错误的更多建议。

限制图表

Lambda@Edge errors 选项卡还包括一个 Throttles (限制) 图表。有时候,在您达到了区域并发限制时,Lambda 服务会按区域限制函数调用。如果您发现超出限制错误,则您的函数已达到 Lambda 服务对在区域中执行施加的限制。有关更多信息(包括如何请求提高限制),请参阅有关 Lambda@Edge 的限制


								Lambda@Edge 函数执行的限制图表

有关如何在排查 HTTP 错误时使用此信息的示例,请参阅调试 AWS 上内容交付的四个步骤

排除无效的 Lambda 函数响应故障(验证错误)

如果您发现问题是 Lambda 验证错误,则表示您的 Lambda 函数向 CloudFront 返回无效的响应。请按照此部分中的指导采取措施以检查您的函数,并确保您的响应符合 CloudFront 要求。

CloudFront 使用两种方法验证 Lambda 函数的响应:

  • Lambda 响应必须符合所需的对象结构。 不正确的对象结构示例包括:无法解析 json,缺少所需的字段以及在响应中包含无效的对象。有关更多信息,请参阅 Lambda@Edge 事件结构

  • 响应只能包含有效的对象值。 如果响应包含有效的对象,但具有不支持的值,则会出现错误。示例包括:添加或更新列入黑名单的标头或只读标头(请参阅 Lambda 函数的要求和限制主题中的标头),超出正文大小限制(请参阅Lambda响应错误主题中的生成的响应大小的限制)和无效的字符或值(请参阅Lambda@Edge 事件结构)。

在 Lambda 向 CloudFront 返回无效的响应时,将在日志文件中写入错误消息,CloudFront 将这些日志文件推送到执行 Lambda 函数所在的区域中的 CloudWatch。这是在具有无效的响应时将日志文件发送到 CloudWatch 的默认行为。不过,如果在发布该功能之前将 Lambda 函数与 CloudFront 相关联,则可能不会为您的函数启用该功能。有关更多信息,请参阅本主题后面的确定您的账户是否将日志推送到 CloudWatch

CloudFront 将日志文件推送到与执行您的函数的位置对应的区域(在与您的分配关联的日志组中)。日志组具有以下格式:/aws/cloudfront/LambdaEdge/DistributionId,其中 DistributionId 是您的分配的 ID。要确定可以找到 CloudWatch 日志文件的区域,请参阅本主题后面的确定 Lambda@Edge 区域

如果可再现该错误,您可以创建一个导致该错误的新请求,然后在失败的 CloudFront 响应(X-Amz-Cf-Id 标头)中找到请求 ID 以在日志文件中找到单个故障。日志文件条目包含可帮助您确定返回错误的原因的信息,并且还会列出相应的 Lambda 请求 ID,以便您可以在单个请求的上下文中分析根本原因。

如果错误是间歇性的,您可以使用 CloudFront 访问日志查找失败请求的请求 ID,然后在 CloudWatch 日志中搜索相应的错误消息。有关更多信息,请参阅上一节确定故障类型

纠正 Lambda 函数执行错误

如果问题是 Lambda 执行错误,为 Lambda 函数创建日志记录语句以将消息写入到 CloudWatch 日志文件可能是非常有用的,从而在 CloudFront 中监视函数的执行情况并确定它是否正常工作。然后,您可以在 CloudWatch 日志文件中搜索这些语句,以验证您的函数是否正常工作。

注意

即使您尚未更改 Lambda@Edge 函数,对该 Lambda 函数执行环境的更新也可能会影响它并可能返回执行错误。有关测试和迁移到更高版本的信息,请参阅对 AWS Lambda 和 AWS Lambda@Edge 执行环境的近期更新。

确定 Lambda@Edge 区域

要查看 Lambda@Edge 函数接收流量的区域,请在 AWS 管理控制台的 CloudFront 控制台上查看函数的指标。指标针对各个 AWS 区域显示。在同一页上,您可以选择一个区域并查看该区域的日志文件,从而调查问题。您必须查看相应 AWS 区域中的 CloudWatch 日志文件,以查看在 CloudFront 执行 Lambda 函数时创建的日志文件。

有关在 CloudFront 控制台的“Monitoring (监控)”部分中查看图表的更多信息,请参阅监控 CloudFront 和设置警报

确定您的账户是否将日志推送到 CloudWatch

默认情况下,CloudFront 为无效的 Lambda 函数响应启用日志记录,并使用 Lambda@Edge 的服务相关角色 之一将日志文件推送到 CloudWatch。如果在发布无效的 Lambda 函数响应日志功能之前将 Lambda@Edge 函数添加到 CloudFront,下次更新 Lambda@Edge 配置时,将启用日志记录,例如,通过添加 CloudFront 触发器。

您可以执行以下操作,以验证是否为您的账户启用将日志文件推送到 CloudWatch 的功能:

  • 检查以确定日志是否显示在 CloudWatch 中。 确保您查看执行 Lambda@Edge 函数的区域。有关更多信息,请参阅 确定 Lambda@Edge 区域

  • 在 IAM 中确定在您的账户中是否存在相关的服务相关角色。 为此,请打开 IAM 控制台 (https://console.amazonaws.cn/iam/),然后选择角色以查看您的账户的服务相关角色列表。查找以下角色:AWSServiceRoleForCloudFrontLogger