Shell.Diagnostics.js
Applies To: Windows Azure Pack
Logs various kinds of telemetry information as well as exceptions and error messages to the server.
Widgets
None.
Enums
Name |
Fields |
|---|---|
Shell.Diagnostics.LogEntryLevel |
error: error warning: warning information: information verbose: verbose |
Properties
None.
Methods
Name |
Description |
Returns |
Parameters |
|---|---|---|---|
Shell.Diagnostics.Telemetry.clientAction |
Logs telemetry information for an action. |
Nothing |
action (String): The action performed. scenarioCorrelationId (String): The scenario correlation id. selectedEntity (String): The selected entity. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Telemetry.clientScenario |
Logs telemetry information for a scenario. |
Nothing |
scenarioCorrelationId (String): The scenario correlation id. scenarioName (String): The name of the scenario. entityType (String): The type of the entity. completionReason (String): The completion reason. userSeconds (Number): The userSeconds. endToEndSeconds (Number): Number of seconds end to end for the scenario. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Telemetry.customEvent |
Logs telemetry information for a custom event. |
Nothing |
eventKey (String): Globally unique string that identifies callsite of logging message. customEventType (String): The custom event type. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Log.error |
Logs an error message. |
Nothing |
eventKey (String): Globally unique string that identifies the call site of logging message. message (String): The error message. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Log.exception |
Logs an exception. |
Nothing |
isHandledException (Boolean): Whether the exception was handled or not. type (String): The type of exception. stackTrace (String): A stack trace for the exception. stringRepresentation (String): A string representation of the error. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Telemetry.feedbackInfo |
Logs a feedback survey data. |
Nothing |
comments (String): Comments from the user. data (Object): Additional data to be logged on the server. Not used. Left in place for uniformity with other methods of this kind. |
Shell.Diagnostics.Telemetry.getNewTimer |
Gets an instance of a Timer that logs performance data. |
Timer |
key (String): Globally unique string that identifies callsite of logging message. |
Shell.Diagnostics.Log.info |
Logs an informational message. |
Nothing |
eventKey (String): Globally unique string that identifies callsite of logging message. message (String): The informational message. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Telemetry.performance |
Logs a performance message. |
Nothing |
key (String): Globally unique string that identifies the call site of logging message. time (Number): Time taken in seconds. message (String): A message to be associated with the performance data. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Telemetry.startup |
Logs telemetry information about startup. |
Nothing |
secondsDuration (Number): Number of seconds for startup to complete. successfulDownloadCount (Number): Number of successful downloads. failedDownloadCount (Number): Number of failed downloads. failedDownloadSummary (String): A summary of the failed downloads. downloadMetricsSummary (String): A summary of the download metrics. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Telemetry.timerStart |
Starts a timer tied to the given key. |
Nothing |
key (String): Globally unique string that identifies the call site of logging message. |
Shell.Diagnostics.Telemetry.timerStopAndLog |
Stops a timer started with the timerStart method and logs the information. |
Nothing |
key (String): Globally unique string that identifies the call site of logging message. message (String): A message to be included with the timing information. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Telemetry.traceEvent |
Logs telemetry information for an event. |
Nothing |
source (String): Source of the event. extension (String): Extension associated with the event. action (String): The event action. context (String): Additional data to be logged on the server. Should only be used in cases where all other parameters are not able to uniquely identify an event. |
Shell.Diagnostics.Telemetry.traceNavigation |
Logs telemetry information for a browser navigation event. |
Nothing |
|
Shell.Diagnostics.Log.verbose |
Logs a verbose message. |
Nothing |
eventKey (String): Globally unique string that identifies the call site of logging message. message (String): The verbose message. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Telemetry.viewSwitch |
Logs telemetry information for a view switch. |
Nothing |
fromView (String): The origin view of the switch. toView (String): The destination view of the switch. totalSeconds (Number): The number of seconds taken by the view switch. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Log.warning |
Logs a warning message. |
Nothing |
eventKey (String): Globally unique string that identifies the call site of logging message. message (String): The warning message. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|
Shell.Diagnostics.Log.writeEntry |
Logs a message with the given severity. |
Nothing |
eventKey (String): Globally unique string that identifies the call site of logging message. entry (String): Message to log. severity (Shell.Diagnostics.LogEntryLevel): The severity of the message. data (Object): Additional data to be logged on the server. Each key/value pair passed in via this object is logged. Columns are reserved for the following keys which should be included if available:
|