全部产品
Search
文档中心

移动开发平台mPaaS:配置日志上报开关

更新时间:Jul 07, 2023

开关配置功能指通过服务端下发的开关值,修改日志自动上报的触发条件,对日志上报进行动态控制。

移动分析依赖客户端 SDK 来进行埋点,收集用户行为以及 App 性能等相关数据生成日志并上报到服务端,然后通过实时或离线计算形成各种指标和大盘供用户查看。

mPaaS 会对埋点日志的上报收取流量费用,为避免产生一些不必要的费用,您可以通过开关配置对日志上报进行管理。更多关于日志上报流量费用的信息,请参见 后付费模式

下文介绍如何添加埋点配置并进行管理。

新增埋点配置

  1. 登录 mPaaS 控制台,从左侧导航栏进入 移动分析 > 日志管理 > 配置上传开关 页面,单击左上方的 埋点配置,进入日志开关列表页。

  2. 单击 新增业务 按钮,配置埋点信息。

    • 业务 code:业务码。其中,自定义行为埋点的业务码配置因平台而异。

      • Android:客户端通过代码 MPLogger.event(String logId, String bizType, Map<String, String> params) 设置的 bizType,bizType不能带下划线_。

      • iOS:默认为 behavior,客户端可以通过 writeLogWithActionId 接口中的 bizType 参数自定义。更多信息,请参见 Android 业务码iOS 业务码

    • 业务名称:埋点业务的说明。您可以自定义业务名称。

    • 日志头:日志模型中的 字段 01,用于区分不同的日志类型。其中,自定义行为埋点的日志头为 D-VM。更多信息,请参见 日志模型

  3. 单击 新增 按钮,完成埋点配置新增。更进一步的配置,参见下文 修改埋点配置

修改埋点配置

新增埋点配置展示在日志开关列表中,您可以进行日志上报开关设置、网络设置,埋点修改以及删除操作。

设置日志上报开关

开启或关闭日志上报。开启上报开关后,该业务的埋点日志会自动上报。

设置上报网络

您可以选择在 全网环境(2G、3G、4G 和 Wi-Fi 等)或只有在 Wi-Fi 环境中上报埋点日志。

修改埋点信息

单击操作列下的 修改 按钮,进入埋点配置修改页面,您可以对埋点配置作进一步的修改:

  • 业务码:对应新增埋点配置时填写的业务码。

  • 说明:对应新增埋点配置时填写的业务名称。

  • 日志头:对应新增埋点配置时填写的日志头。

  • 最低上报等级:每条日志的重要程度分为 1、2、3 三个等级;1 级表示最重要,2 级次之,3 级最次。如设置最低上报等级为 2,则等级为 1 和 2 的日志会上报,而等级为 3 的日志不上报。其中,自定义行为埋点默认等级为 2;iOS 应用可以在客户端埋点时修改日志等级,请参见 iOS 自定义行为埋点

  • 日志上报条数:客户端埋点日志会先写入本地,本地文件中此业务码类型的日志达到一定条数后会自动上报到移动分析服务端。更多信息,请参见 Android 日志自动上报iOS 日志自动上报

  • 日志上报比率:按用户维度设置日志上报的比率,采用千分制,如 1000 表示全部用户都上报。

  • 策略:勾选 压后台上报 策略后,不同平台的上报时机会有所不同。

    • Android:应用进入后台、超过半小时后,会触发日志自动上报。

    • iOS:应用进入后台会立即触发日志自动上报。更多信息,请参见 Android 上报日志iOS 上报日志

初始化业务

客户端写入本地的日志,在满足一定条件后,会自动上报到移动分析服务端。触发自动上报的条件由默认的埋点配置决定。新建应用后,您可以通过 初始化业务 功能,将默认的埋点配置同步到新应用埋点配置列表中。

如需初始化业务,单击页面上的 初始化业务 按钮,并确认即可。初始化成功后,您将看到默认的埋点配置列表。

重要

即使您未通过 初始化业务 功能将默认埋点配置同步到新应用的埋点配置列表中,默认的埋点配置仍然起作用,只不过不会在埋点配置列表中显示。

Mock

如上文所述,您可以通过页面操作新增并修改埋点配置,以此控制日志的上报策略。此外,控制台还允许您直接使用 JSON 进行埋点配置。但 不建议 您使用此功能,理由如下:

  • Mock 功能仅仅是埋点配置的一种简便方式,不提供更多的功能。

  • 假如您同时通过页面操作和 Mock 功能对同一业务埋点进行了配置,则 Mock 配置会优先生效。

  • 在不熟悉埋点配置格式时,您很难正确使用 Mock 功能。很可能会影响默认的日志自动上报。

新增 Mock 配置

新增 Mock 配置的步骤如下:

  1. 配置上传开关 页面,单击 新增 Mock 配置 按钮。

  2. 填写配置信息。

    • 版本:选择您应用的版本。

    • 平台:选择应用类型。

    • :JSON 类型的配置信息。具体参见下文的 Mock 配置格式。

  3. 信息确认无误后,单击 确定,完成 Mock 配置新增。

Mock 配置格式

Mock 配置格式如下:

{
                        "日志头1": {
                        "业务码1": {
                        "write": "yes",
                        "send": [
                        "wifi"
                        ],
                        "maxLogCount": 50,
                        "level": 3,
                        "uploadRate": 1000,
                        "event": [
                        "gotoBackground"
                        ]
                        },
                        "业务码2": {
                        ...
                        },
                        ...
                        },
                        "日志头2": {
                        ...
                        },
                        ...
                        }
  • 日志头:对应埋点配置中的日志头。

  • 业务码:对应埋点配置中的业务 code。

  • write:对应埋点配置中的上报开关。开关开启时值为 "yes",否则为 "no"

  • send:对应埋点配置中的网络。网络为 全网 时值为 ["2g", "3g", "4g", "wifi"]仅 Wi-Fi 时为 ["wifi"]

  • maxLogCount:对应埋点配置中的日志上报条数。

  • level:对应埋点配置中的最低上报等级。

  • uploadRate:对应埋点配置中的日志上报率。

  • event:对应埋点配置中的策略。选择压后台策略时值为 ["gotoBackground"],否则为 []