@truewatchtech/react-native-mobile 0.3.15-alpha.1

package/src/ft_logger.tsx

@@ -0,0 +1,77 @@
+import { NativeModules } from 'react-native';
+/**
+ * Set log level.
+ */
+ export enum FTLogStatus {
+   info, warning, error, critical, ok,
+ };
+/**
+ * Log discard method.
+ */
+ export enum FTLogCacheDiscard { discard, discardOldest };
+/**
+ * Configure log output configuration.
+ * @param sampleRate sampling rate
+ * @param enableLinkRumData whether to link with RUM
+ * @param enableCustomLog whether to enable custom logs
+ * @param discardStrategy log discard strategy
+ * @param logLevelFilters log level filter
+ * @param globalContext custom global parameters
+ * @param logCacheLimitCount get maximum log entry count limit [1000,), default 5000
+ */
+ export interface FTLogConfig{
+   sampleRate?: number,
+   enableLinkRumData?: boolean,
+   enableCustomLog?: boolean,
+   discardStrategy?: FTLogCacheDiscard,
+   logLevelFilters?: Array<FTLogStatus>,
+   globalContext?:object,
+   logCacheLimitCount?: number
+ };
+
+ type FTReactNativeLogType = {
+  /**
+   *Configure log output configuration to enable log collection.
+   */
+   logConfig(config: FTLogConfig): Promise<void>;
+  /**
+   * Output log.
+   * @param content log content
+   * @param status log status
+   * @param property log context (optional)
+   */
+   logging(content:String,logStatus:FTLogStatus,property?:object): Promise<void>;
+   /**
+    * Output log.
+    * @param content log content
+    * @param status log status
+    * @param property log context (optional)
+    */
+   logWithStatusString(content:String,logStatus:String,property?:object): Promise<void>;
+ };
+
+ class FTReactNativeLogWrapper  {
+   private logger: FTReactNativeLogType = NativeModules.FTReactNativeLog;
+
+  /**
+   *Configure log output configuration to enable log collection.
+   */
+   logConfig(config:FTLogConfig): Promise<void>{
+     return this.logger.logConfig(config);
+   }
+
+   /**
+   * Output log.
+   * @param content log content
+   * @param status log status
+   * @param property log context (optional)
+   */
+   logging(content:String,logStatus:FTLogStatus|String,property?:object): Promise<void>{
+     if((typeof logStatus)==='string'){
+       return this.logger.logWithStatusString(content,logStatus.toString(),property)
+     }
+     let enumLogStatus: FTLogStatus = logStatus as FTLogStatus;
+     return this.logger.logging(content,enumLogStatus,property);
+   }
+ }
+ export const FTReactNativeLog: FTReactNativeLogWrapper = new FTReactNativeLogWrapper();

package/src/ft_mobile_agent.tsx

