TelemetrySessionExtensions.PostFault Method

Definition

Namespace:

Microsoft.VisualStudio.Telemetry

Assembly:

Microsoft.VisualStudio.Telemetry.dll

Package:

Microsoft.VisualStudio.Telemetry v17.14.2

Overloads

PostFault(TelemetrySession, String, String)	Post a Fault event. The event will always be sent to AppInsights, but if it passes sampling, it gets posted to Wason as well. It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.
PostFault(TelemetrySession, String, String, FaultSeverity)	Post a Fault event. The event will always be sent to AppInsights, but if it passes sampling, it gets posted to Wason as well. It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.
PostFault(TelemetrySession, String, String, Exception)	Post a Fault Event with a managed Exception object. The bucket parameters are created from the exception object. It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.
PostFault(TelemetrySession, String, String, FaultSeverity, Exception)	Post a Fault Event with a managed Exception object. The bucket parameters are created from the exception object. It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.
PostFault(TelemetrySession, String, String, Exception, Func<IFaultUtility,Int32>)	Post a fault event with an exception object and a callback. The callback can be used to calculate expensive data to be sent to the Watson back end, such as JScript callstacks, etc It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.
PostFault(TelemetrySession, String, String, FaultSeverity, Exception, Func<IFaultUtility,Int32>)	Post a fault event with an exception object and a callback. The callback can be used to calculate expensive data to be sent to the Watson back end, such as JScript callstacks, etc It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.
PostFault(TelemetrySession, String, String, Exception, Func<IFaultUtility,Int32>, TelemetryEventCorrelation[])	Post a fault event with an exception object and a callback. The callback can be used to calculate expensive data to be sent to the Watson back end, such as JScript callstacks, etc It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.
PostFault(TelemetrySession, String, String, FaultSeverity, Exception, Func<IFaultUtility,Int32>, TelemetryEventCorrelation[])	Post a fault event with an exception object and a callback. The callback can be used to calculate expensive data to be sent to the Watson back end, such as JScript callstacks, etc It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.

PostFault(TelemetrySession, String, String)

Post a Fault event. The event will always be sent to AppInsights, but if it passes sampling, it gets posted to Wason as well. It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.

C++

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation PostFault(Microsoft::VisualStudio::Telemetry::TelemetrySession ^ telemetrySession, System::String ^ eventName, System::String ^ description);

Parameters

telemetrySession

TelemetrySession

eventName

String

An event name following data model schema. It requires that event name is a unique, not null or empty string. It consists of 3 parts and must follows pattern [product]/[featureName]/[entityName]. FeatureName could be a one-level feature or feature hierarchy delimited by "/". For examples, vs/platform/opensolution; vs/platform/editor/lightbulb/fixerror;

description

String

The desription is not put in a bucket parameter, but it is in the ErrorInformation.txt file in the Cab file sent to Watson, and in the AI event

Returns

TelemetryEventCorrelation

The fault event correlation.

PostFault(TelemetrySession, String, String, FaultSeverity)

Post a Fault event. The event will always be sent to AppInsights, but if it passes sampling, it gets posted to Wason as well. It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.

C++

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation PostFault(Microsoft::VisualStudio::Telemetry::TelemetrySession ^ telemetrySession, System::String ^ eventName, System::String ^ description, Microsoft::VisualStudio::Telemetry::FaultSeverity faultSeverity);

Parameters

telemetrySession

TelemetrySession

eventName

String

An event name following data model schema. It requires that event name is a unique, not null or empty string. It consists of 3 parts and must follows pattern [product]/[featureName]/[entityName]. FeatureName could be a one-level feature or feature hierarchy delimited by "/". For examples, vs/platform/opensolution; vs/platform/editor/lightbulb/fixerror;

description

String

The desription is not put in a bucket parameter, but it is in the ErrorInformation.txt file in the Cab file sent to Watson, and in the AI event

faultSeverity

FaultSeverity

