Sentry如何捕获Sequelize操作失败时触发错误的SQL语句？

以下是几种可行的实现方式，可根据你的业务场景选择：

1. 全局拦截Sequelize查询，给错误附加SQL语句 #

通过重写Sequelize的query方法并监听query事件，将SQL语句绑定到后续的错误对象上：

const sequelize = new Sequelize(/* 你的数据库配置 */);

// 监听query事件，记录当前执行的SQL
sequelize.on('query', (sql, options) => {
  options._attachedSql = sql;
});

// 重写query方法，捕获错误时附加SQL
const originalQuery = sequelize.query;
sequelize.query = function(sql, options) {
  return originalQuery.call(this, sql, options).catch(err => {
    if (options?._attachedSql) {
      err.query = options._attachedSql;
    }
    throw err;
  });
};

之后在Sentry的错误捕获逻辑中，直接读取err.query添加到上下文：

// 在全局错误捕获或Sentry中间件中
Sentry.configureScope(scope => {
  scope.setExtra('执行的SQL语句', err.query || '无法获取SQL');
});

这种方式可以覆盖所有基于query方法的CRUD操作（包括模型的findOne、create等封装方法）。

2. 自定义日志器关联查询与错误 #

通过自定义Sequelize的日志函数，给每个查询分配唯一ID，错误发生时通过ID匹配对应的SQL：

const queryCache = new Map();
let querySeq = 0;

const sequelize = new Sequelize({
  // 其他配置
  logging: (sql, options) => {
    const currentId = ++querySeq;
    queryCache.set(currentId, sql);
    options._queryId = currentId;
    // 保留原日志输出（可选）
    console.log(sql);
  }
});

// 查询完成后清理缓存，避免内存泄漏
sequelize.addHook('afterQuery', (options) => {
  if (options._queryId) {
    queryCache.delete(options._queryId);
  }
});

// 在全局错误捕获中关联SQL
process.on('unhandledRejection', (err) => {
  const targetId = err?.parent?._queryId;
  if (targetId) {
    err.query = queryCache.get(targetId);
    queryCache.delete(targetId);
  }
  Sentry.captureException(err);
});

3. 关键路径手动附加SQL（适合局部场景） #

如果全局拦截成本高，可针对业务中的关键查询，手动构建SQL并附加到Sentry上下文：

try {
  const user = await User.findOne({ where: { id: userId } });
} catch (err) {
  // 从查询构建器中获取SQL语句
  const sql = User.findOne({ where: { id: userId } }).toString();
  Sentry.withScope(scope => {
    scope.setExtra('SQL语句', sql);
    Sentry.captureException(err);
  });
  throw err;
}

注意事项 #

• 不同Sequelize版本的事件、钩子API可能有差异，请对应查看你使用版本的官方文档
• 若使用参数化查询，sql可能是带占位符的语句，如需完整带参数的SQL，可结合options.bind拼接（仅用于排查，注意避免SQL注入风险）
• 使用缓存存储查询时，务必在查询完成后清理缓存，防止内存泄漏

内容的提问来源于stack exchange，提问作者thom_nic