@@ -0,0 +1,162 @@
+import { NativeModules } from 'react-native';
+import { version as sdkVersion } from './version'
+
+/**
+ * Environment.
+ */
+export enum EnvType {
+  prod, gray, pre, common, local
+};
+export enum FTDBCacheDiscard { discard, discardOldest };
+/**
+ * Configure SDK startup parameters.
+ * @param serverUrl data reporting address, deprecated, use [datakitUrl] instead
+ * @param datakitUrl datakit access URL address, example: http://10.0.0.1:9529, default port 9529. Choose one between datakit and dataway configuration
+ * @param datawayUrl dataway access URL address, example: http://10.0.0.1:9528, default port 9528, note: the device installing the SDK needs to be able to access this address. Note: choose one between datakit and dataway configuration
+ * @param clientToken dataway authentication token, needs to be configured together with [datawayUrl]
+ * @param debug set whether to allow log printing, default false
+ * @param env environment, default prod
+ * @param service set the name of the business or service it belongs to, default: `df_rum_ios`, `df_rum_android`
+ * @param autoSync whether data is automatically synchronized and uploaded, default: true
+ * @param syncPageSize number of synchronized items per request during data synchronization, minimum value 5, default: 10
+ * @param syncSleepTime interval time between each request during data synchronization, unit milliseconds, 0 < syncSleepTime < 100
+ * @param enableDataIntegerCompatible whether to enable data integer compatibility during data synchronization, enabled by default
+ * @param compressIntakeRequests whether to compress synchronized data
+ * @param globalContext custom global parameters
+ * @param groupIdentifiers iOS side sets the AppGroups Identifier array corresponding to the collected Widget Extension
+ * @param enableLimitWithDbSize set whether to enable using db to limit data size, after enabling, `FTLogConfig.logCacheLimitCount` and `FTRUMConfig.rumCacheLimitCount` will no longer take effect
+ * @param dbCacheLimit db cache limit size, minimum value 30MB, default 100MB, unit byte
+ * @param dbDiscardStrategy db data discard strategy
+ * @param dataModifier data modifier, modify individual fields {key:value}, after setting, the SDK will replace the original value with the set value according to the key
+ * @param lineDataModifier data modifier, modify single data {"measurement":measurement,"data":{key:value}}, after setting, the SDK will replace the original value with the set value according to the key
+ */
+ export interface FTMobileConfig {
+   /**
+    * @deprecated "serverUrl" parameter renamed to "datakitUrl"
+    */
+   serverUrl?: string,
+   datakitUrl?: string,
+   datawayUrl?: string,
+   clientToken?: string,
+   debug?:boolean,
+   envType?:EnvType,
+   env?:string,
+   service?:string,
+   autoSync?:boolean,
+   syncPageSize?:number,
+   syncSleepTime?:number,
+   enableDataIntegerCompatible?:boolean,
+   compressIntakeRequests?:boolean,
+   globalContext?:object,
+   groupIdentifiers?:Array<string>,
+   enableLimitWithDbSize?:boolean,
+   dbCacheLimit?:number,
+   dbDiscardStrategy?:FTDBCacheDiscard,
+   pkgInfo?: string,
+   dataModifier?:object,
+   lineDataModifier?:object
+ }
+
+
+type FTMobileReactNativeType = {
+
+  /**
+   * SDK initialization method.
+   * @param config SDK initialization configuration items.
+   * @returns a Promise.
+   */
+   sdkConfig(config:FTMobileConfig): Promise<void>;
+  /**
+   * Bind user.
+   * @param userId user ID.
+   * @param userName user name.
+   * @param userEmail user email
+   * @param extra additional user information
+   * @returns a Promise.
+   */
+   bindRUMUserData(userId: string,userName?:string,userEmail?:string,extra?:object): Promise<void>;
+  /**
+   * Unbind user.
+   * @returns a Promise.
+   */
+   unbindRUMUserData(): Promise<void>;
+   /**
+   * Add custom global parameters. Applies to RUM and Log data
+   * @param context custom global parameters.
+   * @returns a Promise.
+   */
+   appendGlobalContext(context:object):Promise<void>;
+   /**
+   * Add custom RUM global parameters. Applies to RUM data
+   * @param context custom RUM global parameters.
+   * @returns a Promise.
+   */
+   appendRUMGlobalContext(context:object):Promise<void>;
+  /**
+   * Add custom RUM and Log global parameters. Applies to Log data
+   * @param context custom Log global parameters.
+   * @returns a Promise.
+   */
+   appendLogGlobalContext(context:object):Promise<void>;
+   /**
+    * Actively synchronize data. When `FTMobileConfig.autoSync=false` is configured, you need to actively trigger this method to synchronize data.
+    * @returns a Promise.
+   */
+   flushSyncData():Promise<void>;
+
+   /**
+   * Synchronize events in iOS Widget Extension, iOS only
+   * @param groupIdentifier app groupId
+   * @returns {groupIdentifier:string,datas:Array<object>} can be used to view data collected in Extension.
+   */
+   trackEventFromExtension(identifier:string): Promise<object>
+   /**
+    * Shut down objects currently running in the SDK
+    */
+   shutDown():Promise<void>
+   /**
+    * Clear all data that has not yet been uploaded to the server.
+    */
+   clearAllData():Promise<void>
+ };
+
+ class FTMobileReactNativeWrapper implements FTMobileReactNativeType {
+   private sdk:FTMobileReactNativeType = NativeModules.FTMobileReactNative;
+
+   sdkConfig(config:FTMobileConfig): Promise<void> {
+     if(config.serverUrl != null && config.serverUrl.length>0 && config.datakitUrl == null){
+       config.datakitUrl = config.serverUrl;
+     }
+     config.pkgInfo = sdkVersion;
+     return this.sdk.sdkConfig(config);
+   }
+   bindRUMUserData(userId: string,userName?:string,userEmail?:string,extra?:object): Promise<void> {
+     return this.sdk.bindRUMUserData(userId,userName,userEmail,extra);
+   }
+   unbindRUMUserData(): Promise<void> {
+     return this.sdk.unbindRUMUserData();
+   }
+   appendGlobalContext(context: object): Promise<void> {
+    return this.sdk.appendGlobalContext(context);
+   }
+   appendLogGlobalContext(context: object): Promise<void> {
+       return this.sdk.appendLogGlobalContext(context);
+   }
+   appendRUMGlobalContext(context: object): Promise<void> {
+       return this.sdk.appendRUMGlobalContext(context);
+   }
+   trackEventFromExtension(identifier:string) :Promise<object>{
+     return this.sdk.trackEventFromExtension(identifier);
+   }
+   flushSyncData():Promise<void>{
+    return this.sdk.flushSyncData();
+   }
+   shutDown():Promise<void>{
+    return this.sdk.shutDown();
+   }
+   clearAllData():Promise<void>{
+    return this.sdk.clearAllData();
+   }
+ }
+export const FTMobileReactNative: FTMobileReactNativeType = new FTMobileReactNativeWrapper();
+

