Serverless 应用之 Lambda 函数调试指南

引言

Serverless 是一种当前最流行的云计算技术,它的优点包括不需要运维、按需分配资源、快速部署等。然而,在开发 Serverless 应用时,常常会遇到调试困难以及开发效率低下的问题。其中重要的一点是 Lambda 函数的调试,因为 Lambda 函数作为 Serverless 应用的核心组件承载着应用逻辑的处理。本文将会为开发者提供一些 Lambda 函数调试的指南,包括调试环境的搭建、调试方法的使用、以及一些调试技巧。

调试环境的搭建

使用本地环境调试

使用本地环境调试 Lambda 函数是最直接的方法。在本地开发环境中,开发者可以使用 IDE 或者文本编辑器来编辑代码,并使用模拟工具模拟 Lambda 运行环境。 AWS 提供的官方模拟工具是 AWS SAM(Serverless Application Model),它可以在本地模拟一些 AWS 服务的 API,如 API Gateway,DynamoDB 等等。开发者可以使用 AWS SAM 来运行 Lambda 函数,并在本地环境中对函数进行调试。

以下是使用 AWS SAM 进行本地 Lambda 调试的示例代码:

- -------------
---------- ----------------------------
----------
  -----------------
    ----- ---------------------------
    -----------
      -------- -------------
      -------- ----------
      -------- -
      -------- --
      -------
        --------------------
          ----- ---
          -----------
            ----- ------------
            ------- ---
      ------------
        ----------
          ----------- ------------
-- --------
--------------- - ----- ------- -------- -- -
  --------------------- -------
  ----------------------- ---------
  ------ -
    ----------- ----
    ----- ----------------
      -------- ------- --- --------
    ---
  --
--

其中,template.yaml 文件中说明了 AWS SAM 应用的配置信息,如 Lambda 函数的代码路径、运行时、环境变量等等。而 index.js 文件中是 Lambda 函数的具体实现,注意到在函数中使用了 console.log 打印了参数和上下文信息以方便调试。

在代码和配置文件准备好后,可以使用 AWS SAM CLI 运行函数:

--- ----- ---------

这条命令会创建一个本地 API Gateway,并将请求转发到本地运行的 Lambda 函数中。开发者可以使用类似 Postman 的工具发送请求,以测试函数的响应是否正确。

远程调试 Lambda 函数

虽然使用本地环境调试 Lambda 函数非常方便,但实际上有时候因为一些限制,我们需要在远程 Lambda 环境中进行调试。本节介绍如何在远程环境中调试 Lambda 函数。

在 AWS Lambda 中,我们可以使用 CloudWatch Logs 打印日志,以帮助我们调试函数的执行过程。开发者可以使用 console.log 在函数中打印调试信息,并在 CloudWatch Logs 中查看打印信息,例如:

--------------- - ----- ------- -------- -- -
  --------------------- -------
  ----------------------- ---------
  ------ -
    ----------- ----
    ----- ----------------
      -------- ------- ------ ------------
    ---
  --
--

在函数被执行时,上述 console.log 语句打印的信息将会被写入 CloudWatch Logs。可以在 CloudWatch Logs 中搜索特定的调试信息,以便更快地定位问题。

除了使用 CloudWatch Logs 之外,AWS 还提供了一种远程调试 Lambda 函数的方式,即使用 AWS Cloud9 开发环境。AWS Cloud9 是一款基于 Web 的集成式开发环境,它提供了云端 IDE、CLI 命令行、Git 版本控制等开发工具。借助 AWS Cloud9,开发者可以直接在远程 Lambda 服务器运行调试代码,并在 Web UI 中查看函数的执行状态。

调试方法的使用

调试 Lambda 函数有多种方法,本节将介绍其中一些方法的使用。

使用 CloudWatch Logs 进行调试

如前所述,使用 CloudWatch Logs 打印日志是最直接的调试方法之一。在函数代码中加入 console.log 语句,并在 CloudWatch Logs 中查看输出即可,例如:

--------------- - ----- ------- -------- -- -
  --------------------- -------
  ----------------------- ---------
  ------ -
    ----------- ----
    ----- ----------------
      -------- ------- ----- ---- ---------- -------
    ---
  --
--

在 CloudWatch Logs 中搜索事件日志,即可看到打印的调试信息。

使用断点进行调试

