77

我在 WebApi 应用程序中有以下示例代码设置:

[HttpGet]
public double GetValueAction()
{
    return this.GetValue().Result;
}

public async Task<double> GetValue()
{
    return await this.GetValue2().ConfigureAwait(false);
}

public async Task<double> GetValue2()
{
    throw new InvalidOperationException("Couldn't get value!");
}

可悲的是,当 GetValueAction 被命中时,返回的堆栈跟踪是:

    " at MyProject.Controllers.ValuesController.<GetValue2>d__3.MoveNext() in c:\dev\MyProject\MyProject\Controllers\ValuesController.cs:line 61 --- End of stack trace from previous location where exception was thrown --- 
at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task) 
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) 
at System.Runtime.CompilerServices.ConfiguredTaskAwaitable`1.ConfiguredTaskAwaiter.GetResult()
at MyProject.Controllers.ValuesController.<GetValue>d__0.MoveNext() in c:\dev\MyProject\MyProject\Controllers\ValuesController.cs:line 56"

因此,我在跟踪中得到(损坏的)GetValue2 和 GetValue,但没有提到 GetValueAction。难道我做错了什么?是否有另一种模式可以让我获得更完整的堆栈跟踪?

编辑:我的目标不是编写依赖于堆栈跟踪的代码,而是使异步方法中的故障更容易调试。

4

3 回答 3

38

首先,堆栈跟踪不会像大多数人认为的那样做。它们在调试期间很有用,但不适用于运行时使用,尤其是在 ASP.NET 上。

此外,堆栈跟踪在技术上是关于代码返回的位置,而不是代码的来源。对于简单(同步)代码,两者是相同的:代码总是返回到调用它的任何方法。但是,对于异步代码,这两者是不同的。同样,堆栈跟踪会告诉您接下来会发生什么但您对过去发生的事情感兴趣。

因此,堆栈框架不是您需要的正确答案。Eric Lippert 在这里的回答中很好地解释了这一点

@ColeCampbell 链接到的MSDN 文章描述了一种使用代码跟踪“意外链”(代码来自哪里)的方法async。不幸的是,这种方法是有限的(例如,它不能处理 fork/join 场景);但是,这是我所知道的唯一在 Windows 应用商店应用程序中有效的方法。

由于您使用的是具有完整 .NET 4.5 运行时的 ASP.NET,因此您可以使用更强大的解决方案来跟踪事故链:逻辑调用上下文。但是,您的async方法确实必须“选择加入”,因此您不会像使用堆栈跟踪那样免费获得它。我刚刚在尚未发布的博客文章中写了这个,所以你可以预览一下。:)

您可以围绕逻辑调用上下文自己构建调用“堆栈”,如下所示:

public static class MyStack
{
  // (Part A) Provide strongly-typed access to the current stack
  private static readonly string slotName = Guid.NewGuid().ToString("N");
  private static ImmutableStack<string> CurrentStack
  {
    get
    {
      var ret = CallContext.LogicalGetData(name) as ImmutableStack<string>;
      return ret ?? ImmutableStack.Create<string>();
    }
    set { CallContext.LogicalSetData(name, value); }
  }

  // (Part B) Provide an API appropriate for pushing and popping the stack
  public static IDisposable Push([CallerMemberName] string context = "")
  {
    CurrentStack = CurrentStack.Push(context);
    return new PopWhenDisposed();
  }
  private static void Pop() { CurrentContext = CurrentContext.Pop(); }
  private sealed class PopWhenDisposed : IDisposable
  {
    private bool disposed;
    public void Dispose()
    {
      if (disposed) return;
      Pop();
      disposed = true;
    }
  }

  // (Part C) Provide an API to read the current stack.
  public static string CurrentStackString
  {
    get { return string.Join(" ", CurrentStack.Reverse()); }
  }
}

ImmutableStack在此处获得)。然后你可以像这样使用它:

static async Task SomeWork()
{
  using (MyStack.Push())
  {
    ...
    Console.WriteLine(MyStack.CurrentStackAsString + ": Hi!");
  }
}

这种方法的好处是它适用于所有 async代码:fork/join、自定义等待对象ConfigureAwait(false)等。缺点是您增加了一些开销。此外,这种方法仅适用于 .NET 4.5;.NET 4.0 上的逻辑调用上下文无法async识别并且无法正常工作。

更新:我发布了一个NuGet 包(在我的博客中描述),它使用 PostSharp 自动注入推送和弹出。因此,现在获得良好的跟踪应该要简单得多。

于 2013-03-14T14:51:47.913 回答
31

这个问题及其最高投票答案是在 2013 年写的。从那时起情况有所改善。

.NET Core 2.1 现在提供开箱即用的可理解的异步堆栈跟踪;请参阅.NET Core 2.1 中的 Stacktrace 改进

对于仍在使用 .NET Framework 的用户,有一个出色的 NuGet 包可以修复堆栈跟踪中的异步(以及许多其他晦涩难点):Ben.Demystifier。这个包优于其他建议的优点是它不需要更改抛出的代码或程序集;您只需调用DemystifyToStringDemystified捕获的异常。

将此应用于您的代码:

System.AggregateException: One or more errors occurred. ---> System.InvalidOperationException: Couldn't get value!
   at async Task<double> ValuesController.GetValue2()
   at async Task<double> ValuesController.GetValue()
   --- End of inner exception stack trace ---
   at void System.Threading.Tasks.Task.ThrowIfExceptional(bool includeTaskCanceledExceptions)
   at TResult System.Threading.Tasks.Task<TResult>.GetResultCore(bool waitCompletionNotification)
   at TResult System.Threading.Tasks.Task<TResult>.get_Result()
   at double ValuesController.GetValueAction()
   at void Program.Main(string[] args)
---> (Inner Exception #0) System.InvalidOperationException: Couldn't get value!
   at async Task<double> ValuesController.GetValue2()
   at async Task<double> ValuesController.GetValue()<---

诚然,由于您使用Task<T>.Result. 如果您将您的GetValueAction方法转换为 async(本着async all way的精神),您将获得预期的干净结果:

System.InvalidOperationException: Couldn't get value!
   at async Task<double> ValuesController.GetValue2()
   at async Task<double> ValuesController.GetValue()
   at async Task<double> ValuesController.GetValueAction()
于 2018-07-06T22:29:22.750 回答
5

async/await king 对此有一个很好的 nuget 扩展。

https://www.nuget.org/packages/AsyncStackTraceEx/

你需要改变你的等待电话

Await DownloadAsync(url)

Await DownloadAsync(url).Log()

最后,在 catch 块中,只需调用

ex.StackTraceEx()

一个重要的注意事项:此方法只能调用一次,并且 ex.StackTrace 之前不得评估。似乎堆栈只能读取一次。

于 2015-11-20T17:10:33.720 回答