package/src/ft_rum.tsx

@@ -0,0 +1,247 @@
+import { NativeModules } from 'react-native';
+import { FTRumErrorTracking} from './rum/FTRumErrorTracking';
+import { FTRumActionTracking} from './rum/FTRumActionTracking';
+
+/**
+ * Error monitoring type.
+ */
+ export enum ErrorMonitorType {
+   all=0xFFFFFFFF,
+   battery=1 << 1,
+   memory=1 << 2,
+   cpu=1 << 3,
+ }
+  /**
+  * Page monitoring supplement type
+  */
+ export enum DeviceMetricsMonitorType {
+    all=0xFFFFFFFF,
+    battery=1 << 1,
+    memory=1 << 2,
+    cpu=1 << 3,
+    fps=1 << 4
+ }
+ /**
+  * Device information monitoring cycle.
+  */
+ export enum DetectFrequency { normal, frequent, rare }
+
+ export enum FTRUMCacheDiscard { discard, discardOldest };
+
+/**
+ * Set RUM tracking conditions.
+ * @param androidAppId appId, apply during monitoring
+ * @param iOSAppId appId, apply during monitoring
+ * @param sampleRate sampling rate
+ * @param sessionOnErrorSampleRate error session sampling rate. For sessions not sampled, if ERROR is hit, collect data 1 minute before the error occurs
+ * @param enableAutoTrackUserAction whether to automatically collect react-native control click events, can set actionName with accessibilityLabel when enabled
+ * @param enableTrackError whether to automatically collect react-native Error
+ * @param enableTrackNativeCrash whether to collect Native Error
+ * @param enableTrackNativeAppANR whether to collect Native ANR
+ * @param enableTrackNativeFreeze whether to collect Native Freeze
+ * @param nativeFreezeDurationMs set the threshold for collecting Native Freeze, value range [100,), unit ms. iOS default 250ms, Android default 1000ms
+ * @param enableNativeUserAction whether to start Native Action tracking, Button click events, recommended to disable for pure react-native apps
+ * @param enableNativeUserView whether to start Native View auto tracking, recommended to disable for pure react-native apps
+ * @param enableNativeUserResource whether to automatically collect react-native Resource
+ * @param enableResourceHostIP whether to collect network request Host IP (only for native http, iOS 13 and above)
+ * @param errorMonitorType error monitoring supplement type
+ * @param deviceMonitorType page monitoring supplement type
+ * @param detectFrequency monitoring frequency
+ * @param globalContext custom global parameters
+ * @param rumCacheLimitCount RUM max cache size, default 100_000
+ * @param rumDiscardStrategy RUM data discard strategy
+ */
+ export interface FTRUMConfig{
+   androidAppId:string,
+   iOSAppId:string,
+   sampleRate?:number,
+   sessionOnErrorSampleRate?:number,
+   enableAutoTrackUserAction?:boolean,
+   enableAutoTrackError?:boolean,
+   enableTrackNativeCrash?:boolean,
+   enableTrackNativeAppANR?:boolean,
+   enableTrackNativeFreeze?:boolean,
+   nativeFreezeDurationMs?:number,
+   enableNativeUserAction?:boolean,
+   enableNativeUserView?:boolean,
+   enableNativeUserResource?:boolean,
+   enableResourceHostIP?:boolean,
+   errorMonitorType?:ErrorMonitorType,
+   deviceMonitorType?:DeviceMetricsMonitorType,
+   detectFrequency?:DetectFrequency
+   globalContext?:object,
+   rumCacheLimitCount?:number,
+   rumDiscardStrategy?:FTRUMCacheDiscard,
+ }
+/**
+ * RUM Resource data.
+ * @param url request URL
+ * @param httpMethod request method
+ * @param requestHeader request header parameters
+ * @param responseHeader response header parameters
+ * @param responseBody response content
+ * @param resourceStatus response status code
+ */
+ export interface FTRUMResource{
+   url:string,
+   httpMethod:string,
+   requestHeader:object,
+   responseHeader?:object,
+   responseBody?:string,
+   resourceStatus?:number
+ };
+/**
+ * RUM Resource performance metrics.
+ * @param duration resource load time
+ * @param resource_dns resource DNS resolution time
+ * @param resource_tcp resource TCP connection time
+ * @param resource_ssl resource SSL connection time
+ * @param resource_ttfb resource request response time
+ * @param resource_trans resource content transfer time
+ * @param resource_first_byte resource first byte time
+ */
+ export interface FTRUMResourceMetrics{
+
+   duration?:number,
+   resource_dns?:number,
+   resource_tcp?:number,
+   resource_ssl?:number,
+   resource_ttfb?:number,
+   resource_trans?:number,
+   resource_first_byte?:number,
+ };
+ type FTReactNativeRUMType = {
+  /**
+   * Set RUM tracking conditions and enable RUM collection.
+   * @param config rum configuration parameters.
+   * @returns a Promise.
+   */
+   setConfig(config:FTRUMConfig): Promise<void>;
+  /**
+   * Start RUM Action.
+   * RUM will bind Resource, Error, LongTask events that may be triggered by this Action.
+   * Avoid adding multiple times within 0.1s, only one Action will be associated with the same View at the same time, and new Actions will be discarded if the previous one has not ended.
+   * Adding Action with `addAction` method does not affect each other.
+   * @param actionName action name
+   * @param actionType action type
+   * @param property event context (optional)
+   * @returns a Promise.
+   */
+   startAction(actionName:string,actionType:string,property?:object): Promise<void>;
+   /**
+   * Add Action event. This type of data cannot be associated with Error, Resource, LongTask data, and has no discard logic.
+   * @param actionName action name
+   * @param actionType action type
+   * @param property event context (optional)
+   * @returns a Promise.
+   */
+   addAction(actionName:string,actionType:string,property?:object): Promise<void>;
+  /**
+   * view load duration.
+   * @param viewName view name
+   * @param loadTime view load duration
+   * @returns a Promise.
+   */
+   onCreateView(viewName:string,loadTime:number): Promise<void>;
+  /**
+   * view start.
+   * @param viewName page name
+   * @param property event context (optional)
+   * @returns a Promise.
+   */
+   startView(viewName: string, property?: object): Promise<void>;
+  /**
+   * view end.
+   * @param property event context (optional)
+   * @returns a Promise.
+   */
+   stopView(property?:object): Promise<void>;
+  /**
+   * Exception capture and log collection.
+   * @param stack stack log
+   * @param message error message
+   * @param property event context (optional)
+   * @returns a Promise.
+   */
+   addError(stack: string, message: string,property?:object): Promise<void>;
+  /**
+   * Exception capture and log collection.
+   * @param type error type
+   * @param stack stack log
+   * @param message error message
+   * @param property event context (optional)
+   * @returns a Promise.
+   */
+   addErrorWithType(type:string,stack: string, message: string,property?:object): Promise<void>;
+  /**
+   * Start resource request.
+   * @param key unique id
+   * @param property event context (optional)
+   * @returns a Promise.
+   */
+   startResource(key: string,property?:object): Promise<void>;
+  /**
+   * End resource request.
+   * @param key unique id
+   * @param property event context (optional)
+   * @returns a Promise.
+   */
+   stopResource(key: string,property?:object): Promise<void>;
+  /**
+   * Send resource data metrics.
+   * @param key unique id
+   * @param resource resource data
+   * @param metrics resource performance data
+   * @returns a Promise.
+   */
+   addResource(key:string, resource:FTRUMResource,metrics?:FTRUMResourceMetrics):Promise<void>;
+ }
+
+ class FTReactNativeRUMWrapper implements FTReactNativeRUMType {
+    private rum: FTReactNativeRUMType = NativeModules.FTReactNativeRUM;
+
+
+   setConfig(config:FTRUMConfig): Promise<void>{
+     console.log('FTRUMConfig');
+     if(config.enableAutoTrackError){
+        FTRumErrorTracking.startTracking();
+     }
+     if(config.enableAutoTrackUserAction){
+        FTRumActionTracking.startTracking();
+     }
+     return this.rum.setConfig(config);
+   }
+   startAction(actionName:string,actionType:string,property?:object): Promise<void>{
+     return this.rum.startAction(actionName,actionType,property);
+   }
+   addAction(actionName: string, actionType: string, property?: object): Promise<void> {
+    return this.rum.addAction(actionName,actionType,property);
+   }
+   onCreateView(viewName:string,loadTime:number): Promise<void>{
+     return this.rum.onCreateView(viewName,loadTime);
+   }
+   startView(viewName: string, property?:object): Promise<void>{
+     return this.rum.startView(viewName,property);
+   }
+   stopView(property?:object): Promise<void>{
+     return this.rum.stopView(property);
+   }
+   addError(stack: string, message: string,property?:object): Promise<void>{
+     return this.rum.addError(stack,message,property);
+   }
+   addErrorWithType(type:string,stack: string, message: string,property?:object): Promise<void>{
+    return this.rum.addErrorWithType(type,stack,message,property);
+  }
+   startResource(key: string,property?:object): Promise<void>{
+     return this.rum.startResource(key,property);
+   }
+   stopResource(key: string,property?:object): Promise<void>{
+     return this.rum.stopResource(key,property);
+   }
+   addResource(key:string, resource:FTRUMResource,metrics:FTRUMResourceMetrics={}):Promise<void>{
+     return this.rum.addResource(key,resource,metrics);
+   }
+ }
+
+ export const FTReactNativeRUM: FTReactNativeRUMType = new FTReactNativeRUMWrapper();
+

