Package org.opennms.netmgt.config
Interface SyslogdConfig
-
- All Known Implementing Classes:
SyslogConfigBean
,SyslogdConfigFactory
public interface SyslogdConfig
SyslogdConfig interface.
- Version:
- $Id: $
- Author:
- ranger
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getBatchIntervalMs()
Messages are aggregated in batches before being dispatched.int
getBatchSize()
Messages are aggregated in batches before being dispatched.java.lang.String
getDiscardUei()
getDiscardUeijava.lang.String
getForwardingRegexp()
getForwardingRegexpjava.util.List<HideMatch>
getHideMessages()
A collection of Strings we do not want to attach to the event.java.lang.String
getListenAddress()
getListenAddressjava.lang.Integer
getMatchingGroupHost()
getMatchingGroupHostjava.lang.Integer
getMatchingGroupMessage()
getMatchingGroupMessageboolean
getNewSuspectOnMessage()
getNewSuspectOnMessageint
getNumThreads()
Number of threads used for consuming/dispatching messages.java.lang.String
getParser()
getParserint
getQueueSize()
Maximum number of messages to keep in memory while waiting to be dispatched.int
getSyslogPort()
getSyslogPortjava.util.TimeZone
getTimeZone()
Optional: - if not null it will be used as default time zone if no time zone is given - if not set the system time zone will be usedjava.util.List<UeiMatch>
getUeiList()
A collection of Strings->UEI'svoid
reload()
reload configurationboolean
shouldIncludeRawSyslogmessage()
Indicates whether or not to include the raw syslog message as an event parameter on events generated by Syslogd.
-
-
-
Method Detail
-
getSyslogPort
int getSyslogPort()
getSyslogPort
- Returns:
- a int.
-
getListenAddress
java.lang.String getListenAddress()
getListenAddress
- Returns:
- a
String
object. - Since:
- 1.8.1
-
getNewSuspectOnMessage
boolean getNewSuspectOnMessage()
getNewSuspectOnMessage
- Returns:
- a boolean.
-
getForwardingRegexp
java.lang.String getForwardingRegexp()
getForwardingRegexp
- Returns:
- a
String
object.
-
getMatchingGroupHost
java.lang.Integer getMatchingGroupHost()
getMatchingGroupHost
- Returns:
- a int.
-
getMatchingGroupMessage
java.lang.Integer getMatchingGroupMessage()
getMatchingGroupMessage
- Returns:
- a int.
-
getParser
java.lang.String getParser()
getParser
- Returns:
- the parser class to use when parsing syslog messages, as a string.
-
getUeiList
java.util.List<UeiMatch> getUeiList()
A collection of Strings->UEI's
-
getHideMessages
java.util.List<HideMatch> getHideMessages()
A collection of Strings we do not want to attach to the event.
-
getDiscardUei
java.lang.String getDiscardUei()
getDiscardUei
- Returns:
- a
String
object.
-
getNumThreads
int getNumThreads()
Number of threads used for consuming/dispatching messages.- Returns:
- number of threads
-
getQueueSize
int getQueueSize()
Maximum number of messages to keep in memory while waiting to be dispatched.- Returns:
- queue size
-
getBatchSize
int getBatchSize()
Messages are aggregated in batches before being dispatched. When the batch reaches this size, it will be dispatched.- Returns:
- batch size
-
getBatchIntervalMs
int getBatchIntervalMs()
Messages are aggregated in batches before being dispatched. When the batch has been created for longer than this interval it will be dispatched, regardless of the size.- Returns:
- interval in ms
-
getTimeZone
java.util.TimeZone getTimeZone()
Optional: - if not null it will be used as default time zone if no time zone is given - if not set the system time zone will be used
-
shouldIncludeRawSyslogmessage
boolean shouldIncludeRawSyslogmessage()
Indicates whether or not to include the raw syslog message as an event parameter on events generated by Syslogd.Default behavior is false unless configured otherwise.
- Returns:
- whether or not to include the raw syslog message as an event parameter on events generated by Syslogd
-
reload
void reload() throws java.io.IOException
reload configuration- Throws:
java.io.IOException
-
-