如何为c++项目集成Sentry进行崩溃监控? (错误上报)

C++项目集成Sentry需手动初始化并注册信号处理器,因默认不捕获segfault等崩溃;必须在main开头调用sentry_init(),启用backtrace和异常捕获,并正确链接sentry-native。

为什么 C++ 项目集成 Sentry 需要额外处理崩溃捕获?

Sentry 默认不自动捕获 C++ 崩溃(如 segfaultabortdouble free),因为 C++ 运行时无统一异常传播机制,且信号(SIGSEGVSIGABRT 等)需显式注册处理器。原生 sentry-native SDK 提供了信号拦截能力,但必须手动初始化并确保在崩溃前完成设置。

  • 未调用 sentry_init() 或调用过晚 → 崩溃时无 handler 注册,上报失败
  • 多线程环境下未禁用 fork() 后的 sentry 子进程 → 可能导致重复上报或 crash in crash
  • 未启用 in-process backend(默认关闭)→ 无法捕获未处理的 C++ 异常(throw

如何正确初始化 sentry-native 并捕获信号?

使用 sentry-native 的推荐方式是静态链接 + 手动初始化,避免动态加载失败。关键步骤包括:设置 DSN、启用信号捕获、指定 release 和 environment。

#include "sentry.h"

int main(int argc, char* argv) { // 必须在任何可能崩溃的操作前调用 sentry_options_t options = sentry_options_new(); sentry_options_set_dsn(options, "https://www./link/68624a8a1f8dd04e260c0173bad7ee31"); sentry_options_set_release(options, "myapp@1.2.3"); sentry_options_set_environment(options, "production"); // 启用信号捕获(Linux/macOS)和 SEH(Windows) sentry_options_set_enable_backtrace(options, 1); // 启用 C++ 异常捕获(需链接 -lsentry) sentry_options_set_enable_crashpad(options, 0); // 不用 crashpad 时设为 0 sentry_init(options);

// 此处可触发测试崩溃,例如:
// int* p = nullptr; *p = 42;

sentry_close();
return 0;

}

  • sentry_init() 必须在 main() 开头尽早调用,不能放在类构造函数或延迟初始化逻辑中
  • Linux 下依赖 libunwindlibbacktrace 获取栈帧,编译时需确保可用(CMake 中用 find_package(unwind)
  • Windows 上需链接 sentry.dll 或静态库,并调用 SetUnhandledExceptionFilter,SDK 已封装

CMake 中如何链接 sentry-native?

官方推荐使用 FetchContent 拉取源码编译,避免 ABI 兼容问题。注意禁用不需要的后端(如 Crashpad)以减小体积和依赖。

include(FetchContent)
FetchContent_Declare(
  sentry-native
  GIT_REPOSITORY https://github.com/getsentry/sentry-native.git
  GIT_TAG        0.7.0
)
FetchContent_MakeAvailable(sentry-native)

链接目标(假设你的可执行文件叫 myapp)

target_link_libraries(myapp PRIVATE sentry::sentry)

若需 C++ 异常支持,确保定义宏

target_compile_definitions(myapp PRIVATE SENTRY_SUPPORTS_EXCEPTION_CAUGHT=1)

  • 不要用系统包管理器安装的 libsentry(如 apt 安装的老版本),版本不匹配易导致 sentry_capture_event 返回空指针
  • 若使用 crashpad 后端,需额外提供 crashpad_handler 二进制并配置路径,复杂度陡增,普通项目建议用 in-process backend
  • 调试构建中可加 sentry_op

    tions_set_debug(options, 1)
    查看 SDK 内部日志

如何手动触发错误上报并附加上下文?

除了自动崩溃,你可能想主动上报业务逻辑错误(如配置加载失败)。此时用 sentry_capture_event(),并利用 scope 添加 context、tags、user。

sentry_value_t event = sentry_value_new_event();
sentry_value_set_by_key(event, "level", sentry_value_new_string("error"));
sentry_value_set_by_key(event, "message", sentry_value_new_string("Failed to parse config"));

// 添加自定义 tag 和 extra sentry_value_t tags = sentry_value_new_object(); sentry_value_set_by_key(tags, "config_source", sentry_value_new_string("yaml")); sentry_value_set_by_key(event, "tags", tags);

sentry_value_t extra = sentry_value_new_object(); sentry_value_set_by_key(extra, "raw_content", sentry_value_new_string("...")); sentry_value_set_by_key(event, "extra", extra);

sentry_capture_event(event);

  • 不要在 signal handler 中调用 sentry_capture_event —— 它不是 async-signal-safe;SDK 内部已处理,你只需保证初始化完成
  • 敏感字段(如密码、token)绝不能写入 extracontext,Sentry 控制台默认明文显示
  • 大型对象(如完整 JSON 字符串)可能被截断,Sentry 默认限制 8KB,可通过 sentry_options_set_max_attachment_size 调整

C++ 的崩溃上下文非常脆弱:堆栈可能损坏、内存不可读、甚至 malloc 不可用。sentry-native 的 in-process backend 就是为此设计的,但它要求你严格控制初始化时机和链接方式——漏掉任何一个 sentry_init 前的崩溃,就彻底丢失现场。