package/src/ft_tracing.tsx

@@ -0,0 +1,79 @@
+import { NativeModules } from 'react-native';
+//FTReactNativeTrace
+
+/**
+ * Trace types for use.
+ */
+ export enum TraceType {
+   ddTrace,
+   zipkinMulti,
+   zipkinSingle,
+   traceparent,
+   skywalking,
+   jaeger,
+ };
+/**
+ * Configure trace.
+ * @param sampleRate sampling rate
+ * @param traceType trace type
+ * @param enableLinkRUMData whether to link with RUM data
+ * @param enableNativeAutoTrace whether to enable automatic tracing
+ */
+ export interface FTTraceConfig{
+   sampleRate?:number,
+   traceType?:TraceType,
+   enableLinkRUMData?:boolean,
+   enableNativeAutoTrace?:boolean,
+ };
+
+ type FTReactNativeTraceType = {
+  /**
+   * Configure trace to enable distributed tracing.
+   * @param config trace configuration parameters.
+   * @returns a Promise.
+   */
+   setConfig(config: FTTraceConfig): Promise<void>; 
+  /**
+   * Get trace HTTP request header data.
+   * @param url request URL
+   * @returns trace request header parameters
+   * @deprecated use getTraceHeaderFields() replace.
+   */
+   getTraceHeader(key:String, url: String): Promise<object>;
+   /**
+   * Get trace HTTP request header data.
+   * @param url request URL
+   * @returns trace request header parameters
+   */
+   getTraceHeaderFields(url: String,key?:String): Promise<object>;
+ };
+
+ class FTReactNativeTraceWrapper implements FTReactNativeTraceType {
+   private trace: FTReactNativeTraceType = NativeModules.FTReactNativeTrace;
+
+
+   setConfig(config:FTTraceConfig): Promise<void>{
+     return this.trace.setConfig(config);
+   }
+  /**
+   * Get trace HTTP request header data.
+   * @param key unique id
+   * @param url request URL
+   * @returns a Promise.
+   */
+   getTraceHeader(key:String, url: String): Promise<object>{
+     return this.trace.getTraceHeaderFields(url,key);
+   }
+    /**
+   * Get trace HTTP request header data.
+   * @param url request URL
+   * @param key unique id
+   * @returns a Promise.
+   */
+   getTraceHeaderFields(url: String,key?:String): Promise<object>{
+    return this.trace.getTraceHeaderFields(url,key);
+   }
+
+ }
+ export const FTReactNativeTrace:FTReactNativeTraceType = new FTReactNativeTraceWrapper(); 
+

