Log Class Members

In This Topic

The following tables list the members exposed by Log.

Public Fields

	Name	Description
	PackageExtension	The file extension (without period) for a Loupe Package File.

Top

Public Properties

	Name	Description
	AgentVersion	The version information for the Loupe Agent.
	AutoSendConsentGranted	Indicates if the user has granted auto send consent for the current application
	SendSessionsOnExit	Indicates if the agent should package & send sessions for the current application after this session exits.
	ServerAuthenticationProvider	Optional. A custom authentication provider for communication between the agent and server
	SessionSummary	The common information about the active log session.

Top

Public Methods

	Name	Description
	ApplyConsent	Non-UI clients should call this in lieu of DisplayStartupConsentDialog to activate auto-send
	Critical	Overloaded. Write a categorized Critical message directly to the Loupe log.
	CriticalDetail	Overloaded. Write a detailed Critical message directly to the Loupe log.
	DisplayConsentDialog	Windows clients should call this to display the auto send consent form outside of the startup sequence.
	DisplayStartupConsentDialog	Windows clients should call this to display the auto send consent form on startup if necessary
	EndFile	Overloaded. End the current log file (but not the session) and open a new file to continue logging.
	EndSession	Overloaded. Used to explicitly set the session state for the current session and provide a reason.
	Error	Overloaded. Write a categorized Error message directly to the Loupe log.
	ErrorDetail	Overloaded. Write a detailed Error message directly to the Loupe log.
	Information	Overloaded. Write a categorized Information message directly to the Loupe log.
	InformationDetail	Overloaded. Write a detailed Information message directly to the Loupe log.
	RecordException	Record an unexpected exception to the log without displaying a user prompt.
	RegisterUIThread	Ensures the calling thread is configured for the Agent to manage exceptions. See Remarks for description of the rare circumstances this is needed.
	ReportException	Record an unexpected exception to the log and report it to the user if possible.
	SendMessage	Send an email message using the agent's email configuration
	SendSessions	Overloaded. Safely send sessions to the Loupe Server or via email. Only one send request will be processed at a time.
	SendSessionsAsync	Overloaded. Safely send sessions asynchronously to the Loupe Server or via email. Only one send request will be processed at a time.
	ShowLiveViewer	Windows applications only. Shows the Loupe Live Viewer immediately (as if the user pressed the hotkey).
	StartSession	Overloaded. Attempt to activate the agent.
	TraceCritical	Overloaded. Write a Critical trace message directly to the Loupe log.
	TraceError	Overloaded. Write an Error trace message directly to the Loupe log.
	TraceInformation	Overloaded. Write an Information trace message directly to the Loupe log.
	TraceVerbose	Overloaded. Write a Verbose trace message directly to the Loupe log.
	TraceWarning	Overloaded. Write a Warning trace message directly to the Loupe log.
	Verbose	Overloaded. Write a categorized Verbose message directly to the Loupe log.
	VerboseDetail	Overloaded. Write a detailed Verbose message directly to the Loupe log.
	Warning	Overloaded. Write a categorized Warning message directly to the Loupe log.
	WarningDetail	Overloaded. Write a detailed Warning message directly to the Loupe log.
	Write	Overloaded. Write a complete log message directly to the Loupe log from a wrapper method or bridging logic, attributing the source of the message farther up the call-stack.

Top

Public Events

	Name	Description
	Initializing	Raised whenever the log system is being started to enable programmatic configuration.
	LiveViewerMessageFilter	Raised whenever the Loupe Live Viewer receives a new log message, allowing the client to block it from being included for display to users.
	MessageAlert	Raised to alert subscribers to any Warning, Error, or Critical log messages, with optional throttling.
	ResolveApplicationUser	Raised whenever a new user name is encountered in the log data to allow additional user information to be specified

Top

Reference

Log Class
Gibraltar.Agent Namespace

Developer's Reference

Logging - Using with Trace
Logging - Using with External Log Systems
Logging - Using Loupe as a Log System

Send Feedback