通过

概念 - 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_config.json 的自定义设置创建 MIP SDK 可访问的配置文件，并将该文件存储在以下 MipConfiguration 路径中。
mipConfiguration->GetPath()/mip
  1. 添加新字段以 mip_config.json 将 AllowPii 字段设置为 false。
{"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);