概念 - MIP SDK 中的日誌

對於使用 MIP SDK 的自訂應用程式進行故障排除,首先要檢查 MIP 日誌。 MIP 日誌位置會在建立 MipContext 時設定,並可用 *.miplog 檔案副檔名查詢。 Microsoft應用程式和範例會將 MIP 日誌儲存在應用程式路徑\APP_DATA\mip_data。

在 MIP 日誌中遮蔽敏感資料

若未經額外設定,MIP SDK 中的記錄不會遮罩可能可識別客戶個人身分的敏感內容。

MIP SDK 日誌中的常見敏感資料:

  • 電子郵件名稱
  • 檔案名稱
  • 唱片公司名稱
  • IP 位址
  • MAC 位址

若要遮蔽所有由 MIP SDK 產生的 miplog 檔案中的敏感內容,請在組 .json 檔中建立新欄位或在 MipConfiguration 中設定。

組態檔

設定檔是 MIP SDK 中自訂設定的推薦路徑,且可在所有支援平台上使用。 要在 MIP 日誌檔中遮蔽 PII,請使用以下方法。

  1. 建立一個由 MIP SDK 存取的設定檔,並以自訂設定 mip_config.json 方式存取,並將該檔案儲存在以下 MipConfiguration 路徑中。
mipConfiguration->GetPath()/mip
  1. 新增一個欄位 mip_config.json ,將該 AllowPii 欄位設為假。
{"MipLogger":{"MaxLogFilesSizeMb":40,"MaxLogFileCount":10,"AllowPii":false}}

一旦設定完成,敏感內容會在所有由 MIP SDK 產生的新 MIP 日誌中被遮蔽。

在 MipConfiguration 中配置

要用 MipConfiguration 遮蔽 MIP 日誌檔案中的 PII,請建立一個 MipConfiguration 新物件,並以自訂設定的新值傳遞進 MipContext 去。

此方法僅支援 C++ 與 C#。 建議使用 C API 或 Java 包裝器的開發者,改為建立設定檔。

auto mipConfiguration = make_shared<mip::MipConfiguration>(appInfo, "mip_data", mip::LogLevel::Trace, false);
    auto loggerConfiguration = make_shared<mip::LoggerConfiguration>();
    loggerConfiguration->isPiiAllowed = false;
    mipConfiguration->SetLoggerConfiguration(loggerConfiguration);
    auto mipContext = MipContext::Create(mipConfiguration);
MipConfiguration mipConfiguration = new MipConfiguration(appInfo, "mip_data", LogLevel.Trace, false);
  mipConfiguration.LoggerConfigurationOverride = new LoggerConfiguration(10, 40, false);
  var mipContext = MIP.CreateMipContext(mipConfiguration);