使用 Sentry

{
  "expo": {
    "plugins": [
      [
        "@sentry/react-native/expo",
        {
          "organization": "sentry org slug, or use the `SENTRY_ORG` environment variable",
          "project": "sentry project name, or use the `SENTRY_PROJECT` environment variable",
          // If you are using a self-hosted instance, update the value of the url property
          // to point towards your self-hosted instance. For example, https://self-hosted.example.com/.
          "url": "https://sentry.io/"
        }
      ]
    ]
  }
}

// This replaces `const { getDefaultConfig } = require('expo/metro-config');`
const { getSentryExpoConfig } = require('@sentry/react-native/metro');

// This replaces `const config = getDefaultConfig(__dirname);`
const config = getSentryExpoConfig(__dirname);

module.exports = config;

import * as Sentry from '@sentry/react-native';

Sentry.init({
  dsn: 'YOUR DSN HERE',
  debug: true, // If `true`, Sentry will try to print out useful debugging information if something goes wrong with sending the event. Set it to `false` in production
});

import * as Sentry from '@sentry/react-native';

// Your App component here

export default Sentry.wrap(App);

import { Button } from 'react-native';

// Inside some component
<Button title="Press me" onPress={() => { throw new Error('Hello, again, Sentry!'); }}/>

与 Expo 路由一起使用

¥Usage with Expo Router

如果你的应用使用 Expo 路由，那么你可以将 Sentry 配置为自动捕获当前路由并将其与错误报告一起传递。要进行此设置，请在 根布局路由 中配置 Sentry 并添加路由工具。

¥If your app uses Expo Router, then you can configure Sentry to automatically capture the current route and pass it along with your error reports. To set this up, configure Sentry in the Root Layout route and add routing instrumentation.

import { Slot, useNavigationContainerRef } from 'expo-router';
import React from 'react';
import * as Sentry from '@sentry/react-native';
import { isRunningInExpoGo } from 'expo';

// Construct a new instrumentation instance. This is needed to communicate between the integration and React
const routingInstrumentation = new Sentry.ReactNavigationInstrumentation();

Sentry.init({
  dsn: 'YOUR DSN HERE',
  debug: true, // If `true`, Sentry will try to print out useful debugging information if something goes wrong with sending the event. Set it to `false` in production
  integrations: [
    new Sentry.ReactNativeTracing({
      // Pass instrumentation to be used as `routingInstrumentation`
      routingInstrumentation,
      enableNativeFramesTracking: !isRunningInExpoGo(),
      // ...
    }),
  ],
});

function RootLayout() {
  // Capture the NavigationContainer ref and register it with the instrumentation.
  const ref = useNavigationContainerRef();

  React.useEffect(() => {
    if (ref) {
      routingInstrumentation.registerNavigationContainer(ref);
    }
  }, [ref]);

  return <Slot />;
}

// Wrap the Root Layout route component with `Sentry.wrap` to capture gesture info and profiling data.
export default Sentry.wrap(RootLayout);

与 EAS 构建一起使用

¥Usage with EAS Build

确保在你的构建环境中设置了 SENTRY_AUTH_TOKEN，Sentry 会自动为你上传源映射。如果你在应用配置中使用环境变量而不是属性，请确保也设置了这些变量。

¥Ensure that SENTRY_AUTH_TOKEN is set in your build environment, and Sentry will automatically upload source maps for you. If you use environment variables rather than properties in your app config, ensure that those are set as well.

使用上述说明，在使用 EAS Build 时无需进行任何额外工作即可将 Sentry 集成到你的项目中。

¥Using the above instructions, no additional work is needed to integrate Sentry into your project when using EAS Build.

与 EAS 更新一起使用

¥Usage with EAS Update

运行 eas update 后，将源映射上传到 Sentry：

¥After running eas update, upload the source maps to Sentry:

就是这样！现在，你的更新错误将在 Sentry 中正确地用符号表示。

¥That's it! Errors for your updates will now be properly symbolicated in Sentry.

Do you want to append additional update-related metadata to error reports?

配置 Sentry 以使用有关更新的信息标记你的范围，使你可以在 Sentry 仪表板中查看某些更新发生的错误。

¥Configuring Sentry to tag your scope with information about your update allows you to see errors happening on certain updates in the Sentry dashboard.

在应用的生命周期中尽早在全局范围中添加以下代码片段。

¥Add the following snippet in the global scope as early as possible in your application's lifecycle.

import * as Sentry from '@sentry/react-native';
import * as Updates from 'expo-updates';

const manifest = Updates.manifest;
const metadata = 'metadata' in manifest ? manifest.metadata : undefined;
const extra = 'extra' in manifest ? manifest.extra : undefined;
const updateGroup = metadata && 'updateGroup' in metadata ? metadata.updateGroup : undefined;

Sentry.init({
  // dsn, release, dist, etc...
});

Sentry.configureScope(scope => {
  scope.setTag('expo-update-id', Updates.updateId);
  scope.setTag('expo-is-embedded-update', Updates.isEmbeddedLaunch);

  if (typeof updateGroup === 'string') {
    scope.setTag('expo-update-group-id', updateGroup);

    const owner = extra?.expoClient?.owner ?? '[account]';
    const slug = extra?.expoClient?.slug ?? '[project]';
    scope.setTag(
      'expo-update-debug-url',
      `https://expo.dev/accounts/${owner}/projects/${slug}/updates/${updateGroup}`
    );
  } else if (Updates.isEmbeddedLaunch) {
    // This will be `true` if the update is the one embedded in the build, and not one downloaded from the updates server.
    scope.setTag('expo-update-debug-url', 'not applicable for embedded updates');
  }
});

配置完成后，有关关联更新的信息将显示在错误的标签部分中：

¥Once configured, information about the associated update will show up in an error's tag section:

sentry-expo 已合并到 @sentry/react-native 中，现已弃用。我们建议升级到 SDK 50 以使用 @sentry/react-native 以获得最佳体验。如果你已经在使用 sentry-expo、了解如何迁移。

¥sentry-expo has been merged into @sentry/react-native and is now deprecated. We recommend upgrading to SDK 50 to use @sentry/react-native for the best experience. If you're already using sentry-expo, learn how to migrate.

import * as Sentry from 'sentry-expo';

Sentry.init({
  dsn: 'YOUR DSN HERE',
  enableInExpoDevelopment: true,
  debug: true, // If `true`, Sentry will try to print out useful debugging information if something goes wrong with sending the event. Set it to `false` in production
});

// Access any @sentry/react-native exports via:
// Sentry.Native.*

// Access any @sentry/browser exports via:
// Sentry.Browser.*

// The following example uses `captureException()` from Sentry.Native.* to capture errors:
try {
  // your code
} catch (error) {
  Sentry.Native.captureException(error);
}

import * as Sentry from '@sentry/react-native';

Sentry.init({
  dsn: 'YOUR DSN',
});

{
  "expo": {
    %%placeholder-start%%...%%placeholder-end%%
    "hooks": {
      "postPublish": [
        {
          "file": "sentry-expo/upload-sourcemaps",
          "config": {
            "organization": "sentry org slug, or use the `SENTRY_ORG` environment variable",
            "project": "sentry project name, or use the `SENTRY_PROJECT` environment variable"
          }
        }
      ]
    }
  }
}

{
  "expo": {
    "plugins": ["sentry-expo"]
    %%placeholder-start%%... %%placeholder-end%%
  }
}

源地图

¥Source maps

postPublish 钩子到位后，现在你所需要做的就是运行 expo-cli publish，源映射将自动上传。每次你点击发布时，我们都会根据你在 app.json 中指定的版本和我们后端的发布 ID，自动为 Sentry 分配一个唯一的发布版本 - 这意味着，如果你忘记更新版本但点击发布，你将 仍然可以获得独特的 Sentry 版本。

¥With the postPublish hook in place, now all you need to do is run expo-cli publish and the source maps will be uploaded automatically. We automatically assign a unique release version for Sentry each time you hit publish, based on the version you specify in app.json and a release id on our backend -- this means that if you forget to update the version but hit publish, you will still get a unique Sentry release.

