硬核調(diào)試實操 | 手把手帶你實現(xiàn) Serverless 斷點調(diào)試

后臺回復(fù)?手冊?即刻免費下載 2022 Serverless 工具書

作者：千風(fēng) (阿里云函數(shù)計算研發(fā)工程師)

在應(yīng)用開發(fā)過程中，或者開發(fā)完成后，若出現(xiàn)執(zhí)行結(jié)果不符合我們的預(yù)期時，通常需要進(jìn)行一定的調(diào)試工作。但是在 Serverless 架構(gòu)下，調(diào)試工作往往會受到一些環(huán)境因素限制，如所開發(fā)的應(yīng)用在本地是比較健康的、且符合預(yù)期的運行，但是在 FaaS （Functions as a Service） 平臺上，出現(xiàn)了一些問題；或者是在某些特殊的環(huán)境下，本地沒有辦法模擬線上環(huán)境，難以進(jìn)行項目的開發(fā)和調(diào)試怎么辦？

概述

報告《Top 5 Serverless Trends》：https://hackernoon.com/top-5-serverless-trends-in-2020-wd1m3t8g

調(diào)試能力主要包含兩種，一是運行程序的能力；二是斷點調(diào)試能力。前者是調(diào)試的基礎(chǔ)能力，可以判幫助開發(fā)者判斷程序能否正常運行，驗證程序運行結(jié)果的正確性；后者是調(diào)試的高級能力，能夠幫助用戶方便定位到導(dǎo)致程序運行出錯或者不符合預(yù)期的位置。

詳情可點擊閱讀：創(chuàng)新推出 | Serverless 調(diào)試大殺器：端云聯(lián)調(diào)

https://github.com/devsapp/fc/blob/main/docs/zh/command/local.md

https://github.com/devsapp/fc/blob/main/docs/zh/command/proxied.md

調(diào)試之旅

• 啟動 Serverless 應(yīng)用
• 啟動斷點調(diào)試器
• 開始斷點調(diào)試
• 結(jié)束斷點調(diào)試

「01」

前置操作

在開始進(jìn)行調(diào)試之前，需要進(jìn)行一些前置操作，本文將前置操作分為通用前置操作以及端云聯(lián)調(diào)附加的前置操作：

• 安裝調(diào)試 IDE:可選的 IDE 有 VSCode、Pycharm 以及 Intellij 三種；

• 隨后在開始使用這些功能之前，請安裝好調(diào)試工具: 這里我們需要安裝一下 Serverless Devs，具體的安裝方式參考文檔：

https://help.aliyun.com/document_detail/195474.html；

?熟悉新一代函數(shù)計算工具鏈的使用方式，可參考：

https://github.com/devsapp/fc

• 下載安裝 Docker:調(diào)試能力都需要依賴 Docker，因此需要本地環(huán)境中有 Docker 工具，安裝方式請參考這里:

https://docs.docker.com/get-docker/

• 最后還需要注冊一個阿里云賬號，使用 Serverless Devs 配置阿里云賬號，具體配置方式可以參考這里。

https://help.aliyun.com/document_detail/295894.html

2）端云聯(lián)調(diào)附加的前置操作：

• 我們需要準(zhǔn)備一個阿里云賬號，由于端云聯(lián)調(diào)涉及到輔助資源的部署和刪除，如果賬號為子賬號，需要為該子賬號添加指定的一些權(quán)限，具體權(quán)限集合可參考：

https://github.com/devsapp/fc/blob/main/docs/zh/command/proxied.md#%E6%9D%83%E9%99%90%E4%B8%8E%E7%AD%96%E7%95%A5%E8%AF%B4%E6%98%8E

「02」

參數(shù)引入

完成以上前置條件的準(zhǔn)備后，我們先了解一下調(diào)試指令中與斷點調(diào)試所相關(guān)的具體參數(shù)(可滑動）：

-c, --config [vscode/pycharm/intellij]   [Required] Select which IDE to use when                                       debugging and output related debug                                       config tips for the IDE. value:                                       vscode/pycharm/intellij
-d, --debug-port number              [Required] Specify the local function                                       container starting in debug mode, and                                       exposing this port on localhost
--debug-args string                  [Optional] Additional parameters that                                       will be passed to the debugger
--debugger-path string               [Optional] The path of the debugger on                                       the host
--tmp-dir string                     [Optional] The temp directory mounted to                                       '/tmp' , default:                                       './.s/tmp/invoke/serviceName/functionName/'

使用斷點調(diào)試時，--config 參數(shù)以及 --debug-port 參數(shù)是必要的：

• --config 會指定斷點調(diào)試的 IDE 環(huán)境，目前支持 VSCode、Pycharm 、Intellij 三種。

• --debug-port 會指定調(diào)試的監(jiān)聽端口。

• --debug-args 會自定義程序啟動時的調(diào)試參數(shù)，不指定時默認(rèn)的調(diào)試參數(shù)可以參考文末附錄部分。

• --debugger-path 會將本地指定路徑掛載到程序運行環(huán)境的 /tmp/debugger_file?之中。

• --tmp-dir 會將本地指定路徑掛載到程序運行環(huán)境中的 /tmp 目錄上，在調(diào)試時，程序?qū)懭?/tmp 的結(jié)果文件則會在映射到本地目錄，用于驗證結(jié)果是否符合預(yù)期。

「03」

實操演練

1）VSCode

• 調(diào)試 Event 函數(shù)：

