デバッグの勘所をベテランに聞く!勘に頼らない実践手法のナレッジ共有

デバッグの勘所をベテランに聞く!勘に頼らない実践手法のナレッジ共有

SECIモデル,ナレッジ共有,社内勉強会

ソリューション開発部の畑澤です。

部内では「情報共有プロジェクト」という活動に取り組んでいます。

情報共有プロジェクトではSECIモデル(個人の暗黙知を組織の形式知に変えていく知識創造のモデル)を参考に、部内でのナレッジ共有に向けた活動を進めています。

今回は【共同化】【表出化】の場として、「デバッグの勘所」をテーマに質疑会を実施しました。
ベテランエンジニアの知見からデバッグを効果的に行うためのポイントを知る貴重な場となりましたので、その内容を対話形式でご紹介します。

これまでの活動内容や、SECIモデルについてはこちらをご参照ください。

今回の質疑会をSECIモデルに照らし合わせると次のように整理できます。

SECIモデルの段階今回の質疑会での位置付け
共同化・表出化各人の得意分野の表明。表明された内容について質疑
連結化質疑で得た知見を形式知として形成
内面化形式知を実務に生かす

本題に入る前に、実施後のアンケート結果をご紹介します。

  • ベテランエンジニアの障害解析における考え方を知ることができた。
  • 他プロジェクトの事例を交えながらデバッグ手法を共有できた。
  • 実際の障害を題材にした演習も行ってみたい。


質疑会の概要と登場人物

ここからが本題です。

今回は「デバッグの勘所」をテーマに、ベテランエンジニアの本間にいろいろと聞いてみました。実際の現場でどのように考えて調査や切り分けを行っているのか、いくつかピックアップしてご紹介します。

本間:話し手。ベテランエンジニア。プログラムを書くことが好き。パッケージ製品開発のお客様を支援するチームに所属。本文では「本」と表記。
畑澤:聞き手。ベテランエンジニア。「浅くてもいいので広い知識」をモットーに、多様な相談をされる人材を目指して日々奮闘。本文では「畑」と表記。
※他の参加者との質疑も編集の都合上、全て畑澤との対話の形で記載しています。

デバッグってまず何する?

畑:調査依頼が来たとき、まず何を見ますか?

本:スタックトレースがあるといいなって思いながらチケットを開きますね。スタックトレースがなかったら、まずは再現するところからです。

畑:やっぱり再現がスタートラインですか?

本:はい。再現できる事象と再現できない事象とでは、調査のスピードが全然違います。
スタックトレースがあれば、それをたどって、足りない箇所にデバッグログを埋めながら解析していきます。もちろん、スタックトレースがあっても自分で再現はさせます。スタックトレースがあるほうが再現しやすく、再現までの時間も短くなります。

勘所メモ

不具合調査は、まず事象を再現することが重要。スタックトレースを手掛かりに、必要なログを追加しながら原因を絞り込んでいく。

デバッグの基本ステップ

本:大まかに言うとこんな流れです。

  1. 再現させる
  2. 原因を特定する
  3. 真の原因を特定する
  4. 関係者と方針を決める
  5. 修正する

畑:「原因」と「真の原因」って違うんですね。

本:そうですね。表面に出ている現象って結果でしかないことが多いです。
例えば通信エラーが出ていても、それは二次的な問題で、もっと上流に原因があることも多いんです。

畑:今回は「デバッグの勘所」がテーマなので、「1.再現させる」「2.原因を特定する」にフォーカスしていきましょう。

障害報告内容を鵜呑みにしない

畑:「まずは再現」についてですが、往々にして再現できない場合ってあると思うんです。そういうときはどうしてますか?

本:報告に手順が書かれていることが前提ですが、まずは手順どおりに自分で試します。それでも再現できなければ、報告者(発見者)に聞きに行きます。
報告者が再現できるなら、実際に操作を見せてもらいます。難しい場合は、スクリーンショットを提供してもらいます。これで原因が分かることも多いです。

本:報告内容は重要な手掛かりではありますが、報告者が無意識に行っている操作や、データの条件が原因になっていることもあります。

畑:とても乱暴な表現になってしまいますが、「何もしてないのに壊れました」ってやつですね。

本:仮にバグ(実装バグ・設計バグ)であっても、バグではなくても、報告者の意図しない挙動をしているわけで、原因は必ずあります。

勘所メモ

実際には設定変更や環境差分が​原因と​なっている​ケースも​少なく​ありません。
報告内容を疑うという意味ではなく、事実を確認しながら調査を進めることが重要です。

とにかく範囲を狭める

畑:原因特定のコツってありますか?

本:とにかく「原因があるであろう範囲」を狭めることですね。
まず手元で再現できるようにしてから、実行環境そのものを変えてみたり、ソースコード全体を半分に分けて、どちらに問題があるか当てにいったりします。いわゆる二分探索的なやり方ですね。思い切ってソースコードを消すこともあります。

畑:え、消すんですか?

本:消して動いたら、その消した部分に原因があるって分かるので。

畑:SQLの一部を削って実行するのは割とよくやるかなと思いますが、そんなイメージですか?

本:はい。「原因があるであろう範囲」を狭めることができます。

