Microsoft Information Protection SDK - Diagnostic Configuration

2025-04-10

Diagnostic Data

By default, the Microsoft Information Protection SDK sends diagnostic data to Microsoft. This data is useful for troubleshooting bugs, quality, and performance issues across the SDK install base that we may not capture in our internal testing. When implementing your application with the SDK, it's important to give users and admins the ability to opt out of sending diagnostic data if required.

Diagnostic Configuration

Diagnostic options in the MIP SDK can be controlled via DiagnosticConfiguration. Create an instance of this class, then set isMinimalTelemetryEnabled to true. Provide the object of class DiagnosticConfiguration to the function used to create MipContext.

Minimum Diagnostic Events

When diagnostic configuration is set to minimum, a minimum set of data is sent to Microsoft. All personally identifiable information is scrubbed from this information. This data includes heartbeat information to understand that the SDK is being used, and system metadata. No user content or end user identifiable information is set to the service.

Review the tables below to see exactly what events and data are sent with minimum diagnostics enabled.

Event: Heartbeat

Name	Description	Scrubbed
App.ApplicationId	The application identifier provided via mip::ApplicationInfo.	No
App.ApplicationName	The application name provided via mip::ApplicationInfo.	No
App.ApplicationVersion	The application version provided via mip::ApplicationInfo.	No
ApplicationId	The application version provided via mip::ApplicationInfo.	No
ApplicationName	The application name provided via mip::ApplicationInfo.	No
CreationTime	Time event was generated.	No
DefaultLabel.Id	Tenant default label ID.	No
Engine.TenantId	Home tenant GUID of the authenticated user.	No
Engine.UserObjectId	User object ID in Microsoft Entra ID.	No
Event.CorrelationId	Generated unique ID associated with object that triggered the event.	No
Event.CorrelationIdDescription	C++ class name of object that triggered the event.	No
Event.ParentCorrelationId	Parent event correlation ID.	No
Event.ParentCorrelationIdDescription	Generated Unique ID associated with the parent of the object that triggered the event.	No
Event.UniqueId	Generated unique ID assigned to the event.	No
MachineName	Name of the system that generated the event.	Yes
MIP.Version	Version of the MIP SDK.	No
Operation	Heartbeat	No
OrganizationId	Home tenant GUID of the authenticated user.	No
Platform	Operating system version.	No
ProcessName	Name of the process using the SDK.	No
ProductVersion	Same as “App.ApplicationVersion”.	No
SDKVersion	Same as MIP.Version.	No
UserId	Email address of the user.	Yes
UserObjectId	Microsoft Entra object ID of the user.	No
Version	Audit version schema (“1.1”).	No

Event: Discovery

Name	Description	Scrubbed
ActionId	Unique action ID for this event, used for event correlation.	No
App.ApplicationId	The application identifier provided via mip::ApplicationInfo.	No
App.ApplicationName	The application name provided via mip::ApplicationInfo.	No
App.ApplicationVersion	The application version provided via mip::ApplicationInfo.	No
ApplicationId	The application version provided via mip::ApplicationInfo.	No
ApplicationName	The application name provided via mip::ApplicationInfo.	No
CreationTime	Time event was generated.	No
DataState	The state of the data as the application acts on it “REST”, “MOTION”, “USE”.	No
DefaultLabel.Id	Tenant default label identifier.	No
Engine.TenantId	Home tenant GUID of the authenticated user.	No
Engine.UserObjectId	User object identifier in Microsoft Entra ID.	No
Event.CorrelationId	Generated unique ID associated with object that triggered the event.	No
Event.CorrelationIdDescription	C++ class name of object that triggered the event.	No
Event.ParentCorrelationId	Parent event correlation ID.	No
Event.ParentCorrelationIdDescription	Generated Unique ID associated with the parent of the object that triggered the event.	No
Event.UniqueId	Generated unique ID assigned to the event.	No
LabelId	Content label identifier on the opened file or data.	No
MachineName	Name of the system that generated the event.	Yes
MIP.Version	Version of the MIP SDK.	No
ObjectId	File path/description of the file or data.	Yes
Operation	"Discovery".	No
OrganizationId	Home tenant GUID of the authenticated user.	No
Platform	Operating system version.	No
ProcessName	Name of the process using the SDK.	No
Protected	Bool indicating if the file is protected or not.	No
Protection	The protection template identifier.	Yes
ProtectionOwner	Email address of the protection owner.	Yes
SDKVersion	Same as MIP.Version.	No
UserId	Email address of the user.	Yes
UserObjectId	Microsoft Entra object ID of the user.	No
Version	Audit version schema (“1.1”).	No