# 本地調(diào)試$ s local invoke --config vscode --debug-port 3000
# 端云聯(lián)調(diào)$ s proxied setup --config vscode --debug-port 3000

• 調(diào)試 php7.2 Event 函數(shù)

  
  

php7.2 runtime 的本地調(diào)試?IDE 建議使用 VSCode，其斷點調(diào)試步驟與其他語言有一定差異性，因此單獨進(jìn)行介紹。目前 php7.2 runtime 不支持端云聯(lián)調(diào)斷點調(diào)試。

• 調(diào)試 Http 函數(shù)

• 調(diào)試 php7.2 Http 函數(shù)

php7.2 runtime 的本地調(diào)試 IDE 建議使用 VSCode，其斷點調(diào)試步驟與其他語言有一定差異性，因此單獨進(jìn)行介紹。目前 php7.2 runtime 不支持端云聯(lián)調(diào)斷點調(diào)試。

2）Intellij

接著，自定義調(diào)試器名稱，并將端口設(shè)置為 3000，如下圖所示。

3）Pycharm

# event 函數(shù)$ s local invoke --config pycharm --debug-port 3000
# http 函數(shù)$ s local start --config pycharm --debug-port 3000

隨后設(shè)置自定義調(diào)試器名稱，并基于圖五中獲取的內(nèi)容配置 IDE host name、Port 以及 Path mappings 這三個調(diào)試器配置的詳情，如圖中所示。

# event 函數(shù)$ s local invoke
# http 函數(shù)$ s local start

Event 函數(shù)啟動指令執(zhí)行后會直接進(jìn)入斷點調(diào)試階段；Http 函數(shù)啟動指令執(zhí)行后，可以先通過 curl 指令、瀏覽器等方式訪問 Http 函數(shù)的 URL，此時程序會啟動，斷點調(diào)試就開始了。

step4：結(jié)束斷點調(diào)試：調(diào)試完成后，主動關(guān)閉斷點調(diào)試器，對于 Http 函數(shù)而言，在啟動指令終端頁面，需執(zhí)行?Ctrl+C?方可退出調(diào)試進(jìn)程。

結(jié)語

Serverless 應(yīng)用的調(diào)試雖然備受詬病，但是各個云廠商并沒有因此放棄在調(diào)試方向的不斷深入探索。以阿里云函數(shù)計算為例，目前支持提供在線調(diào)試、本地調(diào)試、端云聯(lián)調(diào)等多種調(diào)試方案。而 Serverless Devs 工具所提供的應(yīng)用調(diào)試能力也十分全面了。

• 斷點調(diào)試步驟繁瑣，需要在多個頁面來回切換，如果能將工具集成到 IDE，以插件化形態(tài)供所用戶使用，簡化流程，那么體驗感會大幅提升。

• 斷點調(diào)試模式下的熱更能力：Http 函數(shù)的斷點調(diào)試過程中，并不支持代碼熱更新，每次修改完代碼后，都需要重新執(zhí)行一遍斷點調(diào)試流程，體驗不太流暢。

• 斷點調(diào)試能力目前還未全面覆蓋所有 Runtime，例如 custom runtime 不支持?jǐn)帱c調(diào)試，php runtime 不支持端云聯(lián)調(diào)斷點調(diào)試等。

附錄

「01」

默認(rèn)調(diào)試參數(shù)

「02」

斷點調(diào)試實操視頻

下面的動圖教程均已提前完成文中提到的 “前置操作” 步驟，若要參考具體動圖進(jìn)行實踐，請先完成上文 “前置操作” 的相關(guān)流程。

1）VSCode

• 本地調(diào)試 Event 函數(shù)

• 本地調(diào)試 php7.2 event 函數(shù)

• 端云聯(lián)調(diào) Event 函數(shù)

• 本地調(diào)試 Http 函數(shù)

• 本地調(diào)試 php7.2 Http 函數(shù)

• 端云聯(lián)調(diào) Http 函數(shù)

2）Intellij

• 本地調(diào)試 Event 函數(shù)

• 端云聯(lián)調(diào) Event 函數(shù)

3）Pycharm

• 本地調(diào)試 Event 函數(shù)

• 本地調(diào)試 Http 函數(shù)

社區(qū)網(wǎng)址一覽（可滑動）：

社區(qū)官網(wǎng)：http://www.serverless-devs.com/ServerlessDesktop桌面客戶端：https://serverlessdevs.resume.net.cn/zh-cn/desktop/index.htmlServerless應(yīng)用開發(fā)者套件：http://serverless-dk.oss.devsapp.net/docs/tutorial-dk/intro/reactServerless?Devs?CLI:https://serverlessdevs.resume.net.cn/zh-cn/cli/index.htmlServerless?Hub應(yīng)用中心:https://serverlesshub.resume.net.cn/#/hubs/special-view

RECRUITMENT

極速上手?Serverless

隨著 Serverless 熱度不斷升高，越來越多人期望在實際工作中能快速上手。為了讓更多 Serverless 初學(xué)者真正學(xué)會 Serverless 理論知識，在工作中根據(jù)需要靈活應(yīng)用 Serverless 技術(shù)，阿里云 Serverless 團(tuán)隊推出技術(shù)圖譜，本課程包含機(jī)頻、動手實驗、電子書、直播、開源項目多種形式內(nèi)容，讓各位開發(fā)者即學(xué)即用，跑步入場享受 Serverless 技術(shù)紅利！