使用多个模块时的 Nodejs API 初始化行为需要

Question

我在几个节点模块中使用 Sentry。我在admin.js中初始化它：

// admin.js
const Sentry = require('@sentry/node');

Sentry.init({
  dsn: functions.config().sentry.dsn,
  environment: functions.config().env.mode,
});

module.exports = { Sentry };

我知道节点是“需要一次”（第一次后缓存）并在此之后返回相同的对象，因此多个要求表现为一个要求。

我的问题与这些 require 语句的运行顺序有关，以及我是否应该在其他模块中使用下面的选项 #1 或 #2（或者是否重要）：

// utils.js
// option #1
const Sentry = require('@sentry/node');

testFn () {
  try {
    throw new Error();
  } catch (err) {
    Sentry.captureException(err);
  }
}

// utils.js
// option #2
const { Sentry } = require('./admin');

testFn () {
  try {
    throw new Error();
  } catch (err) {
    Sentry.captureException(err);
  }
}

如果我使用选项#1，当调用captureException 时，Sentry 是否有可能无法在utils.js 中正确初始化？

如果这两个选项都有效，那么就最佳实践而言，一个比另一个更受欢迎吗？

Answer 1

最好在你的应用根目录中初始化 sentry，例如，如果你使用express，你可以在主 server.js 文件中初始化，也可以使用 sentry 提供的中间件。类似：

const Sentry = require('@sentry/node');
const express = require('express');

Sentry.init({
  dsn: 'DSN',
  environment: 'ENV',
  release: DEPLOY_VERSION || 'n/a',
  ignoreErrors: [
    'Network request failed',
    'Failed to fetch',
    'NetworkError',
    'withrealtime/messaging',
  ],
});

// Create our express app using the port optionally specified
export const app = express();

// The request handler must be the first middleware on the app
app.use(Sentry.Handlers.requestHandler());

// The error handler must be before any other error middleware
app.use(Sentry.Handlers.errorHandler());

app.disable('x-powered-by');


app.get('/', (req, res) => {
  res.send('Hello World!')
})

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`)
})

如果您想在您的应用中获取自定义错误日志，您可以将Sentry 变量放入您的req 变量中。某事喜欢：

app.get('/', (req, res) => {
  req.sentry = Sentry;
  res.send('Hello World!')
});

但这不是必需的。因为哨兵实例是请求之间的共享变量，并且初始化一次，将存储在内存中并适用于所有并发请求