Event: Label Change

Name	Description	Scrubbed
ActionId	Unique action ID for this event, used for event correlation.	No
ActionIdBefore	Previous action ID. Used to chain to new action ID.	No
ActionSource	Value of MIP::ActionSource.	No
App.ApplicationId	The application ID provided via mip::ApplicationInfo.	No
App.ApplicationName	The application name provided via mip::ApplicationInfo.	No
App.ApplicationVersion	The application version provided via mip::ApplicationInfo.	No
ApplicationId	The application ID provided via mip::ApplicationInfo.	No
ApplicationName	The application name provided via mip::ApplicationInfo.	No
CreationTime	Time the event was generated.	No
DataState	The state of the data as the application acts on it “REST”, “MOTION”, “USE”.	No
DefaultLabel.Id	Tenant default label identifier.	No
Engine.TenantId	Home tenant GUID of the authenticated user.	No
Engine.UserObjectId	User object identifier in Microsoft Entra ID.	No
Event.CorrelationId	Generated unique ID associated with object that triggered the event.	No
Event.CorrelationIdDescription	C++ class name of object that triggered the event.	No
Event.ParentCorrelationId	Parent event correlation ID.	No
Event.ParentCorrelationIdDescription	Generated Unique ID associated with the parent of the object that triggered the event.	No
Event.UniqueId	Generated unique ID assigned to the event.	No
IsLabelChanged	Bool indicating if the label changed.	No
IsProtectionChanged	Bool indicating if protection changed.	No
LabelId	Label ID that is to be applied to the file or data.	No
LabelIdBefore	Previous label ID that was on the file or data.	No
MachineName	Name of the system that generated the event.	Yes
MIP.Version	Version of the MIP SDK.	No
ObjectId	File path/description of the file or data.	Yes
Operation	"Change".	No
OrganizationId	Home tenant GUID of the authenticated user.	No
Platform	Operating system version.	No
ProcessName	Name of the process using the SDK.	No
Product Version		No
Protected	Bool indicating if the file is protected or not.	No
Protected Before	Bool indicating if the file was previously protected or not.	No
Protection	The protection template identifier.	No
Protection Before	The previous protection template identifier.	No
ProtectionContentId	The new content identifier (GUID).	No
ProtectionContentIdBefore	The previous content identifier (GUID).	No
ProtectionOwner	Email address of the protection owner.	Yes
ProtectionOwnerBefore	Previous email address of the protection owner.	Yes
SDKVersion	Same as MIP.Version.	No
UserId	Email address of the user.	Yes
UserObjectId	Microsoft Entra object ID of the user.	No
Version	Audit version schema (“1.1”).	No

Opting out in C++

To set diagnostics to minimum only, create a shared pointer of mip::DiagnosticConfiguration() and set isMinimalTelemetryEnabled to true. Pass the object to MipConfiguration::SetDiagnosticConfiguration() then use the MipConfiguration to generate MipContext.

auto diagnosticConfig = std::make_shared<mip::DiagnosticConfiguration>();
diagnosticConfig->isMinimalTelemetryEnabled = true;
					   
// Create MipConfiguration. 
// Initialize MipConfiguration.
std::shared_ptr<mip::MipConfiguration> mipConfiguration = std::make_shared<mip::MipConfiguration>(mAppInfo,
                                                                                                 "file_sample",
				                                                                                 mip::LogLevel::Trace,
				                                                                                 false);

// Set DiagnosticConfig
mipConfiguration->SetDiagnosticConfiguration(diagnosticConfig);

mMipContext = mip::MipContext::Create(mipConfiguration);

Opting out in .NET

To set diagnostic data to minimum only, create a DiagnosticConfiguration() object and set isMinimalTelemetryEnabled to true. Set the DiagnosticOverride property on MipConfiguration then create the MipContext.

DiagnosticConfiguration diagnosticConfiguration = new DiagnosticConfiguration();
diagnosticConfiguration.IsMinimalTelemetryEnabled = true;

// Create MipConfiguration.
MipConfiguration mipConfiguration = new MipConfiguration(appInfo, "mip_data", LogLevel.Trace, false);

// Set Diagnostic Override.
mipConfiguration.DiagnosticOverride = diagnosticConfiguration;

// Create MipContext.
MipContext mipContext = MIP.CreateMipContext(mipConfiguration);