Cocos Creator アプリケーションデータ収集
概要
Cocos Creator のデータ収集は Android、iOS Native SDK に依存しています。このページでは、モバイル SDK で統一されたデータ型とフィールドに基づいて、実際に報告できる RUM データについて説明します。具体的なフィールドが生成されるかどうかは、Cocos Creator の自動収集、手動収集、および Native 収集の設定によって異なります。
データ型
Guance のリアルユーザーモニタリング(RUM)には 6 種類のデータ型があります。
| タイプ |
説明 |
| session |
ユーザーセッション情報の記録。現在のセッション内のページ、リソース、アクション、エラー、ロングタスクなどのアクセスデータは、このセッションに関連付けられます。 |
| view |
ユーザーがモバイルアプリのページにアクセスするたびに、View レコードが 1 つ生成されます。ユーザーが同じページに留まっている間、リソース、ロングタスク、エラー、アクションのレコードは view_id を介して対応する RUM View に関連付けられます。 |
| resource |
ユーザーがページにアクセスしたときに読み込まれたリソース情報の記録。 |
| error |
モバイルアプリで発生した例外またはクラッシュ。 |
| long_task |
アプリ内でメインスレッドを指定した時間しきい値を超えてブロックするロングタスクの記録。 |
| action |
モバイルアプリ内のユーザーアクティビティ(アプリ起動、クリック、スワイプ、戻るなど)を記録します。各操作には一意の action_id が付随します。 |
グローバル属性
RUM のシナリオ構築とイベントアラートは、以下のグローバル属性でクエリできます。
SDK 属性
| フィールド |
タイプ |
説明 |
sdk_name |
string |
収集器の名前。Cocos Creator SDK は Native SDK を介して報告されるため、df_ios_rum_sdk または df_android_rum_sdk に対応します。 |
sdk_version |
string |
収集器のバージョン情報。 |
アプリ属性
| フィールド |
タイプ |
説明 |
app_id |
string |
必須。ユーザーがアクセスするアプリの一意の ID 識別子。Guance コンソールでモニターを作成するときに自動生成されます。 |
env |
string |
必須。環境フィールド。属性値:prod、gray、pre、common、local。 |
version |
string |
必須。バージョン番号。 |
service |
string |
オプション。所属するビジネスまたはサービスの名前。Native SDK のデフォルトのサービス名は df_rum_ios または df_rum_android です。 |
ユーザー & セッション属性
| フィールド |
タイプ |
説明 |
userid |
string |
未ログインユーザーはランダムな UUID を userid として使用し、ログインユーザーはアプリのバックエンドで生成されたユーザー ID を使用します。 |
user_name |
string |
オプション。ユーザー名。 |
user_email |
string |
オプション。ユーザーのメールアドレス。 |
session_id |
string |
セッション ID。15 分以上操作がない場合、新しい session_id が生成されます。 |
session_type |
string |
セッションタイプ。参考値:user と synthetics。user は RUM 機能によって生成されたデータを示し、synthetics はヘッドレス Synthetic テストによって生成されたデータを示します。 |
is_signin |
boolean |
登録ユーザーかどうか。属性値:T または F。 |
デバイス & 解像度属性
| フィールド |
タイプ |
説明 |
device |
string |
モバイルデバイスのメーカー。 |
model |
string |
モバイルデバイスのモデル。 |
device_uuid |
string |
モバイルデバイスの一意の ID。Android は ANDROID_ID、iOS は UIDevice.identifierForVendor を使用して生成されます。 |
os |
string |
オペレーティングシステム情報。 |
os_version |
string |
オペレーティングシステムのバージョン。 |
os_version_major |
string |
オペレーティングシステムのメジャーバージョン。 |
screen_size |
string |
画面解像度。 |
地理 & ネットワーク属性
| フィールド |
タイプ |
説明 |
ip |
string |
ユーザーアクセスの IP アドレス。 |
isp |
string |
通信事業者。 |
network_type |
string |
ネットワーク接続タイプ。参考値:wifi、2g、3g、4g、5g、unknown(不明なネットワーク)、unreachable(ネットワーク到達不能)。 |
country |
string |
国。 |
country_iso_code |
string |
国の ISO コード。 |
province |
string |
省。 |
city |
string |
都市。 |
カスタム属性
グローバル属性以外にも、カスタム属性(SDK はユーザーによるカスタム Tag データの追加をサポートしています)を使用してシナリオを構築し、イベントアラートを設定できます。カスタム属性はグローバル属性ではなく、ユーザーがアプリにアクセスするプロセス全体を追跡し、影響を受けるユーザーアクセスを特定・検出するために使用できます。
その他のデータ型の属性
Session
属性
| フィールド |
タイプ |
説明 |
session_id |
string |
セッション ID。 |
session_type |
string |
セッションタイプ。参考値:user と test。user は RUM 機能によって生成されたデータを示し、test はヘッドレス Synthetic テストによって生成されたデータを示します。 |
session_referrer |
string |
セッションの参照元。通常は参照元ページのアドレスが記録されます。 |
session_first_view_id |
string |
現在のセッションの最初のページの view_id。 |
session_first_view_name |
string |
現在のセッションの最初のページの名前。 |
session_last_view_id |
string |
現在のセッションで最後にアクセスしたページの view_id。 |
session_last_view_name |
string |
現在のセッションの最後のページの名前。 |
統計指標
| フィールド |
タイプ |
説明 |
time_spent |
number(ns) |
現在のセッションの継続時間。 |
session_view_count |
number |
現在のセッションに関連付けられた view_id の数。 |
session_error_count |
number |
現在のセッションで発生したエラー数。 |
session_resource_count |
number |
現在のセッションで読み込まれたリソース数。 |
session_action_count |
number |
現在のセッションでのユーザー操作回数。 |
session_long_task_count |
number |
現在のセッションで発生したロングタスク数。 |
View
属性
| フィールド |
タイプ |
説明 |
view_id |
string |
ページにアクセスするたびに生成される一意の ID。 |
view_referrer |
string |
ページの参照元。つまりページの親。 |
view_name |
string |
ページ名。Cocos Creator の自動収集時はシーン名になります。 |
Action 属性
| フィールド |
タイプ |
説明 |
action_id |
string |
ユーザーがページで操作したときに生成される一意の ID。 |
action_name |
string |
操作名。 |
action_type |
string |
操作タイプ。コールドスタート、ウォームスタート、click など。 |
指標
| フィールド |
タイプ |
説明 |
loading_time |
number(ns) |
ページの読み込み時間。 |
time_spent |
number(ns) |
ページ滞在時間。 |
is_active |
boolean |
ユーザーが引き続きアクティブな状態かどうか。参考値:true または false。 |
統計指標
| フィールド |
タイプ |
説明 |
view_error_count |
number |
ページが読み込まれるたびに発生したエラー数。 |
view_resource_count |
number |
ページが読み込まれるたびにリクエストされたリソース数。 |
view_long_task_count |
number |
ページが読み込まれるたびに発生したロングタスク数。 |
view_action_count |
number |
ページ閲覧中の操作回数。 |
監視指標
| フィールド |
タイプ |
説明 |
cpu_tick_count |
number |
オプション。このページの CPU ティック数。 |
cpu_tick_count_per_second |
number |
オプション。1 秒あたりの平均 CPU ティック数。 |
fps_avg |
number |
オプション。ページの平均 FPS。 |
fps_mini |
number |
オプション。ページの最小 FPS。 |
memory_avg |
number |
オプション。ページのメモリ使用量の平均値。 |
memory_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_url |
string |
リソースの URL。 |
resource_url_host |
string |
リソース URL のドメイン部分。 |
resource_url_path |
string |
リソース URL のパス部分。 |
resource_url_query |
string |
リソース URL のクエリ部分。 |
resource_url_path_group |
string |
リソース URL のパスグループ。 |
resource_type |
string |
リソースのカテゴリ。 |
resource_method |
string |
リソースリクエストのメソッド。 |
resource_status |
string |
リソースリクエストが返したステータス値。 |
resource_status_group |
string |
リソースリクエストが返したステータスのグループ値。 |
指標
| フィールド |
タイプ |
説明 |
resource_size |
number |
リソースサイズ。デフォルト単位:byte。 |
resource_dns |
number(ns) |
リソース読み込みの DNS 解決時間。計算方法:dnsEndTime - dnsStartTime。 |
resource_tcp |
number(ns) |
リソース読み込みの TCP 接続時間。計算方法:tcpEndTime - tcpStartTime。 |
resource_ssl |
number(ns) |
リソース読み込みの SSL 接続時間。計算方法:sslEndTime - sslStartTime。 |
resource_ttfb |
number(ns) |
リソース読み込みのリクエスト応答時間。 |
resource_trans |
number(ns) |
リソース読み込みのコンテンツ転送時間。計算方法:responseEndTime - responseStartTime。 |
resource_first_byte |
number(ns) |
リソース読み込みの最初のバイトまでの時間。 |
duration |
number(ns) |
リソース読み込みの合計時間。 |
request_header |
string |
リソースリクエストヘッダー。 |
response_header |
string |
リソースレスポンスヘッダー。 |
Resource のフェーズ別指標
Cocos Creator による fetch と XMLHttpRequest の自動収集では、リクエストとレスポンスの基本情報と合計所要時間が報告されます。DNS、TCP、SSL などのフェーズ別指標は、手動収集時に FTResourceMetrics で対応する時間値を指定した場合にのみ生成されます。
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 |
エラータイプ。Cocos Creator 層で一般的な値:cocos_error、unhandled_promise_rejection、network_error。Native 層では java_crash、native_crash、anr_error、anr_crash、ios_crash などが発生する場合もあります。 |
error_situation |
string |
エラーが発生したタイミング。参考値:startup(起動時)と run(実行時)。 |
error_source=network の場合、以下の Network Error 属性を追加できます。
| フィールド |
タイプ |
説明 |
resource_status |
string |
リソースリクエストが返したステータス値。 |
resource_url |
string |
リソースの URL。 |
resource_url_host |
string |
リソース URL のドメイン部分。 |
resource_url_path |
string |
リソース URL のパス部分。 |
resource_url_path_group |
string |
リソース URL のパスグループ。 |
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 |
エラースタック。 |
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_stack |
string |
ロングタスクのスタック。 |
Long Task の収集について
Cocos の JavaScript 層では現在、Long Task を自動で監視していません。業務側で既知のタスクの所要時間を測定し、addLongTask() で報告できます。Native UI Block/Freeze を有効にすると、Native 層のロングタスクも報告できます。
Action
View 属性
| フィールド |
タイプ |
説明 |
view_id |
string |
ページにアクセスするたびに生成される一意の ID。 |
view_referrer |
string |
ページの参照元。つまりページの親。 |
view_name |
string |
ページ名。 |
Action 属性
| フィールド |
タイプ |
説明 |
action_id |
string |
ユーザーがページで操作したときに生成される一意の ID。 |
action_name |
string |
操作名。Cocos Creator の自動収集時は、イベントターゲットのノード名が優先的に使用されます。 |
action_type |
string |
操作タイプ。Cocos Creator のグローバルタッチ自動収集のタイプは click です。 |
指標
| フィールド |
タイプ |
説明 |
duration |
number(ns) |
ページ操作にかかった時間。 |
統計指標
| フィールド |
タイプ |
説明 |
action_long_task_count |
number |
操作に関連するロングタスク数。 |
action_resource_count |
number |
操作に関連するリソースリクエスト数。 |
action_error_count |
number |
操作に関連するエラー数。 |
関連設定
自動収集のルールはカスタム収集ルール、手動収集のインターフェースは RUM 手動埋め込みポイントを参照してください。データ収集の範囲と機密データの処理についてはデータとプライバシーを参照してください。