Unity Application Integration¶

Assets/Plugins
├── Android
│   ├── FTUnityBridge.java                  // Android bridge 
│   ├── InnerClassProxy.java                // Android Inner Setting Proxy
│   ├── ft-sdk-release.aar                  // Android SDK
│   ├── gson-2.8.5.jar                      // Android SDK 依赖第三方库
├── FTSDK.cs                                // FTSDK.prefab binding script
├── FTSDK.prefab                            // SDK Initialization prefab
├── FTUnityBridge.cs                        // Unity bridge for iOS, Android, etc.
├── FTViewObserver.cs                       // FTViewObserver.prefab binding script
├── FTViewObserver.prefab                   // View Page Listener prefab
├── UnityMainThreadDispatcher.cs            // UnityMainThreadDispatcher.prefab binding script
├── UnityMainThreadDispatcher.prefab        // Main Thread Queue prefab
├── iOS
│   ├── FTMobileSDK.xcframework                 // iOS SDK
│   ├── FTUnityBridge.mm                    // iOS bridge

FTUnityBridge.Install(new SDKConfig
            {
                datakitUrl = "http://10.0.0.1:9529",
                env = "prod",
                debug = true,

            });

FTUnityBridge.InitRUMConfig(new RUMConfig()
            {
                androidAppId = "androidAppId",
                iOSAppId = "iOSAppId",
                sampleRate = 0.8f,
            });

FTUnityBridge.InitLogConfig(new LogConfig
            {
                sampleRate = 0.9f,
                enableCustomLog = true,
                enableLinkRumData = true,
            });

FTUnityBridge.InitTraceConfig(new TraceConfig
            {
                sampleRate = 0.9f,
                traceType = TraceType.DDTrace,
                enableNativeAutoTrace = true,
                enableLinkRumData = true

            });

/// <summary>
/// Add an Action 
/// </summary>
/// <param name="actionName"> Action name</param>
/// <param name="actionType"> Action type</param>
public static void StartAction(string actionName, string actionType)

/// <summary>
/// Add an Action
/// </summary>
/// <param name="actionName">Action name</param>
/// <param name="actionType">Action type</param>
/// <param name="property">Additional property parameter</param>
public static void StartAction(string actionName, string actionType, Dictionary<string, object> property)

 FTUnityBridge.StartAction("click", "test");

/// <summary>
/// Start a View 
/// </summary>
/// <param name="viewName">Current page name</param>
public static void StartView(string viewName)

/// <summary>
/// Start a View 
/// </summary>
/// <param name="viewName">Current page name</param>
/// <param name="property">Additional property parameter</param>
public static void StartView(string viewName, Dictionary<string, object> property)

/// <summary>
/// End a View 
/// </summary>
public static void StopView()

/// <summary>
/// End a View 
/// </summary>
/// <param name="property">Additional property parameter</param>
public static void StopView(Dictionary<string, object> property)

FTUnityBridge.StartView("TEST_VIEW_ONE");

FTUnityBridge.StopView();

/// <summary>
/// Start a Resource 
/// </summary>
/// <param name="resourceId">Resource Id</param>
/// <returns></returns>
public static async Task StartResource(string resourceId)

/// <summary>
/// Start a Resource 
/// </summary>
/// <param name="resourceId">Resource Id</param>
/// <param name="property">Additional property parameter</param>
/// <returns></returns>
public static async Task StartResource(string resourceId, Dictionary<string, object> property)

/// <summary>
/// End a Resource 
/// </summary>
/// <param name="resourceId">Resource Id</param>
/// <returns></returns>
public static async Task StopResource(string resourceId)

/// <summary>
/// End a Resource 
/// </summary>
/// <param name="resourceId">Resource Id</param>
/// <param name="property">Additional property parameter</param>
/// <returns></returns>
public static async Task StopResource(string resourceId, Dictionary<string, object> property)


/// <summary>
/// Add network transfer content and metrics
/// </summary>
/// <param name="resourceId">Resource Id</param>
/// <param name="resourceParams">Data transfer content</param>
/// <param name="netStatus">Network metric data</param>
public static async Task AddResource(string resourceId, ResourceParams resourceParams)

FTUnityBridge.StartResource(resourceId);

FTUnityBridge.StopResource(resourceId);

ResourceParams resourceParams = new ResourceParams();
resourceParams.url = url;
resourceParams.requestHeader = client.DefaultRequestHeaders.ToDictionary(header => header.Key, header => string.Join(",", header.Value));
resourceParams.responseHeader = response.Headers.ToDictionary(header => header.Key, header => string.Join(",", header.Value));
resourceParams.resourceStatus = (int)response.StatusCode;
resourceParams.responseBody = responseData;
resourceParams.resourceMethod = "GET";

FTUnityBridge.AddResource(resourceId, resourceParams);

