Gibraltar Loupe
Log Class Members
Fields  Properties  Methods  Events


The following tables list the members exposed by Log.

Public Fields
 NameDescription
Public FieldPackageExtensionThe file extension (without period) for a Gibraltar Package File.  
Top
Public Properties
 NameDescription
Public Propertystatic (Shared in Visual Basic)AgentVersionThe version information for the Gibraltar Agent.  
Public Propertystatic (Shared in Visual Basic)AutoSendConsentGrantedIndicates if the user has granted auto send consent for the current application  
Public Propertystatic (Shared in Visual Basic)SendSessionsOnExitIndicates if the agent should package & send sessions for the current application after this session exits.  
Public Propertystatic (Shared in Visual Basic)SessionSummaryThe common information about the active log session.  
Top
Public Methods
 NameDescription
Public Methodstatic (Shared in Visual Basic)CriticalOverloaded. Write a categorized Critical message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)CriticalDetailOverloaded. Write a detailed Critical message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)DisplayConsentDialogWindows clients should call this to display the auto send consent form outside of the startup sequence.  
Public Methodstatic (Shared in Visual Basic)DisplayStartupConsentDialogWindows clients should call this to display the auto send consent form on startup if necessary  
Public Methodstatic (Shared in Visual Basic)EndFileOverloaded. End the current log file (but not the session) and open a new file to continue logging.  
Public Methodstatic (Shared in Visual Basic)EndSessionOverloaded. Used to explicitly set the session state for the current session and provide a reason.  
Public Methodstatic (Shared in Visual Basic)ErrorOverloaded. Write a categorized Error message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)ErrorDetailOverloaded. Write a detailed Error message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)InformationOverloaded. Write a categorized Information message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)InformationDetailOverloaded. Write a detailed Information message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)RecordExceptionRecord an unexpected exception to the log without displaying a user prompt.  
Public Methodstatic (Shared in Visual Basic)RegisterUIThreadEnsures the calling thread is configured for the Agent to manage exceptions. See Remarks for description of the rare circumstances this is needed.  
Public Methodstatic (Shared in Visual Basic)ReportExceptionRecord an unexpected exception to the log and report it to the user if possible.  
Public Methodstatic (Shared in Visual Basic)SendMessageSend an email message using the agent's email configuration  
Public Methodstatic (Shared in Visual Basic)SendSessionsSafely send sessions to the hub or via email. Only one send request will be processed at a time.  
Public Methodstatic (Shared in Visual Basic)SendSessionsAsyncSafely send sessions asynchronously to the hub or via email. Only one send request will be processed at a time.  
Public Methodstatic (Shared in Visual Basic)ShowLiveViewerWindows applications only. Shows the Gibraltar Live Viewer immediately (as if the user pressed the hotkey).  
Public Methodstatic (Shared in Visual Basic)StartSessionOverloaded. Attempt to activate the agent.  
Public Methodstatic (Shared in Visual Basic)TraceCriticalOverloaded. Write a Critical trace message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)TraceErrorOverloaded. Write an Error trace message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)TraceInformationOverloaded. Write an Information trace message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)TraceVerboseOverloaded. Write a Verbose trace message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)TraceWarningOverloaded. Write a Warning trace message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)VerboseOverloaded. Write a categorized Verbose message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)VerboseDetailOverloaded. Write a detailed Verbose message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)WarningOverloaded. Write a categorized Warning message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)WarningDetailOverloaded. Write a detailed Warning message directly to the Gibraltar log.  
Public Methodstatic (Shared in Visual Basic)WriteOverloaded. Write a complete log message directly to the Gibraltar log from a wrapper method or bridging logic, attributing the source of the message farther up the call-stack.  
Top
Public Events
 NameDescription
Public EventInitializingRaised whenever the log system is being started to enable programmatic configuration.  
Public EventLiveViewerMessageFilterRaised whenever the Gibraltar Live Viewer receives a new log message, allowing the client to block it from being included for display to users.  
Public EventMessageAlertRaised to alert subscribers to any Warning, Error, or Critical log messages, with optional throttling.  
Top
See Also

Reference

Log Class
Gibraltar.Agent Namespace

Developer's Reference

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

 

 


Copyright © 2008-2013 Gibraltar Software, Inc.

Send Feedback