コンテンツにスキップ

クイックスタート

本ドキュメントは、HarmonyOS RUM SDK の最短導入経路を示し、検証可能なデータ送信を迅速に実現するためのガイドです。

事前準備

  1. リアルユーザーモニタリング(RUM) で HarmonyOS アプリケーションを作成し、RUM App ID を取得します
  2. データ送信方式を確認します:
    • ローカル環境デプロイ:datakitUrl を準備
    • パブリック DataWay:datawayUrlclientToken を準備
  3. インストール方法を選択します:
    • サードパーティリポジトリを設定済みの場合:ohpm 経由で @guancecloud/ft_sdk を直接インストール
    • ローカル HAR を使用する場合:ft_sdk.har をダウンロードし、oh-package.json5@guancecloud/ft_sdk を依存名として使用
  4. @kit.NetworkKit ベースの HTTP インターセプターチェーン機能を使用する場合は、さらに @guancecloud/ft_sdk_ext をインストールするか、ft_sdk_ext.har をダウンロードします
  5. ネイティブクラッシュを収集する場合は、さらに @guancecloud/ft_native をインストールするか、ft_native.har をダウンロードします
  6. バイトコード HAR を使用する場合、プロジェクトは HarmonyOS API Level 12 以上である必要があり、ルートディレクトリの build-profile.json5useNormalizedOHMUrl を有効にします。完全な設定と難読化の説明はバイトコード HAR ビルド設定を参照してください。

導入手順

  1. サードパーティリポジトリを使用する場合、ohpm install @guancecloud/ft_sdk を実行します
  2. ローカル HAR を使用する場合、HAR ファイルをプロジェクトの libs ディレクトリに配置し、oh-package.json5 でスコープ付き依存関係を宣言します。ft_sdk_ext.har も同時に使用する場合は、プロジェクトルートディレクトリの oh-package.json5overrides を使用して @guancecloud/ft_sdk をローカル HAR に書き換えた後、ohpm install を実行します
  3. アプリケーション起動時に FTSDKConfig を初期化します
  4. FTRUMConfig を初期化し、View、Action、Resource、ANR、Crash の収集を有効にします
  5. デバッグログを有効にし、アプリケーションを実行してページを開くかネットワークリクエストをトリガーします
  6. コンソールに戻り、RUM データが正常に送信されたことを確認します

最小依存関係方式

  • ohpm でコア SDK をインストール:
ohpm install @guancecloud/ft_sdk
  • ローカル HAR を使用する場合、oh-package.json5 に最小依存関係を追加:
{
  "dependencies": {
    "@guancecloud/ft_sdk": "file:../libs/ft_sdk.har"
  }
}

最小依存関係でまず導入し、基本データ送信が動作することを確認した後、必要に応じて拡張パッケージを追加することを推奨します。

最小初期化サンプル

import { AbilityConstant, UIAbility, Want } from '@kit.AbilityKit';

import { FTSDK, FTSDKConfig, FTRUMConfig, EnvType, SDKLogLevel } from '@guancecloud/ft_sdk/Index';


export default class EntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    // ローカル環境デプロイの場合は FTSDKConfig.builder(datakitUrl) に変更可能
    const sdkConfig = FTSDKConfig.builder(datawayUrl, clientToken)
      .setDebug(true)
      .setSdkLogLevel(SDKLogLevel.D)
      .setServiceName('Your-App-Name')
      .setEnv(EnvType.PROD);

    FTSDK.install(sdkConfig, this.context);

    const rumConfig = new FTRUMConfig()
      .setRumAppId('your-app-id')
      .setSamplingRate(1.0)
      .setEnableTraceUserAction(true)
      .setEnableTraceUserView(true)
      .setEnableTraceUserResource(true)
      .setEnableTrackAppANR(true)
      .setEnableTrackAppCrash(true);

    FTSDK.installRUMConfig(rumConfig);
  }
}

導入の確認

  1. setDebug(true) を有効にしたままにします
  2. ページを開くか、ネットワークリクエストを実行します
  3. hilog[FT-SDK] を検索し、SDK の初期化とデータ送信フローが正常であることを確認します
  4. Guance コンソールに戻り、対応する RUM データが表示されていることを確認します

次のステップ

フィードバック

このページは役に立ちましたか?