全部產品
Search
文件中心

Mobile Platform as a Service:配置日誌上報開關

更新時間:Jul 13, 2024

開關配置功能指通過服務端下發的開關值,修改日誌自動上報的觸發條件,對日誌上報進行動態控制。

移動分析依賴用戶端 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"],否則為 []