Azureの診断モニタにエラーログのソース行数を表示する方法

Question

Windows Azure SDKの1.5のサポートが切れたため、最新の2.8に
アップグレードしました。

処理の実行中に例外が発生した場合、診断モニタからWADLogsTableへStackTraceを出力しているのですが、2.8から出力されるログに、ソースコードの行数が出なくなってしまい、エラーが発生した箇所の特定ができなくなってしまいました。

セキュリティ上、ソースを貼ることができないため、以下にかなり簡略化した
ソースを記述します。
手元に本物のソースがないので、記憶を頼りに書いています。
記述が間違っていたら適宜、脳内で修正してくださいm(_ _)m

//TestClass.cs
class TestClass
{
    static void Main(string[] args)
    {
       try{
          // SubClassのAddDataを実行する
          Process proc = new SubClass();
          proc.addData();

       } catch(Exception e){
            //エラーのStackTraceを出力
            Trace.TraceError(e.StackTrace); //仮に、ここがTestClass.csの100行目だったとする
       }

    }
}

//SubClass.cs
class SubClass
{
    public void addData()
    {
        //ここがSubClass.csの20行目とし、例外が発生したとする
    }
}

上記のソースの事象が発生すると、以下のようにログが出力されてしまいます。

(省略)
at SubClass2.addData()
at TestClass.main():100

これを「addData():20」というようにエラーの最初の発生箇所を出力したいのですが、どうすればよいでしょうか。

Answer 1

System.Diagnostics.Trace.TraceError(String message)よりアプリケーション トレースログを出力しているかと思いますが、こちらについては引数の文字列がそのままログとして出力されます。
ですので、記述いただいたソース中のe.StackTraceで出力される文字列がそのままトレースされているはずです。
実際の実行環境で上記のソースのe.StackTrace部分をコンソール等で出力した場合、Azure Strageへトレースされたログと差分はございますでしょうか。

また、少し調査してみましたところ、Azure SDK for .NETのv1.5、v2.8で.NET Framework のサポートバージョンが違うという記事を見つけました。

v1.5：3.5 SP1、4.0
v2.8：4.0、4.5、4.5.1、4.5.2系、4.6系

https://msdn.microsoft.com/ja-jp/library/dn479282.aspx

Azure SDK for .NETのバージョンアップの際に、.NET Frameworkのバージョンを上げたなどはございませんでしょうか。
もしそうでしたら、こちらの変更による影響も考えられるかもしれません。
（記述頂いたコードにて.NET Frameworkの各バージョンのStackTraceの内容を見ましたが、私の環境ではStackFrameごとに行数が表示されておりましたが...）

アプリの規模感が不明ですので、実現可能かどうかはわかりませんが、記述いただいたソースを以下のような形で変更頂けると各StackFrame毎の行数の出力等は行えるようになるかと思いますので、どうしても必要だということでしたらお試し下さい。

//TestClass.cs
class TestClass
{
    static void Main(string[] args)
    {
       try{
          // SubClassのAddDataを実行する
          SubClass proc = new SubClass();
          proc.addData();

       } catch(Exception e){
            //エラーのStackTraceを出力
            Trace.TraceError(ShowStackTrace(e));
       }
    }

    //StackTraceより各StackFrameの詳細を取得
    static String ShowStackTrace(Exception e)
    {
       StringBuilder traceLog = new StringBuilder();
       StackTrace trace = new StackTrace(e, true);
       foreach(var frame in trace.GetFrames)
       {
           traceLog.AppendLine("File Name : " + frame.GetFileName());
           traceLog.AppendLine("Class Name : " + frame.GetMethod().ReflectedType.Name);
           traceLog.AppendLine("Method Name" + frame.GetMethod());
           traceLog.AppendLine("Line Number : " + frame.GetFileLineNumber());
           traceLog.AppendLine("=======================================================");
       }
       
       return traceLog.ToString();
    }
}

//SubClass.cs
class SubClass
{
    public void addData()
    {
        //ここがSubClass.csの20行目とし、例外が発生したとする
    }
}

Comments

[tamogi]

先日に引き続き、大変詳しい回答ありがとうございます。

＞実際の実行環境で上記のソースのe.StackTrace部分をコンソール等で出力した場合、Azure Strageへトレースされたログと差分はございますでしょうか。
「実際の実行環境」というのは、Azureにデプロイしたものをリモートデバッグする　ということでしょうか？
まだ試していないです・・・。
ローカルのエミュレータでは行数までちゃんと表示されます。

＞.NET Frameworkのバージョンを上げたなどはございませんでしょうか。
当時最新だった4.5.2(か、4.5のいづれか)に上げました。

提示いただきましたソースを追加してみたところ、確かに行数は出力できたので、とりあえず数日様子を見てみたいと思います。

ちなみに、
foreach(var frame in trace.GetFrames)　は、
foreach(var frame in trace.GetFrames()) と記述しないとコンパイルエラーとなりました。

[y-sakamoto]

＞「実際の実行環境」というのは、Azureにデプロイしたものをリモートデバッグする　ということでしょうか？

記載頂いた内容でも構いませんし、デプロイしたものをデバッグするが難しいのでしたら、Azure StorageのTableサービスあたりへStack Traceを流して確認するなどでもいいかと思います。
私の環境下でも行数がきちんと表示されていたので、質問者様の本番環境で出力されるStack Traceがおかしいのか、TraceErrorメソッドを通したことによっておかしくなったのかを切り分ける必要があるかと思ったためです。

＞ちなみに、
foreach(var frame in trace.GetFrames)　は、
foreach(var frame in trace.GetFrames()) と記述しないとコンパイルエラーとなりました。

失礼致しました。
一部ソースを後から記述した為、ビルド確認がされていない部分がございました。
以後気をつけようと思います。