tencent cloud

文档反馈

日志与事件上报

最后更新时间:2024-07-03 18:07:10

    SDK 运行日志打印

    在开发阶段实现日志输出接口,方便进行问题排查。
    Note:
    APP 发布上线时,建议关闭日志输出,保证安全性及性能。
    /// 打印Log
    /// @param level log级别,参考PLTLogLevel
    /// @param msg log信息
    - (void)log:(MALogLevel)level msg:(NSString *)msg;

    事件上报

    宿主 APP 可以实现事件上报接口,来覆盖 TCMPP SDK 内部的上报逻辑。
    包括小程序操作事件及小程序内部调用 wx.reportEvent 上报的数据。
    typedef NS_ENUM(NSInteger, TMAReportEventID) {
    // 未定义,报报用户自定义事件
    // Undefined, report user-defined events
    TMAReportEventID_None = 0,
    // 打开小程序
    // Open the mini app
    TMAReportEventID_OPEN_MINIAPP = 1,
    // 更新小程序
    // Update the mini app
    TMAReportEventID_UPDATE_MINIAPP = 2,
    // 下载小程序
    // Download the mini app
    TMAReportEventID_DOWNLOAD_MINIAPP = 3,
    // 小程序页面浏览
    // Open the mini app page
    TMAReportEventID_MINIAPP_PAGE_VIEW = 4,
    // 退出小程序
    // Close the mini app
    TMAReportEventID_EXIT_MINIAPP = 5,
    // 小程序行为事件,atcion:0 后台;1 前台
    // Mini program action events, atcion: 0 onHide; 1 onShow
    TMAReportEventID_MINIAPP_ACTION = 6
    };
    
    // 上报数据 - Report data
    // @param event 事件,参考TMAReportEventID - Event Id,Reference TMAReportEventID
    // @param eventName 事件名称 - Event Name
    // @param params 参数 - params
    // @param appInfo 小程序信息 - Mini program info
    // @return 是否拦截内部上报 - Whether to intercept internal reports
    - (BOOL)reportEvent:(int)eventId
    eventName:(NSString *)eventName
    params:(NSDictionary *)params
    appinfo:(TMFMiniAppInfo *)appInfo;

    小程序实时日志上报

    宿主 APP 可以实现事件实时日志上报接口,来覆盖 TCMPP SDK 内部的上报逻辑。
    包括小程序内部调用 wx.getRealtimeLogManager 写入的日志数据。
    // 上报日志数据 - Report log data
    // @param appId appID
    // @param jsVersion 基础库版本 - The basic library version
    // @param page 当前页面 - The current page
    // @param filterMsgs 过滤内容 - The filter contents
    // @param logs 日志事件 - Log events
    // @param completionBlock 结果回调 - Callback result
    // @return 是否拦截内部上报 - Whether to intercept internal reports
    - (BOOL)reportRealTimeLogWithAppId:(NSString *)appId
    jsVersion:(NSString *)jsVersion
    page:(NSString *)page
    filterMsgs:(NSArray <NSString *>*)filterMsgs
    logs:(NSArray <TMARealtimeLogItem *>*)logs
    completionBlock:(void (^)(NSError * _Nullable error))completionBlock;
    

    小程序内部日志上报

    宿主 APP 可以实现事件实时日志上报接口,来覆盖 TCMPP SDK 内部的上报逻辑。
    包括小程序内部调用 wx.getLogManager 写入的日志数据,用户可以通过使用 button 组件的 open-type="feedback" 来上传打印的日志。
    // 上传appID对应小程序的log - Upload the log of the applet corresponding to the appID
    // 实现时,可以使用TMFMiniAppSDKManager的`sandBoxPathWithAppID:`接口获取沙箱路径,然后拼接`usr/miniprogramLog/`获取 - When implementing, you can use the `sandBoxPathWithAppID:` interface of TMFMiniAppSDKManager to obtain the sandbox path, and then splice `usr/miniprogramLog/` to obtain it.
    // @param appID 小程序的appID - The appID of mini program/mini game
    
    - (void)uploadLogFileWithAppID:(NSString *)appID;
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持