views:

9142

answers:

3

As part of some error handling in our product, we'd like to dump some stack trace information. However, we experience that many users will simply take a screenshot of the error message dialog instead of sending us a copy of the full report available from the program, and thus I'd like to make some minimal stack trace information available in this dialog.

A .NET stack trace on my machine looks like this:

at System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)
at System.IO.FileStream.Init(String path, FileMode mode, FileAccess access, Int32 rights, Boolean useRights, FileShare share, Int32 bufferSize, FileOptions options, SECURITY_ATTRIBUTES secAttrs, String msgPath, Boolean bFromProxy)
at System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share, Int32 bufferSize, FileOptions options)
at System.IO.StreamReader..ctor(String path, Encoding encoding, Boolean detectEncodingFromByteOrderMarks, Int32 bufferSize)
at System.IO.StreamReader..ctor(String path)
at LVKWinFormsSandbox.MainForm.button1_Click(Object sender, EventArgs e) in C:\Dev\VS.NET\Gatsoft\LVKWinFormsSandbox\MainForm.cs:line 36

I have this question:

The format looks to be this:

at <class/method> [in file:line ##]

However, the at and in keywords, I assume these will be localized if they run, say, a norwegian .NET runtime instead of the english one I have installed.

Is there any way for me to pick apart this stack trace in a language-neutral manner, so that I can display only the file and line number for those entries that have this?

In other words, I'd like this information from the above text:

C:\Dev\VS.NET\Gatsoft\LVKWinFormsSandbox\MainForm.cs:line 36

Any advice you can give will be helpful.

+16  A: 

You should be able to get a StackTrace object instead of a string by saying

var trace = new System.Diagnostics.StackTrace(exception);

You can then look at the frames yourself without relying on the framework's formatting.

See also: StackTrace reference

Curt Hagenlocher
Oooh, nice, I didn't know that! I'll definitely look into this.
Lasse V. Karlsen
Thanks, this did exactly what I wanted, once I sorted out the needFileInfo parameter to the constructor :)
Lasse V. Karlsen
In release mode are you still able to get stack trace of an exception precisely?
erdogany
Excellent, didn't realise that was possible +1
Andrew Bullock
A: 

As alternative, log4net, though potentially dangerous, has given me better results than System.Diagnostics. Basically in log4net, you have a method for the various log levels, each with an Exception parameter. So, when you pass the second exception, it will print the stack trace to whichever appender you have configured.

example: Logger.Error("Danger!!!", myException );

The output, depending on configuration, looks something like

System.ApplicationException: Something went wrong.
   at Adapter.WriteToFile(OleDbCommand cmd) in C:\Adapter.vb:line 35
   at Adapter.GetDistributionDocument(Int32 id) in C:\Adapter.vb:line 181
   ...
Greg Ogle
Could you clarify what you mean about log4net being "potentially dangerous"?
Scott A. Lawrence
I don't know for sure what Oglester meant, but I know stackoverflow.com had some deadlock problems because log4net was logging exceptions to a database. I haven't personally had any problems, but I keep it simple and stick to rolling text files.
Don Kirkby
If you do not manage your references properly, you'll end up with a memory leak. The web site I worked on a while back uses log4net extensively (rolling files). Because log4net references file (unsafe), you must be sure to keep log4net references cleaned up or to a minumum.
Greg Ogle
+6  A: 

Here is the code I use to do this without an exception

public static void LogStack()
{
  var trace = new System.Diagnostics.StackTrace();
  foreach (var frame in trace.GetFrames())
  {
    var method = frame.GetMethod();
    if (method.Name.Equals("LogStack")) continue;
    Log.Debug(string.Format("{0}::{1}", 
        method.ReflectedType != null ? method.ReflectedType.Name : string.Empty,
        method.Name));
  }
}
Lindholm