Class Rfc5424Layout

    • Field Detail

      • DEFAULT_ENTERPRISE_NUMBER

        public static final int DEFAULT_ENTERPRISE_NUMBER
        Not a very good default - it is the Apache Software Foundation's enterprise number.
        See Also:
        Constant Field Values
      • NEWLINE_PATTERN

        public static final Pattern NEWLINE_PATTERN
        Match newlines in a platform-independent manner.
      • PARAM_VALUE_ESCAPE_PATTERN

        public static final Pattern PARAM_VALUE_ESCAPE_PATTERN
        Match characters which require escaping.
    • Method Detail

      • toSerializable

        public String toSerializable​(LogEvent event)
        Formats a LogEvent in conformance with the RFC 5424 Syslog specification.
        Parameters:
        event - The LogEvent.
        Returns:
        The RFC 5424 String representation of the LogEvent.
      • getProcId

        protected String getProcId()
      • getMdcExcludes

        protected List<String> getMdcExcludes()
      • getMdcIncludes

        protected List<String> getMdcIncludes()
      • createLayout

        @PluginFactory
        public static Rfc5424Layout createLayout​(@PluginAttribute(value="facility",defaultString="LOCAL0")
                                                 Facility facility,
                                                 @PluginAttribute("id")
                                                 String id,
                                                 @PluginAttribute(value="enterpriseNumber",defaultInt=18060)
                                                 int enterpriseNumber,
                                                 @PluginAttribute(value="includeMDC",defaultBoolean=true)
                                                 boolean includeMDC,
                                                 @PluginAttribute(value="mdcId",defaultString="mdc")
                                                 String mdcId,
                                                 @PluginAttribute("mdcPrefix")
                                                 String mdcPrefix,
                                                 @PluginAttribute("eventPrefix")
                                                 String eventPrefix,
                                                 @PluginAttribute("newLine")
                                                 boolean newLine,
                                                 @PluginAttribute("newLineEscape")
                                                 String escapeNL,
                                                 @PluginAttribute("appName")
                                                 String appName,
                                                 @PluginAttribute("messageId")
                                                 String msgId,
                                                 @PluginAttribute("mdcExcludes")
                                                 String excludes,
                                                 @PluginAttribute("mdcIncludes")
                                                 String includes,
                                                 @PluginAttribute("mdcRequired")
                                                 String required,
                                                 @PluginAttribute("exceptionPattern")
                                                 String exceptionPattern,
                                                 @PluginAttribute("useTlsMessageFormat")
                                                 boolean useTlsMessageFormat,
                                                 @PluginElement("LoggerFields")
                                                 LoggerFields[] loggerFields,
                                                 @PluginConfiguration
                                                 Configuration config)
        Create the RFC 5424 Layout.
        Parameters:
        facility - The Facility is used to try to classify the message.
        id - The default structured data id to use when formatting according to RFC 5424.
        enterpriseNumber - The IANA enterprise number.
        includeMDC - Indicates whether data from the ThreadContextMap will be included in the RFC 5424 Syslog record. Defaults to "true:.
        mdcId - The id to use for the MDC Structured Data Element.
        mdcPrefix - The prefix to add to MDC key names.
        eventPrefix - The prefix to add to event key names.
        newLine - If true, a newline will be appended to the end of the syslog record. The default is false.
        escapeNL - String that should be used to replace newlines within the message text.
        appName - The value to use as the APP-NAME in the RFC 5424 syslog record.
        msgId - The default value to be used in the MSGID field of RFC 5424 syslog records.
        excludes - A comma separated list of MDC keys that should be excluded from the LogEvent.
        includes - A comma separated list of MDC keys that should be included in the FlumeEvent.
        required - A comma separated list of MDC keys that must be present in the MDC.
        exceptionPattern - The pattern for formatting exceptions.
        useTlsMessageFormat - If true the message will be formatted according to RFC 5425.
        loggerFields - Container for the KeyValuePairs containing the patterns
        config - The Configuration. Some Converters require access to the Interpolator.
        Returns:
        An Rfc5424Layout.
      • getFacility

        public Facility getFacility()