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

#include <src/api/mip/diagnostic_configuration.h>

Collaboration diagram for DiagnosticConfiguration:

Public Attributes
std::shared_ptr< AuditDelegate >	auditPipelineDelegateOverride
	Audit delegate override for writting audit events.

Cloud	cloud {Cloud::Unknown}
	Cloud type for controlling telemetry and audit events for sovereign cloud scenario.

std::map< std::string, std::string >	customSettings
	Custom audit/telemetry settings >

DataBoundary	dataBoundary {DataBoundary::Default}
	Default regional boundary that defines where telemetry and audit events are stored.

std::string	hostNameOverride
	Host audit/telemetry instance name.

std::shared_ptr< HttpDelegate >	httpDelegateOverride
	If set, HTTP handling will be managed by this instance.

bool	isAuditPriorityEnhanced {false}
	If set, Audit events will be uploaded immediately upon logging in default audit pipeline of MIP SDK.

bool	isFastShutdownEnabled {false}
	If set, No events will be uploaded on shutdown, Audit events will be uploaded immediately upon logging.

bool	isLocalCachingEnabled {true}
	If set, audit/telemetry component will use on-disk caching.

bool	isMaxTeardownTimeEnabled {false}

bool	isMinimalTelemetryEnabled {false}
	If set, only necessary service data telemetry will be sent.

bool	isNetworkDetectionEnabled {true}
	If set, audit/telemetry component will ping network status on background thread.

bool	isTraceLoggingEnabled {false}

std::string	libraryNameOverride
	Alternate audit/telemetry library (DLL) filename.

std::map< std::string, std::vector< std::string > >	maskedProperties
	Audit/Telemetry events/properties which should be masked.

int	maxTeardownTimeSec {2}
	If set, Shutdown will take this much time, Audit & Telemetry events will be uploaded on shutdown.

std::shared_ptr< TaskDispatcherDelegate >	taskDispatcherDelegateOverride

std::shared_ptr< TelemetryDelegate >	telemetryPipelineDelegateOverride
	Telemetry delegate override for writting telemetry events.

Detailed Description

Custom diagnostic configurations (not commonly used)

Definition at line 52 of file diagnostic_configuration.h.

Member Data Documentation

◆ auditPipelineDelegateOverride

std::shared_ptr<AuditDelegate> DiagnosticConfiguration::auditPipelineDelegateOverride

Audit delegate override for writting audit events.

Definition at line 68 of file diagnostic_configuration.h.

◆ cloud

Cloud DiagnosticConfiguration::cloud {Cloud::Unknown}

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

Definition at line 70 of file diagnostic_configuration.h.

70{Cloud::Unknown}; /**< Cloud type for controlling telemetry and audit events for sovereign cloud scenario */

Cloud::Unknown

@ Unknown

Cloud not specified or URL not recognized as an Azure cloud.

◆ customSettings

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

Custom audit/telemetry settings >

Definition at line 66 of file diagnostic_configuration.h.

◆ dataBoundary

DataBoundary DiagnosticConfiguration::dataBoundary {DataBoundary::Default}

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

Definition at line 71 of file diagnostic_configuration.h.

71{DataBoundary::Default}; /**< Default regional boundary that defines where telemetry and audit events are stored. */

DataBoundary::Default

@ Default

Region is not specified.

◆ hostNameOverride

std::string DiagnosticConfiguration::hostNameOverride

Host audit/telemetry instance name.

If not set, MIP will act as its own host.

Definition at line 53 of file diagnostic_configuration.h.

◆ 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

Definition at line 55 of file diagnostic_configuration.h.

◆ isAuditPriorityEnhanced

bool DiagnosticConfiguration::isAuditPriorityEnhanced {false}

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

Definition at line 72 of file diagnostic_configuration.h.

72{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.

Definition at line 65 of file diagnostic_configuration.h.

65{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

Definition at line 60 of file diagnostic_configuration.h.

60{true}; /**< If set, audit/telemetry component will use on-disk caching */

◆ isMaxTeardownTimeEnabled

bool DiagnosticConfiguration::isMaxTeardownTimeEnabled {false}

Definition at line 74 of file diagnostic_configuration.h.

74{false}; /**If set, Shutdown will take *maxTeardownTimeSec* time, Audit & Telemetry events will be uploaded on shutdown.*/

◆ isMinimalTelemetryEnabled

bool DiagnosticConfiguration::isMinimalTelemetryEnabled {false}

If set, only necessary service data telemetry will be sent.

Definition at line 64 of file diagnostic_configuration.h.

64{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.

Definition at line 59 of file diagnostic_configuration.h.

59{true}; /**< If set, audit/telemetry component will ping network status on background thread */

◆ isTraceLoggingEnabled

bool DiagnosticConfiguration::isTraceLoggingEnabled {false}

Definition at line 63 of file diagnostic_configuration.h.

63{false};

◆ libraryNameOverride

std::string DiagnosticConfiguration::libraryNameOverride

Alternate audit/telemetry library (DLL) filename.

Definition at line 54 of file diagnostic_configuration.h.

◆ maskedProperties

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

Audit/Telemetry events/properties which should be masked.

Definition at line 67 of file diagnostic_configuration.h.

◆ 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.

Definition at line 73 of file diagnostic_configuration.h.

73{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

Definition at line 58 of file diagnostic_configuration.h.

◆ telemetryPipelineDelegateOverride

std::shared_ptr<TelemetryDelegate> DiagnosticConfiguration::telemetryPipelineDelegateOverride

Telemetry delegate override for writting telemetry events.

Definition at line 69 of file diagnostic_configuration.h.

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

src/api/mip/diagnostic_configuration.h

Public Attributes