勘所メモ

全部ソースを読んで理解してから直そうとすると、時間だけが過ぎていきがちです。実際には「削る→動かす→あたりをつける」の方が早く解に近づくことが多いです。

最小単位で再現する

本:もう一つ大事なのが「最小単位で再現する」ことです。怪しいメソッドだけ取り出して実行できるようにしたりします。1回の試行はできるだけ短くしたいですね。15秒くらいで回せると理想です。

畑:試す回数を増やすためですね。

本:試行回数を増やしたほうが当たる確率が上がると思っています。考える時間よりも試す時間を増やしていきたい。

畑:(IDEなどでステップ実行しながら原因を特定する方法もよく使われますが、それについては後述します。)

勘所メモ

1回の検証に数分かかる状態だと試すという行為自体に時間がかかり、調査が進みません。「すぐに試せる状態を作ること(作れること)」も非常に重要なスキルです。

あえて壊して確認する

本:大量のログに埋もれてどの処理を通っているか分からないときは、あえて例外を投げて確認することもあります。そこを通れば確実に落ちるので、通っているかどうかがはっきり分かります。

畑:解析用のログ埋め込みと併用して、原因を絞っていく方法ですね。大きなブロックから段階的に原因箇所を特定し、調査範囲を狭めていく。スタックトレースのような情報がなければ、スタックトレースを出してみることもよくやります。

本:狭めていった後に、さっきの「最小単位で試行を繰り返す」ですね。また、「必要な情報がないなら作る」です。スタックトレースが出ていないなら出力する、デバッグログをどんどん埋める。

畑:いわゆる「落ちた場所、原因となった場所」が分かったらステップ実行などで追跡できますしね。

本:​私は二分探索的な切り分けや​printデバッグを​好むので、​IDEの​デバッガを​使う​ことは​少ないです。​避けている​理由は2つあります。​

1つ目は​デバッガの​動作が​安定しない​こと。​IDE上で​ブレークポイントを​設定しても、​そこで​止まる​ときと​止まらない​ときが、​過去に​何度か​ありました。

​2つ目は​時間が​かかる​ことです。ブレークポイントを置いて、そこまで実行させてから、ステップ実行で変数を確認して……とやると、1回の試行が長くなる。さきほど、1回の試行は15秒くらいで回したいと言いましたが、デバッガはそこと相性が悪いんです。いま風に言うなら「タイパが悪い」と感じています。

畑:IDEのデバッガを使い、ブレークポイントを置いてステップ実行するのは一般的な手法だと思っていたので、これは意外でした。ただ、試行回数を稼ぐという軸で見ると一貫していますね。得意なアプローチは人それぞれ、ということかなと。(IDEのデバッガを使うことが少ないという話には、場がざわつきました……)

勘所メモ

あえて派手に落とすことで、状況がはっきりするケースもあります。解析のログ埋め込みを併用して範囲を狭めていきます。「タイパの観点でIDEのデバッガを使うことが少ない」という点は参加者の間でも驚きの声が上がりました。

影響範囲はどう見る?

畑:修正時の影響範囲はどう見ていますか?

本:基本は呼び出し元を全部追います。IDEで呼び出し関係を出すと、影響しうる範囲が見えますね。そこから条件やデータでさらに絞り込んでいく感じです。今だとコーディングエージェントが一次調査をしてくれるので、楽になりました。​

勘所メモ

呼び出し元を追って影響範囲を把握し、条件やデータから対象を絞り込む。コーディングエージェントも一次調査に活用する。

AIはどこで使う?

畑:デバッグの分野でAIの使いどころってありますか?

本:機密情報や顧客情報を含まない形でスタックトレースやエラーを整理して貼るだけで、ほぼ正解が返ってくることもあります。そのため、まずは投機的に生成AIに投げてみています。
利用経験の少ないライブラリの挙動を調べるときにも使いますし、発生している事象から原因候補を洗い出す際の壁打ち相手にもしています。
ただし、AI利用全般に言えることですが、最終的な判断は必ず自分で行います。

勘所メモ

スタックトレースやエラー情報をAIに渡し、原因候補の洗い出しや調査の補助に活用する。ただし、AIの回答を鵜呑みにせず、最終判断は自分で行うことが重要です。

まとめ

  • まずは再現することが最重要
  • 原因と真の原因を分けて考える
  • 範囲を徹底的に狭める
  • 最小単位で高速に試行を繰り返す
  • ときにはあえて壊して確認する
  • AIは調査の補助として活用する

ベテランエンジニアは、経験や知見に裏付けられた「勘」だけで動いているわけではありませんでした。

​再現→切り分け→仮説検証 のサイクルを高速で回すことで、デバッグを進めていたのです。

若手から見ると魔法使いのような動きも、こうしたプロセスの積み重ねで実現されていたのですね。

デバッグは経験に頼りがちな領域です。こうした経験やノウハウを形式知として共有すれば、プロジェクトの垣根を越えた部内の学びにつながると確信しています。
事後のアンケートにも、その手応えが表れていました。情報共有プロジェクトでは、引き続きこの活動を続けていきます。​

  • Zabbix Enterprise Appliance
  • 低コスト・短納期で提供するまるごとおまかせZabbix