使用断点是一种更为高级的调试方法。在 Lambda 函数中设置断点,可以让函数在运行到断点的地方停下来,以方便开发者查看函数的状态。AWS 提供了一种可以在函数代码中设置断点的方法,即使用调试器。

AWS 的调试器支持多种语言,例如 Node.js、Python、Java 等等。其中,使用 Node.js 调试器进行 Lambda 函数调试的方法如下:

  1. 在函数代码中设置一个断点,例如:

    --------------- - ----- ------- -------- -- -
      --------------------- -------
      ----------------------- ---------
      --------- -- ----
      ------ -
        ----------- ----
        ----- ----------------
          -------- ------- --------- ---- -------------
        ---
      --
    --
  2. 在 AWS Lambda 控制台的调试面板中设置调试配置,例如:

    -
      ------- ----------------
      ------- ---------
      ---------- ---------
      ------- -----
      ------------ ---------------------
      ------------- -----------
    -

    其中 "port" 是调试端口,"localRoot" 是本地代码路径,"remoteRoot" 是 Lambda 函数代码路径。

  3. 使用调试器连接 Lambda 服务器,例如:

    ----- -------- ------ -
      ----- --- - -------------------
      ----- ------ - --- -------------
    
      ----- ------ - -
        ------------- -------------------
        --------------- ------------------
        -------- ----------------
          ----- ----------
        ---
        -- -------- ------ --
        -------------- ---------------------------- ------ ---- -----------------------
      --
    
      ----- --- - ----- --------------------------------
      ------------------------ -------------
    -
    
    ----------------------------
  4. 在本地 IDE 或者命令行中启动调试器,例如:

    ---- ------------- -----------
  5. 等待函数执行到断点处,使用调试器进行查看/修改变量等操作。

使用 X-Ray 进行调试

AWS X-Ray 是一款用于分析和调试分布式应用程序的服务。使用 X-Ray 进行函数调试,可以让开发者更深入地了解整个应用程序的执行过程,包括 API 调用、数据库操作、函数执行等内容。在 Lambda 函数中集成 X-Ray SDK,可以在 X-Ray 控制台中查看函数的执行跟踪。

以下是一个示例代码,演示在 Lambda 函数中使用 X-Ray:

-- ------
----- ------- - -----------------------------
----- --- - ---------------------------------------

----- ---------- - --- ---------------

--------------- - ----- ------- -------- -- -
  --- -
    ----- -------- - ----- --------------------
      ---------- -----------
      ---- -
        --- - -- -------- --
      --
    -------------

    ------ -
      ----------- ----
      ----- ----------------
        -------- ------- --------- ---- --------
        ---------
      ---
    --
  - ----- ------- -
    ---------------------
    ------ -
      ----------- ----
      ----- ----------------
        -------- --------
        ------ --------------
      ---
    --
  -
--

在函数执行中,使用 AWSXRay.captureAWS 方法对 AWS SDK 进行包装,即可将操作添加到 X-Ray 的跟踪流程中。在 Lambda 函数执行后,可以在 X-Ray 控制台中找到相应的函数调用,并查看执行过程和返回结果。

以上是 X-Ray 的基本使用方法,更多细节可以参考官方文档。

调试技巧

除了前面提到的调试方法和工具之外,以下是一些 Lambda 函数调试技巧,可以帮助开发者更快地定位问题:

  • 使用单元测试:在开发过程中,使用单元测试可以帮助开发者更快地发现问题,并且减少人工测试带来的错误。建议使用 Jest、Mocha 等单元测试框架进行单元测试;
  • 逐步删除代码:当遇到问题时,可以暂时注释掉一些代码,仅保留关键部分进行调试。一步步添加已注释掉的代码,以便查看哪一段代码造成了问题;
  • 客户端调试:在没有办法远程调试 Lambda 函数时,可以在客户端代码中打印调试信息,例如在前端应用中打印网络请求的参数和响应;
  • 手动回退:当 Lambda 函数出现异常时,可以使用 try...catch... 语句捕获异常,以便更好地了解出现问题的原因,并手动回退某一段代码。

总结

Lambda 函数的调试是开发 Serverless 应用的必要环节。在本文中,我们介绍了本地环境调试、远程调试、使用 CloudWatch Logs、使用断点、使用 X-Ray 等多种 Lambda 函数调试方法和工具。希望这些指南和技巧能够帮助开发者更好地进行 Serverless 开发。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/6649b05dd3423812e4899dd4