HarmonyOS アプリのデータ収集
アプリのデータを Guance に収集すると、Guance コンソールでカスタムシナリオの設定や異常検知イベントの設定ができます。
データタイプ
Guance のリアルユーザーモニタリング(RUM)には 6 種類のデータタイプがあります。そのうち HarmonyOS SDK は view、resource、error、long_task、action の 5 種類のデータをネイティブに直接送信し、session はセッション単位で集約されたデータです。
| タイプ |
説明 |
| session |
ユーザーセッション情報の記録。現在のセッションでは、セッション単位でユーザーのページ、リソース、操作、エラー、ロングタスクに関するアクセスデータを記録します。 |
| view |
ユーザーがモバイルアプリのページにアクセスするたびに、ビュー記録が生成されます。ユーザーが同じページに留まっている間、リソース、ロングタスク、エラー、操作の記録は view_id 属性によって関連する RUM ビューにリンクされます。 |
| resource |
ユーザーがページにアクセスした際に読み込まれるリソース情報の記録。 |
| error |
モバイルアプリで発生した例外またはクラッシュ。 |
| long_task |
アプリ内でメインスレッドを指定の継続時間しきい値以上ブロックしたタスクについて、ロングタスクイベントが生成されます。 |
| action |
モバイルアプリ内のユーザーアクティビティ(アプリの起動、タップ、スワイプ、戻るなど)を記録します。各アクションには一意の action_id が付与されます。 |
グローバル属性
RUM のシナリオ構築とイベントアラートは、以下のグローバル属性でクエリできます。
SDK 属性
| フィールド |
タイプ |
説明 |
sdk_name |
string |
コレクター名。固定名:df_harmonyos_rum_sdk |
sdk_version |
string |
コレクターのバージョン情報 |
sdk_pkg_info |
string |
コレクターのバージョン情報の集合。SDK 内部モジュールのバージョン情報を含みます。 |
アプリ属性
| フィールド |
タイプ |
説明 |
app_id |
string |
必須。RUM アプリケーションの一意な ID 識別子。Guance コンソールでモニターを作成する際に自動生成されます。 |
env |
string |
必須。環境フィールド。値:prod/gray/pre/common/local。内訳: prod:本番環境 gray:グレー環境 pre:プレリリース環境 common:日常環境 local:ローカル環境 |
version |
string |
必須。バージョン番号。 |
service |
string |
任意。所属する業務またはサービスの名称。固定名:df_rum_harmonyos |
application_uuid |
string |
アプリの一意な識別子。同じ Build のアプリは同じ UUID になります。 |
ユーザー & セッション属性
| フィールド |
タイプ |
説明 |
userid |
string |
未ログインユーザーはランダムな UUID を userid として使用し、ログインユーザーはアプリバックエンドで生成されたユーザー ID を使用します。 |
user_name |
string |
任意。ユーザー名。 |
user_email |
string |
任意。ユーザーメールアドレス。 |
session_id |
string |
セッション ID。ユーザー操作が 15 分以上ない場合、またはセッションが 4 時間以上継続した場合に更新されます。 |
session_type |
string |
セッションタイプ。参考値:user & synthetics user:RUM 機能によって生成されたデータ synthetics:ヘッドレス Synthetic テストによって生成されたデータ。 |
is_signin |
boolean |
登録ユーザーかどうか。値:T & F。 |
デバイス & 解像度属性
| フィールド |
タイプ |
説明 |
device |
string |
モバイルデバイスのメーカー |
model |
string |
モバイルデバイスのモデル |
device_uuid |
string |
モバイルデバイスの一意な ID |
os |
string |
OS 情報。HarmonyOS 固定です。 |
os_version |
string |
OS バージョン |
os_version_major |
string |
OS メジャーバージョン |
screen_size |
string |
画面解像度 |
arch |
string |
システムアーキテクチャ(例:aarch64) |
地理 & ネットワーク属性
| フィールド |
タイプ |
説明 |
network_type |
string |
ネットワーク接続タイプ。値の参考: wifi & 2g & 3g & 4g & 5g & unknown(不明なネットワーク)& unreachable(ネットワーク利用不可) |
カスタム属性
グローバル属性以外に、カスタム属性(SDK はユーザーによるカスタムタグデータの付与をサポートします)を使ってシナリオを構築し、イベントアラートを設定することもできます。カスタム属性は非グローバル属性であり、カスタム属性を通じてユーザーのアプリ訪問の全過程を追跡し、ユーザーが影響を受けたアクセス状況を特定・発見し、ユーザーアクセスのパフォーマンスを監視できます。
その他のデータタイプ属性
Session
Session 関連のデータはサーバー側でセッション単位に集約されたデータであり、HarmonyOS SDK がネイティブに直接送信する measurement ではありません。
属性
| フィールド |
タイプ |
説明 |
session_id |
string |
セッション ID |
session_type |
string |
セッションタイプ。参考値:user & synthetics user:RUM 機能によって生成されたデータ synthetics:ヘッドレス Synthetic テストによって生成されたデータ。 |
has_replay |
boolean |
現在のセッションが Session Replay データに関連付けられているかどうか |
View
属性
| フィールド |
タイプ |
説明 |
view_id |
string |
ページにアクセスするたびに生成される一意な ID |
view_referrer |
string |
ページの参照元、ページの親 |
view_name |
string |
ページ名 |
メトリクス
| フィールド |
タイプ |
説明 |
loading_time |
number(ns) |
ページ読み込み時間 |
time_spent |
number(ns) |
ページ滞在時間 |
is_active |
boolean |
ユーザーがまだアクティブ状態かどうか。参考値: true & false |
session_has_replay |
boolean |
現在のページが Session Replay データに関連付けられているかどうか |
統計メトリクス
| フィールド |
タイプ |
説明 |
view_error_count |
number |
ページ読み込みごとに発生したエラー数 |
view_resource_count |
number |
ページ読み込みごとにリクエストされたリソース数 |
view_long_task_count |
number |
ページ読み込みごとに発生したロングタスク数 |
view_long_task_rate |
number |
ページライフサイクル内のロングタスクの所要時間比率。範囲 [0,1] |
view_action_count |
number |
ページ閲覧中に行われた操作回数 |
モニタリングメトリクス
| フィールド |
タイプ |
説明 |
cpu_tick_count |
number |
任意。このページの CPU ティック数 |
cpu_tick_count_per_second |
number |
任意。1 秒あたりの平均 CPU ティック数 |
fps_avg |
number |
任意。ページの 1 秒あたりの平均フレーム数 |
fps_mini |
number |
任意。ページの 1 秒あたりの最小フレーム数 |
memory_avg |
number |
任意。ページのメモリ使用量の平均値 |
memory_max |
number |
任意。ページのメモリピーク値 |
battery_current_avg |
number |
任意。ページのバッテリー電流平均値 |
battery_current_max |
number |
任意。ページのバッテリー電流最大値 |
Resource
View 属性
| フィールド |
タイプ |
説明 |
view_id |
string |
ページにアクセスするたびに生成される一意な ID |
view_referrer |
string |
ページの参照元、ページの親 |
view_name |
string |
ページ名 |
Action 属性
| フィールド |
タイプ |
説明 |
action_id |
string |
ユーザーがページを操作したときに生成される一意な ID |
action_name |
string |
操作名 |
action_type |
string |
操作タイプ(コールド/ウォームスタート、click クリックなどの操作) |
Resource 属性
| フィールド |
タイプ |
説明 |
resource_id |
string |
Resource の安定した一意 ID |
resource_url |
string |
リソース URL |
resource_url_host |
string |
リソース URL のドメイン部分 |
resource_url_path |
string |
リソース URL の path 部分 |
resource_url_path_group |
string |
リソース URL の path グループ |
resource_type |
string |
リソースのカテゴリ |
resource_method |
string |
リソースのリクエストメソッド |
resource_status |
string |
リソースリクエストが返したステータス値 |
resource_status_group |
string |
リソースリクエストが返したステータスグループ値 |
resource_host_ip |
string |
リソース URL のアクセス先 IP |
trace_id |
string |
分散型トレーシング ID(分散型トレーシング有効時、任意) |
span_id |
string |
分散型トレーシング Span ID(分散型トレーシング有効時、任意) |
response_connection |
string |
応答接続タイプ(任意) |
response_content_type |
string |
応答コンテンツタイプ(任意) |
response_content_encoding |
string |
応答コンテンツエンコーディング(任意) |
resource_http_protocol |
string |
リソースリクエストで使用された HTTP プロトコル(任意) |
resource_connection_reuse |
boolean |
リソースリクエストで接続が再利用されたかどうか(任意) |
session_has_replay |
boolean |
現在のリソースが Session Replay データに関連付けられているかどうか |
メトリクス
| フィールド |
タイプ |
説明 |
resource_size |
number |
リソースサイズ。デフォルト単位:byte |
resource_dns |
number(ns) |
リソース読み込み時の DNS 解決時間 計算方法:nameLookupTimeMs * 1000000 |
resource_tcp |
number(ns) |
リソース読み込み時の TCP 接続時間 計算方法:((tlsHandshakeTimeMs ?? connectTimeMs) - nameLookupTimeMs) * 1000000 |
resource_ssl |
number(ns) |
リソース読み込み時の SSL 接続時間 計算方法:(tlsHandshakeTimeMs - connectTimeMs) * 1000000 |
resource_ttfb |
number(ns) |
リソース読み込み時のリクエスト応答時間 計算方法:(startTransferTimeMs - preTransferTimeMs) * 1000000 |
resource_trans |
number(ns) |
リソース読み込み時のコンテンツ転送時間 計算方法:(totalTimeMs - tlsHandshakeTimeMs) * 1000000 |
resource_first_byte |
number(ns) |
リソース読み込み時のファーストバイト時間 計算方法:(startTransferTimeMs - preTransferTimeMs) * 1000000 |
duration |
number(ns) |
リソース読み込み時間 計算方法:totalTimeMs * 1000000 |
resource_request_size |
number |
リソースリクエストサイズ。デフォルト単位:byte |
resource_dns_time |
object |
リソースの DNS 解決時間。形式:{duration: number(ns), start: number(ns)} |
resource_connect_time |
object |
リソースの接続所要時間。形式は resource_dns_time と同じ |
resource_first_byte_time |
object |
リソース読み込み時のファーストバイト時間。形式は resource_dns_time と同じ |
resource_ssl_time |
object |
リソースの SSL 接続所要時間。形式は resource_dns_time と同じ |
resource_download_time |
object |
リソースのダウンロード所要時間。形式は resource_dns_time と同じ |
request_header |
string |
リソースリクエストヘッダー |
response_header |
string |
リソースレスポンスヘッダー |
ネットワークスナップショットメトリクス
| フィールド |
タイプ |
説明 |
network_available |
boolean |
リソースリクエスト開始時にネットワークが利用可能だったかどうか |
network_validated |
boolean |
リソースリクエスト開始時にネットワークがシステムによって検証済みだったかどうか |
network_downlink_kbps |
number |
リソースリクエスト開始時のネットワーク下り帯域。単位:kbps |
network_uplink_kbps |
number |
リソースリクエスト開始時のネットワーク上り帯域。単位:kbps |
network_signal_strength |
number |
リソースリクエスト開始時のネットワーク信号強度。値の基準はネットワークタイプによって異なります |
Error
View 属性
| フィールド |
タイプ |
説明 |
view_id |
string |
ページにアクセスするたびに生成される一意な ID |
view_referrer |
string |
ページの参照元、ページの親 |
view_name |
string |
ページ名 |
Action 属性
| フィールド |
タイプ |
説明 |
action_id |
string |
ユーザーがページを操作したときに生成される一意な ID |
action_name |
string |
操作名 |
action_type |
string |
操作タイプ(コールド/ウォームスタート、click クリックなどの操作) |
Error 属性
| フィールド |
タイプ |
説明 |
error_source |
string |
エラー発生元。参考値:logger | network |
error_type |
string |
エラータイプ。例:js_crash、native_crash、anr_error、anr_crash、network_error、custom |
error_situation |
string |
エラー発生時のアプリ状態。ネイティブ送信時の参考値:run、background、unknown |
session_has_replay |
boolean |
現在のエラーが Session Replay データに関連付けられているかどうか |
type=network の場合、以下の Network Error 属性が追加されます。
| フィールド |
タイプ |
説明 |
resource_id |
string |
対応する Resource の安定した一意 ID |
resource_status |
string |
リソースリクエストが返したステータス値 |
resource_url |
string |
リソース URL |
resource_url_host |
string |
リソース URL のドメイン部分 |
resource_url_path |
string |
リソース URL の path 部分 |
resource_url_path_group |
string |
リソース URL の path グループ |
resource_method |
string |
リソースのリクエストメソッド |
Error モニタリング属性
| フィールド |
タイプ |
説明 |
memory_total |
string |
任意。デバイスの総メモリ量 |
memory_use |
number |
任意。現在のアプリのメモリ使用率 |
cpu_use |
number |
任意。現在のアプリの CPU 使用率 |
battery_use |
number |
任意。デバイスのバッテリー消費率 |
locale |
string |
現在のシステム言語 |
メトリクス
| フィールド |
タイプ |
説明 |
error_message |
string |
エラーメッセージ |
error_stack |
string |
エラースタック |
foreground_crash_free_duration |
number(ns) |
フォアグラウンドでのクラッシュなし継続時間 |
background_crash_free_duration |
number(ns) |
バックグラウンドでのクラッシュなし継続時間 |
Long Task
View 属性
| フィールド |
タイプ |
説明 |
view_id |
string |
ページにアクセスするたびに生成される一意な ID |
view_referrer |
string |
ページの参照元、ページの親 |
view_name |
string |
ページ名 |
Action 属性
| フィールド |
タイプ |
説明 |
action_id |
string |
ユーザーがページを操作したときに生成される一意な ID |
action_name |
string |
操作名 |
action_type |
string |
操作タイプ(コールド/ウォームスタート、click クリックなどの操作) |
メトリクス
| フィールド |
タイプ |
説明 |
duration |
number(ns) |
カクつき時間 |
long_task_message |
string |
カクつき情報 |
long_task_stack |
string |
カクつきスタック |
session_has_replay |
boolean |
現在のロングタスクが Session Replay データに関連付けられているかどうか |
Action
View 属性
| フィールド |
タイプ |
説明 |
view_id |
string |
ページにアクセスするたびに生成される一意な ID |
view_referrer |
string |
ページの参照元、ページの親 |
view_name |
string |
ページ名 |
Action 属性
| フィールド |
タイプ |
説明 |
action_id |
string |
ユーザーがページを操作したときに生成される一意な ID |
action_name |
string |
操作名 |
action_type |
string |
操作タイプ(例:click、launch_cold) |
app_launch_type |
string |
コールドスタート Action の起動タイプ。参考値:foreground(フォアグラウンド起点での起動)、background(バックグラウンド起点での起動)、foreground_and_background(フォアグラウンド起点で起動し、初回フレーム前にバックグラウンドへ移行してからフォアグラウンドに復帰)。ft-sdk 0.1.18 以降でサポートされます |
メトリクス
| フィールド |
タイプ |
説明 |
duration |
number(ns) |
ページ操作に要した時間 |
app_pre_application_init_time |
object |
コールドスタート時における、プロセス起動からアプリ初期化までの段階。形式:{start: number(ns), duration: number(ns)} |
app_application_init_time |
object |
コールドスタート時における、アプリ初期化から最初の UIAbility 作成までの段階。形式は同上 |
app_first_frame_init_time |
object |
コールドスタート時における、最初の UIAbility 作成から最初のレンダリングフレームまでの段階。形式は同上 |
session_has_replay |
boolean |
現在の操作が Session Replay データに関連付けられているかどうか |
統計メトリクス
| フィールド |
タイプ |
説明 |
action_long_task_count |
number |
操作に関連するロングタスク数 |
action_resource_count |
number |
操作に関連するリソースリクエスト数 |
action_error_count |
number |
操作に関連するエラー数 |