The severity of the fault, used to identify actionable or important faults in divisional tools and reporting.

Returns

TelemetryEventCorrelation

The fault event correlation.

PostFault(TelemetrySession, String, String, Exception)

Post a Fault Event with a managed Exception object. The bucket parameters are created from the exception object. It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.

C++

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation PostFault(Microsoft::VisualStudio::Telemetry::TelemetrySession ^ telemetrySession, System::String ^ eventName, System::String ^ description, Exception ^ exceptionObject);

Parameters

telemetrySession

TelemetrySession

eventName

String

An event name following data model schema. It requires that event name is a unique, not null or empty string. It consists of 3 parts and must follows pattern [product]/[featureName]/[entityName]. FeatureName could be a one-level feature or feature hierarchy delimited by "/". For examples, vs/platform/opensolution; vs/platform/editor/lightbulb/fixerror;

description

String

exceptionObject

Exception

Returns

TelemetryEventCorrelation

The fault event correlation.

PostFault(TelemetrySession, String, String, FaultSeverity, Exception)

Post a Fault Event with a managed Exception object. The bucket parameters are created from the exception object. It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.

C++

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation PostFault(Microsoft::VisualStudio::Telemetry::TelemetrySession ^ telemetrySession, System::String ^ eventName, System::String ^ description, Microsoft::VisualStudio::Telemetry::FaultSeverity faultSeverity, Exception ^ exceptionObject);

Parameters

telemetrySession

TelemetrySession

eventName

String

An event name following data model schema. It requires that event name is a unique, not null or empty string. It consists of 3 parts and must follows pattern [product]/[featureName]/[entityName]. FeatureName could be a one-level feature or feature hierarchy delimited by "/". For examples, vs/platform/opensolution; vs/platform/editor/lightbulb/fixerror;

description

String

faultSeverity

FaultSeverity

The severity of the fault, used to identify actionable or important faults in divisional tools and reporting.

exceptionObject

Exception

Returns

TelemetryEventCorrelation

The fault event correlation.

PostFault(TelemetrySession, String, String, Exception, Func<IFaultUtility,Int32>)

Post a fault event with an exception object and a callback. The callback can be used to calculate expensive data to be sent to the Watson back end, such as JScript callstacks, etc It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.

C++

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation PostFault(Microsoft::VisualStudio::Telemetry::TelemetrySession ^ telemetrySession, System::String ^ eventName, System::String ^ description, Exception ^ exceptionObject, Func<Microsoft::VisualStudio::Telemetry::IFaultUtility ^, int> ^ gatherEventDetails);

Parameters

telemetrySession

TelemetrySession

eventName

String

An event name following data model schema. It requires that event name is a unique, not null or empty string. It consists of 3 parts and must follows pattern [product]/[featureName]/[entityName]. FeatureName could be a one-level feature or feature hierarchy delimited by "/". For examples, vs/platform/opensolution; vs/platform/editor/lightbulb/fixerror;

description

String

exceptionObject

Exception

can be null

gatherEventDetails

Func<IFaultUtility,Int32>

Allows the user to provide code to execute synchronously to gather computationally expensive info about the event

Returns

TelemetryEventCorrelation

The fault correlation.

PostFault(TelemetrySession, String, String, FaultSeverity, Exception, Func<IFaultUtility,Int32>)

Post a fault event with an exception object and a callback. The callback can be used to calculate expensive data to be sent to the Watson back end, such as JScript callstacks, etc It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.

C++

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation PostFault(Microsoft::VisualStudio::Telemetry::TelemetrySession ^ telemetrySession, System::String ^ eventName, System::String ^ description, Microsoft::VisualStudio::Telemetry::FaultSeverity faultSeverity, Exception ^ exceptionObject, Func<Microsoft::VisualStudio::Telemetry::IFaultUtility ^, int> ^ gatherEventDetails);

Parameters

telemetrySession

TelemetrySession

eventName

String