/// <summary>
/// Add error information
/// </summary>
/// <param name="log">Log</param>
/// <param name="message">Message</param>
/// <param name="errorType">Error type</param>
/// <param name="state">Program runtime state</param>
/// <returns></returns>
public static async Task AddError(string log, string message)


/// <summary>
/// Add error information
/// </summary>
/// <param name="log">Log</param>
/// <param name="message">Message</param>
/// <param name="errorType">Error type</param>
/// <param name="state">Program runtime state</param>
/// <param name="property">Additional property parameter</param>
/// <returns></returns>
public static async Task AddError(string log, string message,
    Dictionary<string, object> property)

void OnEnable()
{
    Application.logMessageReceived += LogCallBack;

}

void OnDisable()
{
    Application.logMessageReceived -= LogCallBack;
}

void LogCallBack(string condition, string stackTrace, LogType type)
{
    if (type == LogType.Exception)
    {
        FTUnityBridge.AddError(stackTrace, condition);
    }

}

/// <summary>
/// Add a long-running task
/// </summary>
/// <param name="log">Log content</param>
/// <param name="duration">Duration, in nanoseconds</param>
/// <returns></returns>
public static async Task AddLongTask(string log, long duration)

/// <summary>
/// Add a long-running task
/// </summary>
/// <param name="log">Log content</param>
/// <param name="duration">Duration, in nanoseconds</param>
/// <param name="property">Additional property parameter</param>
/// <returns></returns>
public static async Task AddLongTask(string log, long duration, Dictionary<string, object> property)

FTUnityBridge.AddLongTask("long task test", 100002);

/// <summary>
/// Add log
/// </summary>
/// <param name="log">Log content</param>
/// <param name="level">Log level: info, warning, error, critical, ok</param>
/// <returns></returns>
public static async Task AddLog(string log, LogLevel level)

 /// <summary>
/// Add log
/// </summary>
/// <param name="log">Log content</param>
/// <param name="level">Log level: info, warning, error, critical, ok</param>
/// <param name="property">Additional property parameter</param>
/// <returns></returns>
public static async Task AddLog(string log, LogLevel level, Dictionary<string, object> property)

FTUnityBridge.AddLog("test log", "test message");

/// <summary>
/// Get Trace ID
/// </summary>
/// <param name="url">URL address</param>
/// <returns>JSON string</returns>
public static async Task<string> GetTraceHeaderWithUrl(string url)


/// <summary>
/// Get Trace
/// </summary>
/// <param name="resourceId">Resource ID</param>
/// <param name="url">URL address</param>
/// <returns>JSON string</returns>
public static async Task<string> GetTraceHeader(string resourceId, string url)

string headData = FTUnityBridge.GetTraceHeader(resourceId, FAKE_URL);

string headData = FTUnityBridge.GetTraceHeader(FAKE_URL);

/**
 * Clears all data that has not yet been uploaded to the server.
*/
FTUnityBridge.clearAllData();

/**
 * Manually synchronizes data. When `FTMobileConfig.autoSync=false` is configured, you need to manually trigger this method to perform data synchronization.
 * @returns a Promise.
 */
FTUnityBridge.flushSyncData();

/// <summary>
/// Add custom global parameters. Applied to RUM and Log data
/// </summary>
public static void AppendGlobalContext(Dictionary<string, object> property)

/// <summary>
/// Add custom global RUM parameters. Applied to RUM data
/// </summary>
public static void AppendRUMGlobalContext(Dictionary<string, object> property)

/// <summary>
/// Add custom global Log parameters. Applied to Log data
/// </summary>
public static void AppendLogGlobalContext(Dictionary<string, object> property)

/// <summary>
/// Bind RUM user information
/// </summary>
/// <param name="userId">Unique user ID</param>
public static async Task BindUserData(string userId)

/// <summary>
/// Bind RUM user information
/// </summary>
/// <param name="userData"></param>
public static async Task BindUserData(UserData userData)

FTUnityBridge.BindUserData(new UserData
            {
                userId = "userid",
                userName = "userName",
                userEmail = "someone@email.com",
                extra = new Dictionary<string, string>{
                    {"custom_data","custom data"}
                }
            });

FTUnityBridge.UnBindUserdata()

/// <summary>
/// SDK Release
/// </summary>

FTUnityBridge.DeInit()

  FTUnityBridge.Install(new SDKConfig
    {
        //...
        dataModifier = new Dictionary<string, object>{
            {"device_uuid","xxx"}
        },
        lineDataModifier = new Dictionary<string, Dictionary<string, object>>
        {
            {"view",new Dictionary<string, object>{
                {"view_url","xxx"}
                }
            }
        }
    });

// FTSDK.cs
IEnumerator _LoadPrefabs()
{
    yield return Instantiate(MainThreadDispatch);
    //_InitSDK();                                 // Disable initialization
    yield return Instantiate(ViewObserver);
}