云端调试

最近更新时间:2024-08-23 17:22:11

我的收藏

开发模式

开发模式是为处于开发状态下的项目可以更便捷的进行代码编写、开发调试而设计的。在开发模式中,用户可以持续进行开发和调试,尽量减少打包和更新等干扰。

进入开发模式

在项目下执行 scf dev 命令,可以进入项目的开发模式。
示例如下:
$ scf dev
serverless-cloud-framework
Dev Mode - Watching your Component for changes and enabling streaming logs, if supported...

Debugging listening on ws://127.0.0.1:9222.
For help see https://nodejs.org/en/docs/inspector.
Please open chorme, and visit chrome://inspect, click [Open dedicated DevTools for Node] to debug your code.
--------------------- The realtime log ---------------------
17:13:38 - express-api-demo - deployment
region: ap-guangzhou
apigw:
serviceId: service-b77xtibo
subDomain: service-b77xtibo-1253970226.gz.apigw.tencentcs.com
environment: release
url: http://service-b77xtibo-1253970226.gz.apigw.tencentcs.com/release/
scf:
functionName: express_component_6r6xkh60k
runtime: Nodejs10.15
namespace: default

express-api-demo › Watching
在进入 dev 模式后,Serverless Cloud Framework 工具将输出部署的内容,并启动持续文件监控;当代码文件发生更改时,将自动再次进行部署,将本地文件更新到云端。
再次部署并输出部署信息:
express-api-demo › Deploying ...
Debugging listening on ws://127.0.0.1:9222.
For help see https://nodejs.org/en/docs/inspector.
Please open chorme, and visit chrome://inspect, click [Open dedicated DevTools for Node] to debug your code.
--------------------- The realtime log ---------------------
21:11:31 - express-api-demo - deployment
region: ap-guangzhou
apigw:
serviceId: service-b7******
subDomain: service-b7******-1253******.gz.apigw.tencentcs.com
environment: release
url: http://service-b7******-1253******.gz.apigw.tencentcs.com/release/
scf:
functionName: express_component_u******
runtime: Nodejs10.15
namespace: default
注意:
当前 serverless dev 仅支持 Node.js 10 运行环境,后续将支持 Python、PHP 等运行环境的实时日志。
serverless-cloud-framework 命令的简写为 scf

退出开发模式

在开发模式下,通过 Ctrl + C 可以退出开发模式(dev 模式)。
express-api-demo › Disabling Dev Mode & Closing ...

express-api-demo › Dev Mode Closed

云端调试:Node.js 10+

针对 Runtime 为 Node.js 10+ 的项目,可以通过开启云端调试,并使用针对 Node.js 的调试工具来连接云端调试,例如 Chrome DevTools、VS Code Debugger。

开启云端调试

按照如上方案进入开发模式时,如果是 Runtime 为 Node.js 10及以上版本的函数,会自行开启云端调试,并输出调试相关信息。
例如在开启开发模式时,如果有如下输出,则代表已经启动云函数的云端调试:
Debugging listening on ws://127.0.0.1:9222.
For help see https://nodejs.org/en/docs/inspector.
Please open chorme, and visit chrome://inspect, click [Open dedicated DevTools for Node] to debug your code.

使用调试工具 Chrome DevTools

以下步骤说明如何使用 Chrome 浏览器的 DevTools 工具来连接远程环境并进行调试:
1. 启动 Chrome 浏览器。
2. 在地址栏中输入 chrome://inspect/ 并访问。
3. 可通过以下两种方式打开 DevTools。如下图所示:


方式1:(推荐)单击 Devices 下的 Open dedicated DevTools for Node
方式2:选择 Remote Target #LOCALHOST 中具体 Target 下的 inspect。 如果无法打开或者没有 Target,请检查 Device 的 Configure 中是否已有 localhost:9229localhost:9222 的配置,该配置对应开启云端调试时的输出。
4. 通过选择 Open dedicated DevTools for Node 方式打开的 DevTools 调试工具,可单击 Sources 页签看远端代码。函数的实际代码在 /var/user/ 目录下。 在 Sources 页签中查看的代码可能处于加载中,会随着调试进行而展示出更多远端文件。
5. 可按需打开文件,在文件的指定位置设置断点。
6. 通过任意方式,例如 URL 访问、页面触发、命令触发、接口触发等方式触发函数,会使得远端环境开始运行,并会在设置了断点的位置中断,等待进一步的运行。
7. 通过 DevTools 的右侧工具栏,可以控制中断的程序继续执行、单步执行、步入步出等操作,也可以直接查看当前变量,或设定需跟踪查看的变量。DevTools 的进一步使用可以搜索查询 DevTools 使用说明文档。

关闭云端调试

在退出开发模式时,将会自动关闭云端调试功能。

命令调试

Serverless Cloud Framework 云函数组件支持invoke命令触发云函数进行调试。对于scf deploy部署成功的云函数,进入项目目录,执行函数调用命令如下:
scf invoke --inputs function=functionName clientContext='{"weights":{"2":0.1}}'
说明:
invoke命令必须在该函数部署的 serverless.yml 文件同目录下执行。
clientContext为触发函数时传递的 json 字符串。可以根据 触发事件模板 的 json 字符串格式模拟不同触发事件。