An event name following data model schema. It requires that event name is a unique, not null or empty string. It consists of 3 parts and must follows pattern [product]/[featureName]/[entityName]. FeatureName could be a one-level feature or feature hierarchy delimited by "/". For examples, vs/platform/opensolution; vs/platform/editor/lightbulb/fixerror;

description

String

faultSeverity

FaultSeverity

The severity of the fault, used to identify actionable or important faults in divisional tools and reporting.

exceptionObject

Exception

can be null

gatherEventDetails

Func<IFaultUtility,Int32>

Allows the user to provide code to execute synchronously to gather computationally expensive info about the event

Returns

TelemetryEventCorrelation

The fault correlation.

PostFault(TelemetrySession, String, String, Exception, Func<IFaultUtility,Int32>, TelemetryEventCorrelation[])

Post a fault event with an exception object and a callback. The callback can be used to calculate expensive data to be sent to the Watson back end, such as JScript callstacks, etc It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.

C++

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation PostFault(Microsoft::VisualStudio::Telemetry::TelemetrySession ^ telemetrySession, System::String ^ eventName, System::String ^ description, Exception ^ exceptionObject, Func<Microsoft::VisualStudio::Telemetry::IFaultUtility ^, int> ^ gatherEventDetails, cli::array <Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation> ^ correlatedWith);

Parameters

telemetrySession

TelemetrySession

eventName

String

An event name following data model schema. It requires that event name is a unique, not null or empty string. It consists of 3 parts and must follows pattern [product]/[featureName]/[entityName]. FeatureName could be a one-level feature or feature hierarchy delimited by "/". For examples, vs/platform/opensolution; vs/platform/editor/lightbulb/fixerror;

description

String

exceptionObject

Exception

can be null

gatherEventDetails

Func<IFaultUtility,Int32>

Allows the user to provide code to execute synchronously to gather computationally expensive info about the event

correlatedWith

TelemetryEventCorrelation[]

Specify which events to correlate by using property Correlation Good candidates to correlate with FaultEvent are, UserTaskEventOperationEvent

Returns

TelemetryEventCorrelation

The fault correlation.

PostFault(TelemetrySession, String, String, FaultSeverity, Exception, Func<IFaultUtility,Int32>, TelemetryEventCorrelation[])

Post a fault event with an exception object and a callback. The callback can be used to calculate expensive data to be sent to the Watson back end, such as JScript callstacks, etc It becomes more useful when correlated with UserTaskEvent or OperationEvent which may have led to the fault occurence.

C++

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation PostFault(Microsoft::VisualStudio::Telemetry::TelemetrySession ^ telemetrySession, System::String ^ eventName, System::String ^ description, Microsoft::VisualStudio::Telemetry::FaultSeverity faultSeverity, Exception ^ exceptionObject, Func<Microsoft::VisualStudio::Telemetry::IFaultUtility ^, int> ^ gatherEventDetails, cli::array <Microsoft::VisualStudio::Telemetry::TelemetryEventCorrelation> ^ correlatedWith);

Parameters

telemetrySession

TelemetrySession

eventName

String

An event name following data model schema. It requires that event name is a unique, not null or empty string. It consists of 3 parts and must follows pattern [product]/[featureName]/[entityName]. FeatureName could be a one-level feature or feature hierarchy delimited by "/". For examples, vs/platform/opensolution; vs/platform/editor/lightbulb/fixerror;

description

String

faultSeverity

FaultSeverity

The severity of the fault, used to identify actionable or important faults in divisional tools and reporting.

exceptionObject

Exception

can be null

gatherEventDetails

Func<IFaultUtility,Int32>

Allows the user to provide code to execute synchronously to gather computationally expensive info about the event

correlatedWith

TelemetryEventCorrelation[]

Specify which events to correlate by using property Correlation Good candidates to correlate with FaultEvent are, UserTaskEventOperationEvent

Returns

TelemetryEventCorrelation

The fault correlation.