跳到主要内容
跳到主要内容

React Native

The ClickStack React Native SDK 允许您对您的 React Native 应用进行插桩,以发送事件到 ClickStack。这使您能够在单一的时间线上查看移动网络请求和异常,以及后端事件。

本指南集成了:

  • XHR/Fetch 请求

开始

通过 NPM 安装

使用以下命令安装 ClickStack React Native 包

npm install @hyperdx/otel-react-native

初始化 ClickStack

尽早在您的应用生命周期中初始化库:

import { HyperDXRum } from '@hyperdx/otel-react-native';

HyperDXRum.init({
  service: 'my-rn-app',
  apiKey: '<YOUR_INGESTION_API_KEY>',
  tracePropagationTargets: [/api.myapp.domain/i], // Set to link traces from frontend to backend requests
});

附加用户信息或元数据(可选)

附加用户信息将允许您在 HyperDX 中搜索/过滤会话和事件。这可以在客户端会话的任何时候调用。当前客户端会话及所有在调用后发送的事件将与用户信息相关联。

userEmailuserNameteamName 将填充会话 UI,显示相应的值,但可以省略。可以指定其他附加值,并用于搜索事件。

HyperDXRum.setGlobalAttributes({
  userId: user.id,
  userEmail: user.email,
  userName: user.name,
  teamName: user.team.name,
  // Other custom properties...
});

插桩较低版本

要对运行在低于 0.68 版本的 React Native 应用进行插桩,请编辑您的 metro.config.js 文件,以强制 metro 使用特定于浏览器的包。例如:

const defaultResolver = require('metro-resolver');

module.exports = {
  resolver: {
    resolveRequest: (context, realModuleName, platform, moduleName) => {
      const resolved = defaultResolver.resolve(
        {
          ...context,
          resolveRequest: null,
        },
        moduleName,
        platform,
      );

      if (
        resolved.type === 'sourceFile' &&
        resolved.filePath.includes('@opentelemetry')
      ) {
        resolved.filePath = resolved.filePath.replace(
          'platform\\node',
          'platform\\browser',
        );
        return resolved;
      }

      return resolved;
    },
  },
  transformer: {
    getTransformOptions: async () => ({
      transform: {
        experimentalImportSupport: false,
        inlineRequires: true,
      },
    }),
  },
};

视图导航

支持 react-navigation 版本 5 和 6。

以下示例展示了如何对导航进行插桩:

import { startNavigationTracking } from '@hyperdx/otel-react-native';

export default function App() {
  const navigationRef = useNavigationContainerRef();
  return (
    <NavigationContainer
      ref={navigationRef}
      onReady={() => {
        startNavigationTracking(navigationRef);
      }}
    >
      <Stack.Navigator>...</Stack.Navigator>
    </NavigationContainer>
  );
}