如何在使用`anyhow`时跟踪错误

Question

使用 anyhow crate 时，错误可以方便地向上冒泡到应用程序的根目录，并在那里进行处理。

但是，有时我想知道错误发生在哪里，但我找不到方法来做到这一点

anyhow

。

我的回溯仅提到了根：

   4: mp_parser::main
             at ./src/main.rs:37:5

运行

RUST_BACKTRACE=full

为我提供了详细的内部调用堆栈，但它没有显示错误在我自己的代码中源自何处。

因此，我经常对代码的不同部分取消注释，以找出错误实际发生的位置。

有什么方法可以获取它发生的原始行吗？

Answer 1

我使用以下应用程序运行了一些测试（全部处于 release 模式）：

use anyhow::{ensure, Result};

fn main() -> Result<()> {
    aa()?;
    Ok(())
}

fn aa() -> Result<()> {
    bb(33)?;
    bb(77)?;
    bb(5)?;
    Ok(())
}

fn bb(p: i32) -> Result<i32> {
    ensure!(p >= 10, "param not big enough!");
    Ok(p)
}

我测试了各种组合：

• 在 Stable (1.58) 和 Nightly (1.60) 工具链上。
• 有或没有“回溯”功能；
• 不设置

  RUST_BACKTRACE

  并设置为

  1

  或

  full

  （本次测试中

  1

  和

  full

  没有区别）。

当使用

RUST_BACKTRACE=1

或

RUST_BACKTRACE=full

运行应用程序时，我们会得到如下回溯：

Error: param not big enough!

Stack backtrace:
   0: anyhow::error::<impl anyhow::Error>::msg
   1: an::main
   2: std::sys_common::backtrace::__rust_begin_short_backtrace
   3: std::rt::lang_start::{{closure}}
   4: core::ops::function::impls::<impl core::ops::function::FnOnce<A> for &F>::call_once
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/core/src/ops/function.rs:259:13
   5: std::panicking::try::do_call
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/std/src/panicking.rs:485:40
   6: std::panicking::try
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/std/src/panicking.rs:449:19
   7: std::panic::catch_unwind
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/std/src/panic.rs:136:14
   8: std::rt::lang_start_internal::{{closure}}
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/std/src/rt.rs:128:48
   9: std::panicking::try::do_call
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/std/src/panicking.rs:485:40
  10: std::panicking::try
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/std/src/panicking.rs:449:19
  11: std::panic::catch_unwind
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/std/src/panic.rs:136:14
  12: std::rt::lang_start_internal
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/std/src/rt.rs:128:20
  13: main
  14: __libc_start_main
  15: _start

我还测试了“回溯”功能：

    anyhow = { version = "1.0.52", features = ["backtrace"] }

，但这似乎没有向堆栈跟踪添加任何有价值的信息。

我们只看到

1: an::main

的原因是，在这个简单的程序中，其他函数都是内联的。

我们可以尝试禁用特定函数的内联，如下所示：

#[inline(never)]
fn aa() -> Result<()> {...

现在我们明白了：

Stack backtrace:
   0: anyhow::error::<impl anyhow::Error>::msg
   1: an::aa
   2: std::sys_common::backtrace::__rust_begin_short_backtrace
   ...

这可能有助于将错误产生的位置缩小到单个函数，但它仍然远非完美。而且，显然，仅仅为了这个目的而禁用内联通常不是一个好主意。

看来我们可以做到这一点：

ensure!(p >= 10, "param not big enough! {}:{}", file!(), line!());

即使在发布模式下，我们也可以获得有关文件和行的信息：

Error: param not big enough! src/main.rs:18

很明显，围绕它构建一些东西是可能的，但我不熟悉这些宏到底是如何工作的以及开销是多少。如果有人能对此有更多的了解，我会很高兴。

按照罗德里戈的建议，我也尝试过这个：

---

[profile.release]
debug = true

结果看起来很棒：

Stack backtrace:
   0: anyhow::error::<impl anyhow::Error>::msg
             at /home/xyz/.cargo/registry/src/github.com-1ecc6299db9ec823/anyhow-1.0.52/src/error.rs:79:36
   1: an::bb
             at ./src/main.rs:18:5
   2: an::aa
             at ./src/main.rs:13:2
   3: an::main
             at ./src/main.rs:6:2
   4: core::ops::function::FnOnce::call_once
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/core/src/ops/function.rs:227:5
   5: std::sys_common::backtrace::__rust_begin_short_backtrace
             at /rustc/5e57faa78aa7661c6000204591558f6665f11abc/library/std/src/sys_common/backtrace.rs:123:18
   ...
   

二进制大小因此增加了 16%。

设置

debug = 1

会产生与

debug = true

相同的堆栈跟踪（顺便说一句，与

debug = 2

相同），但与默认

debug = 0

 相比，二进制大小仅大 6%

我还没有测试该设置是否/如何影响性能。

Answer 2

在这个宏中，我们将 file!()、line!() 值注入到日志消息中（使用“kv”功能），以便它准确地选择产生错误的代码位置。