Line data Source code
1 : package crashreport
2 :
3 : import (
4 : "fmt"
5 : "runtime"
6 : "runtime/debug"
7 : "sync"
8 : "sync/atomic"
9 : "time"
10 :
11 : "github.com/kijimaD/ruins/internal/consts"
12 : "github.com/kijimaD/ruins/internal/logger"
13 : )
14 :
15 : // saveOnce はクラッシュ保存を1プロセス1回に限る。複数箇所の Guard が発火してもファイルは1つに保つ。
16 : var saveOnce sync.Once
17 :
18 : // stateProvider は落ちた時点の最上位ステート名を取り出す関数。登録側と読み取り側が別 goroutine なので
19 : // atomic.Pointer で型安全に共有する。
20 : var stateProvider atomic.Pointer[func() string]
21 :
22 : // SetStateProvider は最上位ステート名の取り出し方を登録する。起動時に1度呼び、保存時に引く。
23 1 : func SetStateProvider(f func() string) { stateProvider.Store(&f) }
24 :
25 : // Guard は defer で使う。panic を捕らえて1回だけ保存し、握りつぶさず再 panic する。
26 : // recover は同一 goroutine の panic だけを捕らえるので、必ず通る関数の先頭へ置く。
27 : func Guard() {
28 1 : if r := recover(); r != nil {
29 2 : saveOnce.Do(func() { save(r, debug.Stack()) })
30 1 : panic(r) // 保存後に本来の落ち方へ戻す。stderr へのトレース出力と非0終了を保つ
31 : }
32 : }
33 :
34 : // save はクラッシュ情報を1ファイルへ書く。失敗はベストエフォートで握りつぶし、クラッシュ処理で
35 : // さらに落ちて元の panic を覆わないようにする。呼ぶのは Guard だけ。
36 : func save(recovered any, stack []byte) {
37 1 : rec := buildRecord(recovered, stack, currentState())
38 1 : if path := writeRecord(rec); path != "" {
39 1 : logger.New(logger.CategoryCrash).Error("crash report saved", "path", path)
40 1 : }
41 : }
42 :
43 : // buildRecord は諸元を集めて CrashRecord にする。ステート名は呼び出し側が渡す純関数。
44 : func buildRecord(recovered any, stack []byte, state string) CrashRecord {
45 1 : now := time.Now()
46 1 : return CrashRecord{
47 1 : at: now,
48 1 : Timestamp: now.Format(time.RFC3339),
49 1 : Level: logger.LevelFatal.String(), // "FATAL"。logger の表記を単一出典にして取り違えを防ぐ
50 1 : Category: string(logger.CategoryCrash), // "crash"
51 1 : Message: fmt.Sprintf("%v", recovered),
52 1 : Version: consts.AppVersion,
53 1 : GOOS: runtime.GOOS,
54 1 : GOARCH: runtime.GOARCH,
55 1 : Steam: consts.IsSteamBuild,
56 1 : State: state,
57 1 : Stack: string(stack),
58 1 : }
59 : }
60 :
61 : // currentState は登録済み provider を安全に引く。provider 自体が落ちても元の panic を覆わない。
62 : func currentState() (name string) {
63 1 : p := stateProvider.Load()
64 1 : if p == nil {
65 1 : return ""
66 1 : }
67 2 : defer func() { _ = recover() }()
68 1 : return (*p)()
69 : }
70 :
71 : // CrashRecord は1回のクラッシュを表す構造化ログレコード。
72 : // フィールド名は logger の JSON エントリ timestamp・level・category・message に揃える。
73 : type CrashRecord struct {
74 : at time.Time // ファイル名と Timestamp を同一時刻から作るための内部保持。JSON には出さない
75 : Timestamp string `json:"timestamp"` // RFC3339
76 : Level string `json:"level"` // "FATAL"
77 : Category string `json:"category"` // "crash"
78 : Message string `json:"message"` // recover した値の文字列。全文は Stack にある
79 : Version string `json:"version"`
80 : GOOS string `json:"goos"`
81 : GOARCH string `json:"goarch"`
82 : Steam bool `json:"steam"`
83 : State string `json:"state,omitempty"` // 最上位ステート名。無ければ空
84 : Stack string `json:"stack"`
85 : }
|