TelemetrySessionExtensions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A class to contain all data model extension methods to existing class TelemetrySession.
public ref class TelemetrySessionExtensions abstract sealedpublic static class TelemetrySessionExtensionstype TelemetrySessionExtensions = classPublic Module TelemetrySessionExtensions- Inheritance
-
TelemetrySessionExtensions
Methods
| PostAsset(TelemetrySession, String, String, Int32, IDictionary<String,Object>, TelemetryEventCorrelation[]) |
Post an Asset event. Asset is the target of user task or operation, e.g., Solution, Project, File, Extension, License, Designer. |
| 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, 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, 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) |
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, 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, 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>, 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. |
| PostOperation(TelemetrySession, String, TelemetryResult, String, TelemetryEventCorrelation[]) |
Post an Operation event. An operation performs some work in application and comes with result (e.g., Success, Failure). If the operation is invoked by user directly, please use UserTaskEvent or related methods. A few examples of operations are, license check, package load, windows layout loading. This method is used for atomic operation that runs very fast or has little value to analyze the process duration. Caller calls this method when operation is complete. For long-time running or async operation, in order to understand what else happened during the time or track if it partially completes because of an error, use method StartOperation(TelemetrySession, String) which tracks both start and end points. |
| PostUserTask(TelemetrySession, String, TelemetryResult, String, TelemetryEventCorrelation[]) |
Post an event for user task. A user task is an application operation that is INVOKED BY USER directly and comes with result (e.g., Success, Failure). It is used for user behavior/intent analysis. User is aware of the operation and be able to execute. e.g. Open project and Show tool windows are user tasks; instead load VS package and Design time build are operations. This method is used for atomic user task that runs very fast or has little value to analyze the process duration. Caller calls this method when user task is complete. For long-time running or async user task, in order to understand what else happened during the time or track if it partially completes because of an error, use method StartUserTask(TelemetrySession, String) which tracks both start and end points. |
| StartOperation(TelemetrySession, String) |
Start tracking operation by posting a OperationEvent at the begining of operation work, and return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another OperationEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |
| StartOperation(TelemetrySession, String, TelemetryScopeSettings) |
Start tracking operation by posting a OperationEvent with specified properties at the begining of operation work, and return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another OperationEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |
| StartOperation(TelemetrySession, String, TelemetrySeverity) |
Start tracking operation by posting a OperationEvent at the begining of operation work, and return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another OperationEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |
| StartOperation(TelemetrySession, String, TelemetrySeverity, IDictionary<String,Object>) |
Start tracking operation by posting a OperationEvent with specified properties at the begining of operation work, and return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another OperationEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |
| StartOperation(TelemetrySession, String, TelemetrySeverity, IDictionary<String,Object>, TelemetryEventCorrelation[]) |
Start tracking operation by posting a OperationEvent with specified properties at the begining of operation work, and return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another OperationEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |
| StartUserTask(TelemetrySession, String) |
Start tracking user task by posting a UserTaskEvent at the beginning of user task work, and then return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another UserTaskEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |
| StartUserTask(TelemetrySession, String, TelemetryScopeSettings) |
Start tracking user task by posting a UserTaskEvent with specified properties at the beginning of user task work, and then return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another UserTaskEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |
| StartUserTask(TelemetrySession, String, TelemetrySeverity) |
Start tracking user task by posting a UserTaskEvent at the beginning of user task work, and then return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another UserTaskEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |
| StartUserTask(TelemetrySession, String, TelemetrySeverity, IDictionary<String,Object>) |
Start tracking user task by posting a UserTaskEvent with specified properties at the beginning of user task work, and then return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another UserTaskEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |
| StartUserTask(TelemetrySession, String, TelemetrySeverity, IDictionary<String,Object>, TelemetryEventCorrelation[]) |
Start tracking user task by posting a UserTaskEvent with specified properties at the beginning of user task work, and then return a TelemetryScope<T> object. When the user task finishes, call method End(TelemetryResult, String) to post another UserTaskEvent for end point. Because the same event name is used by both start and end events, please don't use Start or End in event name. |