Go1.23 新特性：再開(kāi)后門(mén)，可以記錄未捕獲的 panic 和 throw 日志了！
大家好，我是煎魚(yú)。
今天繼續(xù)給大家分享 Go1.23 的新特性，這一輪里還是有不小有意思的驚喜的。其中不得不評(píng)本文中的這個(gè)新變化。必須得來(lái)一篇獨(dú)立話題來(lái)提一下這個(gè)事！
過(guò)去學(xué)習(xí)寫(xiě) Go 時(shí)，初學(xué)者入門(mén)的教程教一定會(huì)提到在使用 panic 時(shí)，強(qiáng)烈建議要使用 recover。否則在 goroutine 的場(chǎng)景下很容易出問(wèn)題，也會(huì)導(dǎo)致記不來(lái)日志。
新版本后，終于有兜底 Go 程序崩潰的日志記錄方法了！過(guò)于感人！
快速入門(mén)
panic+recover 例子
較為標(biāo)準(zhǔn)的 panic+recover 代碼如下：
func mayPanic() {
panic("腦子進(jìn)煎魚(yú)了！")
}
func main() {
defer func() {
if r := recover(); r != nil {
fmt.Println("Recovered. Error:\n", r)
}
}()
mayPanic()
fmt.Println("煎魚(yú)被燒著了")
}輸出結(jié)果：
Recovered. Error:
腦子進(jìn)煎魚(yú)了！常見(jiàn)的錯(cuò)誤場(chǎng)景
想法很美好，有兩個(gè)常見(jiàn)的錯(cuò)誤的場(chǎng)景。很折磨人心態(tài)。
1、會(huì)有經(jīng)常會(huì)有出現(xiàn)起了 goroutine，業(yè)務(wù)程序出現(xiàn)了預(yù)料之外的場(chǎng)景，導(dǎo)致出現(xiàn)了 panic，也沒(méi)有 recover。此時(shí)如果外部沒(méi)有統(tǒng)一的 recover，就會(huì)導(dǎo)致業(yè)務(wù)受阻。
2、更夸張的是 Go 內(nèi)部源碼偶爾會(huì)有觸發(fā)使用 throw 函數(shù)，導(dǎo)致拋出致命錯(cuò)誤的場(chǎng)景，最經(jīng)典的是 map 并發(fā)讀寫(xiě)導(dǎo)致的致命錯(cuò)誤。
如下代碼例子：
func main() {
var wg sync.WaitGroup
m := make(map[int]int)
// 寫(xiě)操作
wg.Add(1)
go func() {
defer wg.Done()
for i := 0; i < 1000; i++ {
m[i] = i
}
}()
// 讀操作
wg.Add(1)
go func() {
defer wg.Done()
for i := 0; i < 1000; i++ {
_ = m[i]
}
}()
wg.Wait()
fmt.Println("煎魚(yú)收工了！")
}在運(yùn)行程序結(jié)果時(shí)，會(huì)看到輸出如下結(jié)果：
煎魚(yú)收工了！只要你多運(yùn)行幾次，有概率觸發(fā)以下問(wèn)題：
fatal error: concurrent map read and map write
goroutine 35 [running]:
main.main.func2()
/Users/eddycjy/app/go/example/demo1/main.go:26 +0x6c
created by main.main in goroutine 1
/Users/eddycjy/app/go/example/demo1/main.go:23 +0xe8
goroutine 1 [semacquire]:
sync.runtime_Semacquire(0x140000021c0?)
/opt/homebrew/Cellar/go/1.22.6/libexec/src/runtime/sema.go:62 +0x2c
...這類致命錯(cuò)誤是 recover 所無(wú)法捕獲的。也因此在產(chǎn)線環(huán)境偶爾會(huì)出現(xiàn)這類紕漏導(dǎo)致的容器重啟等問(wèn)題。
問(wèn)題背景
在 Go 編程中，現(xiàn)階段很難很好地統(tǒng)一捕獲 Go 程序的未知崩潰輸出。崩潰會(huì)打印到 stderr，但是 Go 程序通常會(huì)將 stdout 和 stderr 用于其他目的。
雖然將其輸出到 stderr 并沒(méi)有錯(cuò)，但它會(huì)將兩個(gè)輸出混合在一起，使以后的分離更加困難。排查問(wèn)題也需要查看所有大量的調(diào)試信息。
因此捕獲未知的崩潰（無(wú)論是 panic 還是 thorew）對(duì)于事后調(diào)試和發(fā)送報(bào)告很有價(jià)值。
注：尤其是在 k8s 中很多是建議輸出到 stdout、stderr 中的，這樣在發(fā)生未知崩潰時(shí)，排查起來(lái)會(huì)更麻煩。
Go1.23 debug.SetCrashOutput
Go1.23 新版本中，本次在 runtime/debug 庫(kù)中新增了 debug.SetCrashOutput 方法。
圖片
函數(shù)簽名如下：
func SetCrashOutput(f *os.File, opts CrashOptions) error代碼例子：
import (
"io"
"log"
"os"
"os/exec"
"runtime/debug"
)
func main() {
monitor()
println("煎魚(yú)下午好?。?！")
// 沒(méi)有被 recover 的未知錯(cuò)誤
panic("oops")
}
func monitor() {
const monitorVar = "RUNTIME_DEBUG_MONITOR"
if os.Getenv(monitorVar) != "" {
// 實(shí)際演示 debug.SetCrashOutput 設(shè)置后的邏輯
log.SetFlags(0)
log.SetPrefix("monitor: ")
crash, err := io.ReadAll(os.Stdin)
if err != nil {
log.Fatalf("failed to read from input pipe: %v", err)
}
if len(crash) == 0 {
os.Exit(0)
}
f, err := os.CreateTemp("", "*.crash")
if err != nil {
log.Fatal(err)
}
if _, err := f.Write(crash); err != nil {
log.Fatal(err)
}
if err := f.Close(); err != nil {
log.Fatal(err)
}
log.Fatalf("saved crash report at %s", f.Name())
}
// 模擬應(yīng)用程序進(jìn)程，設(shè)置 debug.SetCrashOutput 值
exe, err := os.Executable()
if err != nil {
log.Fatal(err)
}
cmd := exec.Command(exe, "-test.run=ExampleSetCrashOutput_monitor")
cmd.Env = append(os.Environ(), monitorVar+"=1")
cmd.Stderr = os.Stderr
cmd.Stdout = os.Stderr
pipe, err := cmd.StdinPipe()
if err != nil {
log.Fatalf("StdinPipe: %v", err)
}
debug.SetCrashOutput(pipe.(*os.File), debug.CrashOptions{})
if err := cmd.Start(); err != nil {
log.Fatalf("can't start monitor: %v", err)
}
}輸出結(jié)果：
$ go run main.go
煎魚(yú)下午好！??！
panic: oops
goroutine 1 [running]:
main.main()
/Users/eddycjy/app/go/example/demo1/main.go:15 +0x48
exit status 2
monitor: saved crash report at /var/folders/y8/whksnvd17qn8bgs17yh_y59m0000gn/T/92172971.crash崩潰后的文件記錄：
$ cat /var/folders/y8/whksnvd17qn8bgs17yh_y59m0000gn/T/92172971.crash
panic: oops
goroutine 1 [running]:
main.main()
/Users/eddycjy/app/go/example/demo1/main.go:15 +0x48非常順利的記錄到未 recover 的 panic 導(dǎo)致的 crash 了。
總結(jié)
本次 Go1.23 在 runtime/debug 中新增了 debug.SetCrashOutput 方法來(lái)允許設(shè)置未被捕獲的錯(cuò)誤、異常的日志寫(xiě)入。可用于為所有 Go 進(jìn)程意外崩潰構(gòu)建自動(dòng)報(bào)告機(jī)制！
這個(gè)變動(dòng)雖然不大，但是對(duì)于我們?nèi)粘?xiě) Go 業(yè)務(wù)工程的同學(xué)來(lái)講，是個(gè)很不錯(cuò)的升級(jí)！終于打開(kāi)了一個(gè)新的后門(mén)！
