Interface MonitoringSession
-
- All Superinterfaces:
LogFilterSettings
public interface MonitoringSession extends LogFilterSettings
A monitoring session is a way for us to set levels and filters on the logging system, and have them timeout after a certain period of time.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
close()
Closes and destroys the monitoring session.java.lang.String
getId()
An id that can be used to retrieve the session again if necessary.java.util.List<LogEvent>
getLogMessages(long sinceTime)
Returns the events observed since the given timestamp.void
keepalive()
Called periodically to keep the session from expiring.void
reset()
Resets all logging levels and clears all filters.-
Methods inherited from interface com.inductiveautomation.ignition.common.logging.LogFilterSettings
addPropertyFilter, clearPropertyLevel, clearPropertyLevels, propertyFilterSettings, removePropertyFilter, setLevel, setPropertyLevel
-
-
-
-
Method Detail
-
getId
java.lang.String getId()
An id that can be used to retrieve the session again if necessary. Can be serialized across page loads or into a gateway session, for example.
-
keepalive
void keepalive()
Called periodically to keep the session from expiring. Note that other actions taken on this class also keep the session alive, so calling this function is not necessary if you are routinely collecting events.
-
reset
void reset()
Resets all logging levels and clears all filters.
-
close
void close()
Closes and destroys the monitoring session.
-
getLogMessages
java.util.List<LogEvent> getLogMessages(long sinceTime)
Returns the events observed since the given timestamp. The events are held in memory, so there is a certain point where events will no longer be available.- Returns:
- The observed events, with the newest events first.
-
-