Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
DiagnosticConfiguration Struct Reference

Custom diagnostic configurations (not commonly used) More...

#include <diagnostic_configuration.h>

Public Attributes

std::string hostNameOverride
 
std::string libraryNameOverride
 
std::shared_ptr< HttpDelegatehttpDelegateOverride
 
std::shared_ptr< TaskDispatcherDelegatetaskDispatcherDelegateOverride
 
bool isNetworkDetectionEnabled {true}
 
bool isLocalCachingEnabled {true}
 
bool isTraceLoggingEnabled {false}
 
bool isMinimalTelemetryEnabled {false}
 
bool isFastShutdownEnabled {false}
 
std::map< std::string, std::string > customSettings
 
std::map< std::string, std::vector< std::string > > maskedProperties
 
std::shared_ptr< AuditDelegateauditPipelineDelegateOverride
 
std::shared_ptr< TelemetryDelegatetelemetryPipelineDelegateOverride
 
Cloud cloud {Cloud::Unknown}
 
DataBoundary dataBoundary {DataBoundary::Default}
 
bool isAuditPriorityEnhanced {false}
 
int maxTeardownTimeSec {2}
 
bool isMaxTeardownTimeEnabled {false}
 

Detailed Description

Custom diagnostic configurations (not commonly used)

Member Data Documentation

◆ auditPipelineDelegateOverride

std::shared_ptr<AuditDelegate> DiagnosticConfiguration::auditPipelineDelegateOverride

Audit delegate override for writting audit events

◆ cloud

Cloud DiagnosticConfiguration::cloud {Cloud::Unknown}

Cloud type for controlling telemetry and audit events for sovereign cloud scenario

◆ customSettings

std::map<std::string, std::string> DiagnosticConfiguration::customSettings

Custom audit/telemetry settings >

◆ dataBoundary

DataBoundary DiagnosticConfiguration::dataBoundary {DataBoundary::Default}

Default regional boundary that defines where telemetry and audit events are stored.

◆ hostNameOverride

std::string DiagnosticConfiguration::hostNameOverride

Host audit/telemetry instance name. If not set, MIP will act as its own host.

◆ httpDelegateOverride

std::shared_ptr<HttpDelegate> DiagnosticConfiguration::httpDelegateOverride

If set, HTTP handling will be managed by this instance If set, async task handling will be managed by this instance, taskDispatcherDelegateOverides should not be shared as they can hold audit/telemetry objects, and prevent their release until taskDispatcher is freed

◆ isAuditPriorityEnhanced

bool DiagnosticConfiguration::isAuditPriorityEnhanced {false}

If set, Audit events will be uploaded immediately upon logging in default audit pipeline of MIP SDK

◆ isFastShutdownEnabled

bool DiagnosticConfiguration::isFastShutdownEnabled {false}

If set, No events will be uploaded on shutdown, Audit events will be uploaded immediately upon logging

◆ isLocalCachingEnabled

bool DiagnosticConfiguration::isLocalCachingEnabled {true}

If set, audit/telemetry component will use on-disk caching If set, audit/telemetry component will write warning/error logs to disk. These files can grow to be very large, and may require manual cleanup from the host application

◆ isMaxTeardownTimeEnabled

bool DiagnosticConfiguration::isMaxTeardownTimeEnabled {false}

◆ isMinimalTelemetryEnabled

bool DiagnosticConfiguration::isMinimalTelemetryEnabled {false}

If set, only necessary service data telemetry will be sent

◆ isNetworkDetectionEnabled

bool DiagnosticConfiguration::isNetworkDetectionEnabled {true}

If set, audit/telemetry component will ping network status on background thread

◆ isTraceLoggingEnabled

bool DiagnosticConfiguration::isTraceLoggingEnabled {false}

◆ libraryNameOverride

std::string DiagnosticConfiguration::libraryNameOverride

Alternate audit/telemetry library (DLL) filename.

◆ maskedProperties

std::map<std::string, std::vector<std::string> > DiagnosticConfiguration::maskedProperties

Audit/Telemetry events/properties which should be masked

◆ maxTeardownTimeSec

int DiagnosticConfiguration::maxTeardownTimeSec {2}

If set, Shutdown will take this much time, Audit & Telemetry events will be uploaded on shutdown. Value must be >= 2.

◆ taskDispatcherDelegateOverride

std::shared_ptr<TaskDispatcherDelegate> DiagnosticConfiguration::taskDispatcherDelegateOverride

◆ telemetryPipelineDelegateOverride

std::shared_ptr<TelemetryDelegate> DiagnosticConfiguration::telemetryPipelineDelegateOverride

Telemetry delegate override for writting telemetry events


The documentation for this struct was generated from the following file: