Event Log Configuration

Studio lets you log internal Studio and Runtime events to the Windows event log. To define event log functionality for use with Studio, open the configuration settings by choosing Tools > Options > OpenSpan > Event Log Configuration. You can find definitions of the configuration settings in the following table.

Event logging is not enabled by default since creating and writing to event logs are privileged functions in Windows. To enable event logging at the application level, add the following lines to the Diagnostics section of the application configuration file (StudioConfig.xml or RuntimeConfig.xml):

<publisher mode="on" trace_mode="on"

exception_mode="on"

assembly="OpenSpan"

type="OpenSpan.Diagnostics.Publishers.EventLogPublisher" />

For more information, see Configuration Options and Event Logging - Log Types.

Note: If the event log is full and the internal event logging service for Studio or Runtime is enabled, writing to the log will not occur and an exception is generated. The exception is written to the diagnostic log to indicate the problem. To correct this error, change the event log to allow overwriting events. See the event log configuration options for more information.

Event log configuration options

Event Log Field	Definition
Event Log Name	The name of the event log to use and/or create to log. By default the event log name OS_EVTLOG is used. Click the drop-down button in this field to see the other available Windows event logs (such as Application, Security, and so on). You can also edit this field to add a new event log name. Note: Creation of event logs, event sources, and modification of the various event log properties is a privileged operation. Hence attempting to change these properties may result in security related errors, which will be displayed as exceptions in the user interface.
Source	The name of the source to use when logging events to the event log. This identifies the application logging the information. By default the event log source is Runtime. When changed through the Event Log Configuration screen, this source applies globally to all event logs unless directed otherwise. An event source indicates the origin of a given event. The source can be used as a filter when reviewing an event log. An event source can be registered only with one event log at a time. To log events to a given event log using a given source, that source must be registered with that event log, otherwise an error occurs.
Computer	The name of the computer on which to log the events. This defaults to the local computer (.).
Logging Level	Indicates the minimum severity of events to record in the event log. These options are defined by the Windows event logging system: Error Warning Information Success Audit Failure Audit
Maximum Log Size	Indicates the maximum capacity of the event log in kilobytes. Note that if the event log size is exceeded, an exception is generated. To clear this type of exception, change these settings: Log Size Overwrite Events as Needed Overwrite Events older than 'X' days
Overwrite Events as Needed	Indicates that each new entry overwrites the oldest entry when the event log is full.
Overwrite Events older than 'X' days	New events are discarded if the event log is full and there are no events older than specified by the minimum retention days property value.
Do Not Overwrite Events	Indicates that existing entries are retained when the event log is full and new entries are discarded.
Restore Defaults	Resets the Event Log Configuration Log Size options entries to the application installation defaults.
Enabled?	Check this check box to enable the internal event logging to the Event Log listed above.
Clear Log	Clears the contents of the Event Log listed above.
Delete Log	Deletes the event log settings.