スタックトレースを取得するには
エラーが起きた場所までの呼び出しの経路(スタックトレース)を、文字列として取り出して表示や記録に使う書き方を各言語で示す。
例外が持っている言語と、必要な場所で自分で取る言語の違いもまとめる。
公開:
選んだ言語は、ほかのサンプルコードを開いたときも最初に表示する。
Python
import traceback
def inner():
raise ValueError("boom")
def outer():
inner()
try:
outer()
except ValueError:
# 例外を処理した場所で、スタックトレースを文字列として取り出す
print(traceback.format_exc())
# 出力の例(ファイルのパスと行番号は環境で変わる)
# Traceback (most recent call last):
# File "main.py", line 13, in <module>
# outer()
# File "main.py", line 9, in outer
# inner()
# File "main.py", line 5, in inner
# raise ValueError("boom")
# ValueError: boomtraceback.format_exc は、いま処理している例外のスタックトレースを文字列で返す。
表示だけなら traceback.print_exc でもよいが、ログに残すときは文字列で受け取るほうが扱いやすい。
JavaScript
function inner() {
throw new Error("boom");
}
function outer() {
inner();
}
try {
outer();
} catch (err) {
// stack は「名前: メッセージ」の行に、呼び出しの経路が続く文字列
console.log(err.stack);
}
// 出力の例(パスと行・列の番号は環境で変わる)
// Error: boom
// at inner (/path/main.js:2:9)
// at outer (/path/main.js:6:3)
// at Object.<anonymous> (/path/main.js:10:3)
// ...(Node.js 内部の呼び出しが続く)Error の stack プロパティは、「名前: メッセージ」の行に呼び出しの経路が続く文字列である。
ログに残すときは message だけでなく stack も出すと、発生場所を追える。
TypeScript
function inner(): never {
throw new Error("boom");
}
function outer(): void {
inner();
}
try {
outer();
} catch (err: unknown) {
// stack は Error が持つ省略可能なプロパティ(string | undefined)
if (err instanceof Error) {
console.log(err.stack);
}
}
// 出力の例(パスと行・列の番号は環境で変わる)
// Error: boom
// at inner (/path/main.ts:2:9)
// at outer (/path/main.ts:6:3)
// ...(実行ツールや Node.js 内部の呼び出しが続く)stack は Error が持つ省略可能なプロパティで、型は string | undefined である。catch の変数は unknown なので、instanceof Error で絞り込んでから読む。
Go
package main
import (
"errors"
"fmt"
"runtime/debug"
)
func inner() error {
// error にスタックトレースは付かない。必要な場所で debug.Stack で取る
fmt.Printf("%s\n", debug.Stack())
return errors.New("boom")
}
func main() {
if err := inner(); err != nil {
fmt.Println(err)
}
}
// 出力の例(パスと +0x の位置は環境で変わる)
// goroutine 1 [running]:
// runtime/debug.Stack()
// /usr/local/go/src/runtime/debug/stack.go:26 +0x5e
// main.inner()
// /path/main.go:11 +0x17
// main.main()
// /path/main.go:16 +0x13
//
// boomGo の error にスタックトレースは付かないので、必要な場所で runtime/debug.Stack を呼んで取る。Stack は呼んだ時点の呼び出しの経路をバイト列で返す。
Rust
use std::backtrace::Backtrace;
fn inner() {
// force_capture は環境変数に関係なく、その場の呼び出しの経路を取る
let bt = Backtrace::force_capture();
println!("{}", bt);
}
fn outer() {
inner();
}
fn main() {
outer();
}
// 出力の例(先頭の数行。後ろに標準ライブラリ内部の呼び出しが続く)
// 0: main::inner
// 1: main::outer
// 2: main::mainstd::backtrace::Backtrace::force_capture は、呼んだ場所の呼び出しの経路を取る。
環境変数に関係なく必ず取れるので、診断用の出力に向いている。
Java
public class Main {
static void inner() {
throw new IllegalStateException("boom");
}
static void outer() {
inner();
}
public static void main(String[] args) {
try {
outer();
} catch (IllegalStateException e) {
// 標準エラー出力に、例外名・メッセージ・呼び出しの経路を出す
e.printStackTrace(System.out);
}
}
}
// 出力の例(行番号は環境で変わる。後ろに実行ツール内部の呼び出しが続くことがある)
// java.lang.IllegalStateException: boom
// at Main.inner(Main.java:3)
// at Main.outer(Main.java:7)
// at Main.main(Main.java:12)printStackTrace は、例外名・メッセージ・呼び出しの経路を出力する。
引数なしだと標準エラー出力に出るので、ここでは System.out を渡して標準出力に出している。
C#
try
{
Outer();
}
catch (InvalidOperationException e)
{
// StackTrace は throw された時点からの経路を文字列で持つ
Console.WriteLine(e.StackTrace);
}
static void Inner() => throw new InvalidOperationException("boom");
static void Outer() => Inner();
// 出力の例(ファイルのパスと行番号は環境で変わる)
// at Program.<<Main>$>g__Inner|0_0() in /path/Program.cs:line 11
// at Program.<<Main>$>g__Outer|0_1() in /path/Program.cs:line 13
// at Program.<Main>$(String[] args) in /path/Program.cs:line 3Exception.StackTrace は、例外が投げられた場所からの呼び出しの経路を文字列で持つ。
例外の名前とメッセージは含まれないので、必要なら ToString を使う。
スタックトレースは例外が持つ言語と、自分で取る言語がある
同じ boom というエラーでも、スタックトレースの手に入り方は言語で分かれた。
- Python・JavaScript・TypeScript・Java・C# は、例外のオブジェクトがスタックトレースを持っている。
- Go の
errorにはスタックトレースが付かない。debug.Stackを呼んだ場所の経路が取れるだけで、エラーが作られた場所の経路は残らない。 - Rust の
ResultのErrも、そのままではスタックトレースを持たない。Backtraceを自分で取って、エラー型に持たせる。
Go と Rust でエラーの発生場所を残したいときは、エラーを作る時点で経路を取っておく。
Rust の Backtrace は環境変数で有効になる
Backtrace::capture は、環境変数 RUST_BACKTRACE か RUST_LIB_BACKTRACE が有効でないと取らず、出力は disabled backtrace だった。
常に取りたいときは Backtrace::force_capture を使う。
panic のメッセージにも、RUST_BACKTRACE=1 を付けて実行するとスタックトレースが付くという案内が出た。
通常は Result でエラーを返し、panic は想定外の異常に限る。
C# は throw と throw ex でスタックトレースが変わる
catch した例外を投げ直すとき、throw; と throw e; では StackTrace が違った。
throw;は、元のInnerから始まる経路をそのまま保った。throw e;は、投げ直した場所から経路が始まり、元のInnerが消えた。
原因を追えるように、投げ直すときは throw; を使う。
出力の中身は環境で変わる
スタックトレースには、ファイルのパス・行番号・実行ツールや標準ライブラリ内部の呼び出しが含まれ、実行する環境で変わる。
そのため、出力の全文を比べて判定する書き方はしない。
ログに残すときも、パスに利用者名などの個人情報が含まれることがあるので、外部へ送る前に確かめる。