C# Class Dev2.Instrumentation.Tracker

Tracks feature and event usage.

Mostra file Open project: Warewolf-ESB/Warewolf

Public Methods

Method	Description
StartServer ( ) : void	This signals that Server has started. This should be placed before calling any other Tracker method.
StartStudio ( ) : void	This signals that Studio has started. This should be placed before calling any other Tracker method.
Stop ( ) : void	This method should be called when your application is exiting. It will signal Tracker to log the event and to attempt to Sync with the Servers. After calling this Method, Tracker.Start must be called again to start using Tracker.
TrackEvent ( TrackerEventGroup eventGroup, TrackerEventName eventName, string eventValue = null ) : void	Track events being used from within your application
TrackEvent ( TrackerEventGroup eventGroup, string customText, string eventValue = "" ) : void	Track events being used from within your application
TrackException ( string className, string methodName, Exception ex ) : void	Tracks and logs exceptions from within your code.

Private Methods

Method	Description
Perform ( Func action, bool async = false ) : void
Start ( string productId, string callHomeUrl ) : void
WriteError ( GenericReturn result ) : void

Method Details

StartServer() public static method

This signals that Server has started. This should be placed before calling any other Tracker method.

public static StartServer ( ) : void
return	void

StartStudio() public static method

This signals that Studio has started. This should be placed before calling any other Tracker method.

public static StartStudio ( ) : void
return	void

Stop() public static method

This method should be called when your application is exiting. It will signal Tracker to log the event and to attempt to Sync with the Servers. After calling this Method, Tracker.Start must be called again to start using Tracker.

public static Stop ( ) : void
return	void

TrackEvent() public static method

Track events being used from within your application

public static TrackEvent ( TrackerEventGroup eventGroup, TrackerEventName eventName, string eventValue = null ) : void
eventGroup	TrackerEventGroup	The text by which to group your event. If the length of this string and the 'eventName' parameter is greater than 40 it will be truncated. Also ';' (semicolons) and '\|' (pipeline) are not to be used inside this parameter.
eventName	TrackerEventName	The text used to describe the feature. If the length of this string and the 'eventGroup' parameter is greater than 40 it will be truncated. Also ';' (semicolons) and '\|' (pipeline) are not to be used inside this parameter.
eventValue	string	An optional value which is related to your event and you would like to store.
return	void

TrackEvent() public static method

Track events being used from within your application

public static TrackEvent ( TrackerEventGroup eventGroup, string customText, string eventValue = "" ) : void
eventGroup	TrackerEventGroup	The text by which to group your event. If the length of this string and the 'eventName' parameter is greater than 40 it will be truncated. Also ';' (semicolons) and '\|' (pipeline) are not to be used inside this parameter.
customText	string	The text used to describe the feature. If the length of this string and the 'eventGroup' parameter is greater than 40 it will be truncated. Also ';' (semicolons) and '\|' (pipeline) are not to be used inside this parameter.
eventValue	string	An optional value which is related to your event and you would like to store.
return	void

TrackException() public static method

Tracks and logs exceptions from within your code.

public static TrackException ( string className, string methodName, Exception ex ) : void
className	string	The class name from which the error originated. If the length of the string is greater than 50 it will be truncated.
methodName	string	The method name from which the error originated. If the length of the string is greater than 50 it will be truncated.
ex	System.Exception	The handled exception.
return	void