package/src/index.tsx

@@ -0,0 +1,17 @@
+import {FTMobileConfig,FTMobileReactNative,EnvType,FTDBCacheDiscard} from './ft_mobile_agent'
+import {FTLogConfig,FTReactNativeLog,FTLogStatus,FTLogCacheDiscard} from './ft_logger'
+import {FTRUMConfig,FTRUMResource,FTReactNativeRUM,ErrorMonitorType,DeviceMetricsMonitorType,DetectFrequency,FTRUMResourceMetrics,FTRUMCacheDiscard} from './ft_rum'
+import {FTTraceConfig,FTReactNativeTrace,TraceType} from './ft_tracing'
+import {FTRumActionTracking} from './rum/FTRumActionTracking'
+import {FTRumErrorTracking} from './rum/FTRumErrorTracking'
+
+ 
+ export {
+   FTMobileReactNative,FTMobileConfig,EnvType,FTDBCacheDiscard,
+   FTLogConfig, FTReactNativeLog,FTLogStatus,FTLogCacheDiscard,
+   FTRUMConfig,FTReactNativeRUM,FTRUMResource,ErrorMonitorType,DeviceMetricsMonitorType,DetectFrequency,FTRUMResourceMetrics,FTRUMCacheDiscard,
+   FTTraceConfig,FTReactNativeTrace,TraceType,
+   FTRumActionTracking,
+   FTRumErrorTracking
+ };
+