Package org.opennms.netmgt.config
Interface SyslogdConfig
-
- All Known Implementing Classes:
SyslogConfigBean,SyslogdConfigFactory
public interface SyslogdConfigSyslogdConfig interface.
- Version:
- $Id: $
- Author:
- ranger
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetBatchIntervalMs()Messages are aggregated in batches before being dispatched.intgetBatchSize()Messages are aggregated in batches before being dispatched.StringgetDiscardUei()getDiscardUeiStringgetForwardingRegexp()getForwardingRegexpList<HideMatch>getHideMessages()A collection of Strings we do not want to attach to the event.StringgetListenAddress()getListenAddressIntegergetMatchingGroupHost()getMatchingGroupHostIntegergetMatchingGroupMessage()getMatchingGroupMessagebooleangetNewSuspectOnMessage()getNewSuspectOnMessageintgetNumThreads()Number of threads used for consuming/dispatching messages.StringgetParser()getParserintgetQueueSize()Maximum number of messages to keep in memory while waiting to be dispatched.intgetSyslogPort()getSyslogPortTimeZonegetTimeZone()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 usedList<UeiMatch>getUeiList()A collection of Strings->UEI'svoidreload()reload configurationbooleanshouldIncludeRawSyslogmessage()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.
-
getNewSuspectOnMessage
boolean getNewSuspectOnMessage()
getNewSuspectOnMessage
- Returns:
- a boolean.
-
getMatchingGroupHost
Integer getMatchingGroupHost()
getMatchingGroupHost
- Returns:
- a int.
-
getMatchingGroupMessage
Integer getMatchingGroupMessage()
getMatchingGroupMessage
- Returns:
- a int.
-
getParser
String getParser()
getParser
- Returns:
- the parser class to use when parsing syslog messages, as a string.
-
getHideMessages
List<HideMatch> getHideMessages()
A collection of Strings we do not want to attach to the event.
-
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
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 IOExceptionreload configuration- Throws:
IOException
-
-