クイックスタート¶
このドキュメントでは、HarmonyOS RUM SDK の最短導入経路を説明し、検証可能なデータ送信をすばやく完了するための手順を紹介します。
事前準備¶
- リアルユーザーモニタリング（RUM）で HarmonyOS アプリを作成し、
RUM App IDを取得します - データ送信方法を確認します：
- ローカル環境へのデプロイ：
datakitUrlを準備します - パブリックネットワーク DataWay：
datawayUrlとclientTokenを準備します
- ローカル環境へのデプロイ：
- インストール方法を選択します：
- サードパーティリポジトリを設定済み：
ohpmから直接@guancecloud/ft_sdkをインストールします - ローカル HAR を使用：
ft_sdk.harをダウンロードし、oh-package.json5で@guancecloud/ft_sdkを依存名として指定します
- サードパーティリポジトリを設定済み：
@kit.NetworkKitベースの HTTP インターセプターチェーン機能を使用する場合は、追加で@guancecloud/ft_sdk_extをインストールするか、ft_sdk_ext.harをダウンロードします。この機能には HarmonyOS API 22 以上が必要です。- Native Crash を収集する場合は、さらに追加で
@guancecloud/ft_nativeをインストールするか、ft_native.harをダウンロードします - バイトコード HAR を使用する場合、プロジェクトは HarmonyOS API 12 以上を使用し、ルートディレクトリの
build-profile.json5でuseNormalizedOHMUrlを有効にする必要があります。完全な設定と難読化の説明は、バイトコード HAR ビルド設定 を参照してください。
導入手順¶
- サードパーティリポジトリを使用する場合は、
ohpm install @guancecloud/ft_sdkを実行します - ローカル HAR を使用する場合は、HAR ファイルをプロジェクトの
libsディレクトリに配置し、oh-package.json5で scoped 依存関係を宣言します。ft_sdk_ext.harも併用する場合は、プロジェクトルートのoh-package.json5でoverridesを使って@guancecloud/ft_sdkをローカル HAR に書き換えてからohpm installを実行します - アプリ起動時に
FTSDKConfigを初期化します FTRUMConfigを初期化し、View、Action、Resource、ANR、Crash の収集を有効にします- デバッグログを有効にし、アプリを実行してページ表示またはネットワークリクエストを 1 回トリガーします
- コンソールに戻り、RUM データが正常に送信されたことを確認します
最小限の依存関係¶
- ohpm でコア SDK をインストールします：
- ローカル HAR を使用する場合は、
oh-package.json5に最小限の依存関係を追加します：
最小限の依存関係での導入を推奨します。基本的なデータ送信を確認できたら、必要に応じて拡張パッケージを追加してください。
最小初期化サンプル¶
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);
}
}
導入の成功を確認する¶
setDebug(true)を有効にしたままにします- ページを開くか、ネットワークリクエストを 1 回送信します
hilogで[FT-SDK]を検索し、SDK の初期化とデータ送信フローが正常であることを確認します- Guance コンソールに戻り、対応する RUM データが表示されていることを確認します