在构建时上传源映射

¥Uploading source maps at build time

使用 expo-updates，Android 和 iOS 应用的发布版本都将在构建时从 JavaScript 源创建并嵌入新的更新。此新更新不会自动发布，并且仅存在于与其打包在一起的二进制文件中。由于它尚未发布，因此源映射不会像运行 expo-cli publish 时那样以通常的方式上传（实际上，我们依靠 Sentry 的原生脚本来处理该问题）。因此，你需要注意一些额外的事情：

¥With expo-updates, release builds of both Android and iOS apps will create and embed a new update from your JavaScript source at build-time. This new update will not be published automatically and will exist only in the binary with which it was bundled. Since it isn't published, the source maps aren't uploaded in the usual way like they are when you run expo-cli publish (actually, we are relying on Sentry's native scripts to handle that). Because of this you have some extra things to be aware of:

• 你的 release 将自动设置为 Sentry 的预期值 - ${bundleIdentifier}@${version}+${buildNumber} (iOS) 或 ${androidPackage}@${version}+${versionCode} (Android)。

  ¥Your release will automatically be set to Sentry's expected value- ${bundleIdentifier}@${version}+${buildNumber} (iOS) or ${androidPackage}@${version}+${versionCode} (Android).

• 你的 dist 将自动设置为 Sentry 的预期值：${buildNumber} (iOS) 或 ${versionCode} (Android)。

  ¥Your dist will automatically be set to Sentry's expected value: ${buildNumber} (iOS) or ${versionCode} (Android).

• 构建时源映射的配置来自 android/sentry.properties 和 ios/sentry.properties 文件。欲了解更多信息，请参阅 Sentry 的文档。仅裸项目 Sentry-expo 配置插件会以其他方式处理它 需要手动配置。

  ¥The configuration for build time source maps comes from the android/sentry.properties and ios/sentry.properties files. For more information, see Sentry's documentation. Manual configuration is only required for bare projects, the sentry-expo config plugin handles it otherwise.

• 无论是否使用裸工作流程，项目的 expo publish 和 npx expo export 的配置都是通过 app.json 完成的。

  ¥Configuration for expo publish and npx expo export for projects is done via app.json, whether using bare workflow or not.

跳过或错误配置其中任何一个都可能导致无效的源映射，并且你不会在错误中看到人类可读的堆栈跟踪。

¥Skipping or misconfiguring either of these can lead to invalid source maps, and you won't see human-readable stacktraces in your errors.

上传源地图以进行更新

¥Uploading source maps for updates

如果你使用 EAS 更新，或者如果你自行托管更新（这意味着你手动运行 npx expo export），则需要执行以下步骤将更新的源映射上传到 Sentry：

¥If you're using EAS Update, or if you're self-hosting your updates (this means you run npx expo export manually), you need to take the following steps to upload the source maps for your update to Sentry:

• 运行 eas update。这将在项目根目录中生成一个 dist 文件夹，其中包含 JavaScript 包和源映射。该命令还将输出我们下一步需要的 '安卓更新 ID' 和 'iOS 更新 ID'。

  ¥Run eas update. This will generate a dist folder in your project root, which contains your JavaScript bundles and source maps. This command will also output the 'Android update ID' and 'iOS update ID' that we'll need in the next step.

• 复制或重命名 dist/bundles 文件夹中的包名称以匹配 index.android.bundle (Android) 或 main.jsbundle (iOS)。

  ¥Copy or rename the bundle names in the dist/bundles folder to match index.android.bundle (Android) or main.jsbundle (iOS).

• 接下来，你可以使用 Sentry CLI 上传包和源映射：

  ¥Next, you can use the Sentry CLI to upload your bundles and source maps:

  • release name 应设置为 ${bundleIdentifier}@${version}+${buildNumber} (iOS) 或 ${androidPackage}@${version}+${versionCode} (Android)，例如 com.domain.myapp@1.0.0+1。

    ¥release name should be set to ${bundleIdentifier}@${version}+${buildNumber} (iOS) or ${androidPackage}@${version}+${versionCode} (Android), so for example com.domain.myapp@1.0.0+1.

  • dist 应设置为 eas update 生成的更新 ID。

    ¥dist should be set to the Update ID that eas update generated.

有关详细信息，请参阅 Sentry 的 上传包和源映射的说明。

¥For more information, see Sentry's instructions for uploading the bundle and source maps.

上述步骤在 Sentry 上定义了一个新的 'dist'，与你的完整应用构建处于同一版本下，并将源映射与这个新的 dist 相关联。如果要自定义此行为，可以在代码中初始化 Sentry 时传入自己的 release 和 dist 值。例如：

¥The steps above define a new 'dist' on Sentry, under the same release as your full app build, and associate the source maps with this new dist. If you want to customize this behavior, you can pass in your own values for release and dist when you initialize Sentry in your code. For example:

import * as Sentry from 'sentry-expo';
import * as Updates from 'expo-updates';

Sentry.init({
  dsn: 'YOUR DSN',
  release: 'my release name',
  dist: 'my dist',
});

这些值应与你上传源映射时传递给 sentry-cli 的值匹配。

¥These values should match the values you pass to the sentry-cli when uploading your source maps.

测试 Sentry

¥Testing Sentry

在为应用构建测试时，你希望断言正确的流量跟踪或错误正在发送到 Sentry，但没有真正将其发送到 Sentry 服务器。这样，你就不会在测试运行和其他 CI 操作期间用虚假报告淹没 Sentry。

¥When building tests for your application, you want to assert that the right flow-tracking or error is being sent to Sentry, but without really sending it to Sentry servers. This way you won't swamp Sentry with false reports during test running and other CI operations.

sentry-testkit 使 Sentry 能够在你的应用中原生工作，并且通过覆盖默认的 Sentry 传输机制，报告不会真正发送，而是本地记录到内存中。通过这种方式，你可以稍后获取记录的报告以供你自己使用、验证或你在本地开发/测试环境中可能拥有的任何其他用途。

¥sentry-testkit enables Sentry to work natively in your application, and by overriding the default Sentry transport mechanism, the report is not really sent but rather logged locally into memory. In this way, the logged reports can be fetched later for your own usage, verification, or any other use you may have in your local developing/testing environment.

有关如何开始的更多信息，请参阅 sentry-testkit 文档。

¥For more information on how to get started, see sentry-testkit documentation.

如果你使用的是 jest，请确保将 @sentry/.* 和 sentry-expo 添加到 transformIgnorePatterns 中。

¥If you're using jest, make sure to add @sentry/.* and sentry-expo to your transformIgnorePatterns.

错误报告语义

¥Error reporting semantics

为了确保可靠地报告错误，Sentry 推迟将数据报告给后端，直到你下次在发生致命错误后加载应用时，而不是在捕获异常时尝试报告数据。它将堆栈跟踪和其他元数据保存到 AsyncStorage 并在应用启动时立即发送。

¥To ensure that errors are reported reliably, Sentry defers reporting the data to their backend until the next time you load the app after a fatal error rather than trying to report it upon catching the exception. It saves the stacktrace and other metadata to AsyncStorage and sends it immediately when the app starts.

开发中默认禁用

¥Disabled by default in dev

除非设置了 enableInExpoDevelopment: true，否则所有开发/本地错误都将被忽略，只有应用版本才会向 Sentry 报告错误。你可以调用诸如 Sentry.Native.captureException(new Error('Oops!')) 之类的方法，但这些方法将是无操作的。

¥Unless enableInExpoDevelopment: true is set, all your dev/local errors will be ignored and only app releases will report errors to Sentry. You can call methods like Sentry.Native.captureException(new Error('Oops!')) but these methods will be no-op.

故障排除

¥Troubleshooting

import * as Sentry from 'sentry-expo';
import Constants from 'expo-constants';

Sentry.init({
  tracesSampleRate: 1.0,
  integrations: [
    new Sentry.Native.ReactNativeTracing({
      shouldCreateSpanForRequest: url => {
        return !__DEV__ || !url.startsWith(`http://${Constants.expoConfig.hostUri}/logs`);
      },
    }),
  ],
});