Концепция. Ведение журнала в пакете SDK MIP

  • Статья

Устранение неполадок с пользовательскими приложениями, используюющими пакет SDK MIP, начинается с проверки журналов MIP. Расположение журнала MIP настраивается при создании MipContext и может запрашиваться с расширением *.miplog. Приложения и примеры Майкрософт хранят журналы MIP по пути приложения\APP_DATA\mip_data.

Маскирование конфиденциальных данных в журналах MIP

Журналы в пакете SDK MIP не маскируют конфиденциальное содержимое, которое может быть лично идентифицировано клиенту без дополнительной настройки.

Общие конфиденциальные данные в журналах пакета SDK для MIP:

  • Имена электронной почты
  • Имена файлов
  • Имена меток
  • IP-адреса
  • MAC-адреса

Чтобы маскировать конфиденциальное содержимое во всех файлах miplog, созданных пакетом SDK MIP, создайте новое поле в файле конфигурации .json или настройте в MipConfiguration.

Файл конфигурации

Файлы конфигурации — это рекомендуемый путь для настройки пользовательских параметров в пакете SDK MIP и доступен на всех поддерживаемых платформах. Чтобы маскировать личные данные в файлах журнала MIP, используйте следующий метод.

  1. Создайте файл конфигурации, доступный пакетом SDK MIP для пользовательских параметров, и mip_config.json сохраните файл в следующем пути MipConfiguration .
mipConfiguration->GetPath()/mip
  1. Добавьте новое поле, чтобы mip_config.json задать AllowPii поле false.
{"MipLogger":{"MaxLogFilesSizeMb":40,"MaxLogFileCount":10,"AllowPii":false}}

После настройки конфиденциальное содержимое маскируется во всех новых журналах MIP, созданных пакетом SDK MIP.

Настройка в MipConfiguration

Чтобы маскировать PII в файлах журнала MIP с помощью MipConfiguration, создайте новый MipConfiguration объект для передачи MipContext с новыми значениями для пользовательских параметров.

Этот метод поддерживается только для C++ и C#. Разработчикам, использующим API C или оболочки 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);