EventLog

Description

A class that provides access to the event log.

Using the EventLog class, you can add custom events to the Event Log.

EventLog.info("MyCustomEvent");
if (/*something is unusual*/) {
    EventLog.warn("MyCustomEvent", 0, 0, "Something is unusual");
}
if (/*something is wrong*/) {
    EventLog.error("MyCustomEvent", 0, 0, "Something is wrong");
}
if (/*something is terribly wrong*/) {
    EventLog.fatal("MyCustomEvent", 0, 0, "Something is terribly wrong");
}

The logging methods are:

• info()
• warn()
• error()
• fatal()

When used, each method logs a new event in the event log at the current model time and at the current level. The event is logged in any active log: the model log, the system log, or both. If no event logs are active, then these methods do nothing.

The only required parameter for the logging methods is the event parameter. It is best to use a short but meaningful name so that filtering by the event makes sense. The remainder of the parameters (two node parameters and four string parameters) are optional and arbitrary.

You can check whether any logs are active using the enabled property:

if (EventLog.enabled) {
    string p1 = /*expensive computation*/;
    EventLog.info("MyCustomEvent", 0, 0, p1);
}

Static Properties

enabled

Returns whether logging is currently enabled.

Static Methods

error	Log an Error-level event at the current time.
fatal	Log a Fatal-level event at the current time.
info	Log an Info-level event at the current time.
warn	Log a Warn-level event at the current time.