このチュートリアルでは、OpenResty XRay を使用して Go アプリケーションのプログラム例外をオンラインで分析する方法を紹介します。OpenResty XRay は、Go のオンラインプロセスにおけるコード例外を検出および分析することができます。これには、プロセスのクラッシュを引き起こさないキャッチされた例外も含まれます。注目すべきは、アプリケーション自体がすでにキャッチして処理した例外でさえ、OpenResty XRay が検出できることです。これにより、問題診断の能力が大幅に向上します。これらのコードパスは、OpenResty XRay が Go 言語レベルの例外フレームグラフを自動的に分析および解釈することで得られます。これにより、パフォーマンスへの影響を最小限に抑えます。したがって、OpenResty XRay は、パフォーマンスのオーバーヘッドと遅延に敏感な本番環境に非常に適しています。

Go アプリケーションのプログラム例外を分析する

本文では、実行中の任意の Go アプリケーションにおけるプログラム例外、つまり panic の分析をオンラインで行う方法をご紹介いたします。ここでは、Linux ディストリビューションに標準搭載されている、未修正の Go コンパイラを使用します。

対象となる Go プログラムは、通常の go build コマンドでコンパイルされています。特別な変更や特殊なオプションの追加は必要ありません

OpenResty XRay の Web コンソールに移動します。

現在分析中のマシンが正しいことを確認します。

正しくない場合は、リストから再選択することができます。

「Guided Analysis」ページに移動します。

ここでは、システムが分析可能な様々な種類の問題を確認できます。

「Errors & exceptions」を選択します。

「Next」をクリックします。

先ほどの Go アプリケーションを選択します。

これは先ほどの対象プロセスでを選択します。

アプリケーションのタイプが正しいことを確認します。通常、デフォルト値が正しいです。

ここでの言語レベルは「Go」のみとなっています。

最長分析時間を設定することもできます。ここではデフォルトの 300 秒のままにします。

分析を開始します。

システムは複回数の分析を継続的に実行します。現在、初回の分析を実行中です。

初回の分析が完了し、現在 2 回目のラウンドに入っております。この例では、1 回の分析で十分です。

分析を停止します。

自動生成された分析レポートをご確認しましょう。

これは分析する問題のタイプです。「Errors & exceptions」です。

まず、最初の例外を投げる Go コードのパスを確認しましょう。

Go は最終的に、ランタイムの gopanic 関数を通じて例外を投げます。

このコードパスでは、gopanic 関数はランタイムの panicdivide 関数から呼び出されています。これは、ゼロ除算エラーを意味します。

呼び出しコンテキストによると、calculate 関数がプログラム例外を投げています。この関数はビジネスロジックレベルのコードに属します。

handleHTTPRequest 関数は、Go の Web フレームワークである Gin に属しています。この関数は、受信した HTTP リクエストの処理を担当します。

「More」をクリックしてください。

このホットコードパスは、Go レベルの例外フレームグラフから自動的に導き出されたものです。

以下は、問題に関するより詳細な説明と提案です。上記のプログラム例外がゼロ除算エラーによって引き起こされたことが言及されています。

これは、このエラーを修正できるコード例です。

元のホットコードパスに戻ります。calculate 関数の緑色のボックスにマウスを合わせてください。

ツールチップには、この関数のソースファイル名とフルパスが表示されます。

このソースコードの行番号は 25 です。

このアイコンをクリックして、関数のソースファイルパスをコピーしてください。

vim エディタでソースファイルを開きます。先ほどコピーしたファイルパスを貼り付けてください。お好みのエディタをご使用いただいて構いません。

OpenResty XRayが提案したように、25 行目にジャンプします。

先ほどコードパスで確認したように、このコード行は calculate 関数内部にあります。除数 b がゼロでないかを最初にチェックする必要があります。

次に、2 番目のプログラム例外を投げるコードパスを確認しましょう。

これは上記と同様の gopanic 関数です。

goPanicIndex 関数も Go の標準ランタイムに属します。このコードパスでは、このプログラム例外はランタイムの goPanicIndex 関数によってトリガーされています。

おそらく、この weekday.Handler 関数内の配列またはスライスのインデックスでアウトオブバウンドアクセスが発生しています。この Go 関数はビジネスコードレベルに属します。

この関数にマウスを合わせると、ツールチップにそのソースファイルパスが表示されます。

このソースコードの行番号は 17 です。

そのソースファイルパスをコピーしてください。

ターミナルでソースファイルを開きます。先ほどコピーしたファイルパスを貼り付けてください。

17 行目にジャンプします。確かに、インデックスを使って配列要素にアクセスしていることがわかります。

この配列変数名は weekDays です。

この関数は、インデックス変数 i の値の範囲を確認していません。

この i 変数は、クライアントリクエストから任意の整数値を取得できる可能性があります。

自動生成レポート

OpenResty XRay はオンラインプロセスを自動的に監視し、分析レポートを生成することもできます。

「Insights」ページに切り替えます。

「Insights」ページで、日次および週次の自動レポートを見つけることができます。そのため、「Guided Analysis」機能を使用する必要はありません。

もちろん、「Guided Analysis」はアプリケーションの開発とデモンストレーションに非常に有用です。

OpenResty XRay について

OpenResty XRay は動的トレーシング製品であり、実行中のアプリケーションを自動的に分析して、パフォーマンスの問題、動作の問題、セキュリティの脆弱性を解決し、実行可能な提案を提供いたします。基盤となる実装において、OpenResty XRay は弊社の Y 言語によって駆動され、Stap+、eBPF+、GDB、ODB など、様々な環境下で複数の異なるランタイムをサポートしております。

著者について

章亦春（Zhang Yichun）は、オープンソースの OpenResty^® プロジェクトの創始者であり、OpenResty Inc. の CEO および創業者です。

章亦春（GitHub ID: agentzh）は中国江蘇省生まれで、現在は米国ベイエリアに在住しております。彼は中国における初期のオープンソース技術と文化の提唱者およびリーダーの一人であり、Cloudflare、Yahoo!、Alibaba など、国際的に有名なハイテク企業に勤務した経験があります。「エッジコンピューティング」、「動的トレーシング」、「機械プログラミング」 の先駆者であり、22 年以上のプログラミング経験と 16 年以上のオープンソース経験を持っております。世界中で 4000 万以上のドメイン名を持つユーザーを抱えるオープンソースプロジェクトのリーダーとして、彼は OpenResty^® オープンソースプロジェクトをベースに、米国シリコンバレーの中心部にハイテク企業 OpenResty Inc. を設立いたしました。同社の主力製品である OpenResty XRay動的トレーシング技術を利用した非侵襲的な障害分析および排除ツール）と OpenResty XRay（マイクロサービスおよび分散トラフィックに最適化された多機能ゲートウェイソフトウェア）は、世界中の多くの上場企業および大企業から高い評価を得ております。OpenResty 以外にも、章亦春は Linux カーネル、Nginx、LuaJIT、GDB、SystemTap、LLVM、Perl など、複数のオープンソースプロジェクトに累計 100 万行以上のコードを寄与し、60 以上のオープンソースソフトウェアライブラリを執筆しております。

翻訳

英語版の原文と日本語訳版（本文）をご用意しております。読者の皆様による他の言語への翻訳版も歓迎いたします。全文翻訳で省略がなければ、採用を検討させていただきます。心より感謝申し上げます！