fluentd 1.20.0-aarch64-mingw-ucrt

data/lib/fluent/plugin/in_syslog.rb

@@ -0,0 +1,346 @@
+#
+# Fluentd
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+require 'fluent/plugin/input'
+require 'fluent/config/error'
+require 'fluent/plugin/parser'
+
+require 'json'
+
+module Fluent::Plugin
+  class SyslogInput < Input
+    Fluent::Plugin.register_input('syslog', self)
+
+    helpers :parser, :compat_parameters, :server
+
+    DEFAULT_PARSER = 'syslog'
+    SYSLOG_REGEXP = /^\<([0-9]+)\>(.*)/
+
+    FACILITY_MAP = {
+      0   => 'kern',
+      1   => 'user',
+      2   => 'mail',
+      3   => 'daemon',
+      4   => 'auth',
+      5   => 'syslog',
+      6   => 'lpr',
+      7   => 'news',
+      8   => 'uucp',
+      9   => 'cron',
+      10  => 'authpriv',
+      11  => 'ftp',
+      12  => 'ntp',
+      13  => 'audit',
+      14  => 'alert',
+      15  => 'at',
+      16  => 'local0',
+      17  => 'local1',
+      18  => 'local2',
+      19  => 'local3',
+      20  => 'local4',
+      21  => 'local5',
+      22  => 'local6',
+      23  => 'local7'
+    }
+
+    SEVERITY_MAP = {
+      0  => 'emerg',
+      1  => 'alert',
+      2  => 'crit',
+      3  => 'err',
+      4  => 'warn',
+      5  => 'notice',
+      6  => 'info',
+      7  => 'debug'
+    }
+
+    desc 'The port to listen to.'
+    config_param :port, :integer, default: 5140
+    desc 'The bind address to listen to.'
+    config_param :bind, :string, default: '0.0.0.0'
+    desc 'The prefix of the tag. The tag itself is generated by the tag prefix, facility level, and priority.'
+    config_param :tag, :string
+    desc 'The transport protocol used to receive logs.(udp, tcp)'
+    config_param :protocol_type, :enum, list: [:tcp, :udp], default: nil, deprecated: "use transport directive"
+    desc 'The message frame type.(traditional, octet_count)'
+    config_param :frame_type, :enum, list: [:traditional, :octet_count], default: :traditional
+
+    desc 'If true, add source host to event record.'
+    config_param :include_source_host, :bool, default: false, deprecated: 'use "source_hostname_key" or "source_address_key" instead.'
+    desc 'Specify key of source host when include_source_host is true.'
+    config_param :source_host_key, :string, default: 'source_host'.freeze
+    desc 'Enable the option to emit unmatched lines.'
+    config_param :emit_unmatched_lines, :bool, default: false
+
+    desc 'The field name of hostname of sender.'
+    config_param :source_hostname_key, :string, default: nil
+    desc 'Try to resolve hostname from IP addresses or not.'
+    config_param :resolve_hostname, :bool, default: nil
+    desc 'Check the remote connection is still available by sending a keepalive packet if this value is true.'
+    config_param :send_keepalive_packet, :bool, default: false
+    desc 'The field name of source address of sender.'
+    config_param :source_address_key, :string, default: nil
+    desc 'The field name of the severity.'
+    config_param :severity_key, :string, default: nil, alias: :priority_key
+    desc 'The field name of the facility.'
+    config_param :facility_key, :string, default: nil
+
+    desc "The max bytes of message. The messages exceeding this limit are dropped (UDP, TCP/TLS with traditional frame_type) or the connection is closed (TCP/TLS with octet_count frame_type)."
+    config_param :message_length_limit, :size, default: 8192
+
+    config_param :blocking_timeout, :time, default: 0.5
+
+    desc 'The delimiter value "\n"'
+    config_param :delimiter, :string, default: "\n" # syslog family add "\n" to each message
+
+    config_section :parse do
+      config_set_default :@type, DEFAULT_PARSER
+      config_param :with_priority, :bool, default: true
+    end
+
+    # overwrite server plugin to change default to :udp
+    config_section :transport, required: false, multi: false, init: true, param_name: :transport_config do
+      config_argument :protocol, :enum, list: [:tcp, :udp, :tls], default: :udp
+    end
+
+    def configure(conf)
+      compat_parameters_convert(conf, :parser)
+
+      super
+
+      if conf.has_key?('priority_key')
+        log.warn "priority_key is deprecated. Use severity_key instead"
+      end
+
+      @use_default = false
+
+      @parser = parser_create
+      @parser_parse_priority = @parser.respond_to?(:with_priority) && @parser.with_priority
+
+      if @include_source_host
+        if @source_address_key
+          raise Fluent::ConfigError, "specify either source_address_key or include_source_host"
+        end
+        @source_address_key = @source_host_key
+      end
+      if @source_hostname_key
+        if @resolve_hostname.nil?
+          @resolve_hostname = true
+        elsif !@resolve_hostname # user specifies "false" in config
+          raise Fluent::ConfigError, "resolve_hostname must be true with source_hostname_key"
+        end
+      end
+
+      @_event_loop_run_timeout = @blocking_timeout
+
+      protocol = @protocol_type || @transport_config.protocol
+      if @send_keepalive_packet && protocol == :udp
+        raise Fluent::ConfigError, "send_keepalive_packet is available for tcp/tls"
+      end
+    end
+
+    def multi_workers_ready?
+      true
+    end
+
+    def zero_downtime_restart_ready?
+      true
+    end
+
+    def start
+      super
+
+      log.info "listening syslog socket on #{@bind}:#{@port} with #{@protocol_type || @transport_config.protocol}"
+      case @protocol_type || @transport_config.protocol
+      when :udp then start_udp_server
+      when :tcp then start_tcp_server
+      when :tls then start_tcp_server(tls: true)
+      else
+        raise "BUG: invalid transport value: #{@protocol_type || @transport_config.protocol}"
+      end
+    end
+
+    def start_udp_server
+      server_create_udp(:in_syslog_udp_server, @port, bind: @bind, max_bytes: @message_length_limit, resolve_name: @resolve_hostname) do |data, sock|
+        message_handler(data.chomp, sock)
+      end
+    end
+
+    def start_tcp_server(tls: false)
+      octet_count_frame = @frame_type == :octet_count
+
+      delimiter = octet_count_frame ? " " : @delimiter
+      delimiter_size = delimiter.size
+      server_create_connection(
+        tls ? :in_syslog_tls_server : :in_syslog_tcp_server, @port,
+        bind: @bind,
+        resolve_name: @resolve_hostname,
+        send_keepalive_packet: @send_keepalive_packet
+      ) do |conn|
+        discard_till_next_delimiter = false
+        conn.data do |data|
+          buffer = conn.buffer
+          buffer << data
+          pos = 0
+          if octet_count_frame
+            # Once an octet-counted stream contains an untrustworthy frame header, the stream
+            # can't be resynchronized. So close the connection instead of skipping bytes.
+            close_connection = false
+            while idx = buffer.index(delimiter, pos)
+              begin
+                num = Integer(buffer[pos..idx])
+              rescue ArgumentError
+                log.info "The message length is not a number, closing connection"
+                log.on_debug { log.debug "The message length is not a number:", head: buffer[pos, 32].dump }
+                close_connection = true
+                break
+              end
+
+              if num < 0
+                log.info "The message length is negative, closing connection:", size: num
+                close_connection = true
+                break
+              end
+
+              if num > @message_length_limit
+                log.info "The message length exceeds 'message_length_limit', closing connection:", limit: @message_length_limit, size: num
+                close_connection = true
+                break
+              end
+
+              msg = buffer[idx + delimiter_size, num]
+              if msg.size != num
+                # The frame is not fully received yet.
+                break
+              end
+
+              pos = idx + delimiter_size + num
+              message_handler(msg, conn)
+            end
+            buffer.slice!(0, pos) if pos > 0
+
+            # If the remaining buffer has no delimiter, no message length can be parsed from it.
+            # Since a valid frame header is much shorter than the limit, such a buffer never
+            # becomes a valid frame. (Note that a partially received valid frame always has a
+            # delimiter after its length, so this doesn't drop it even if it slightly exceeds
+            # the limit with its length header.)
+            if !close_connection && !buffer.index(delimiter) && buffer.bytesize > @message_length_limit
+              log.info "The buffer size exceeds 'message_length_limit', closing connection:", limit: @message_length_limit, size: buffer.bytesize
+              log.on_debug { log.debug "The buffer size exceeds 'message_length_limit':", head: buffer[...32] }
+              close_connection = true
+            end
+
+            if close_connection
+              buffer.clear
+              conn.close
+              next
+            end
+          else
+            while idx = buffer.index(delimiter, pos)
+              msg = buffer[pos...idx]
+              pos = idx + delimiter_size
+
+              if discard_till_next_delimiter
+                discard_till_next_delimiter = false
+                next
+              end
+
+              if msg.bytesize > @message_length_limit
+                log.info "The received data is larger than 'message_length_limit', dropped:", limit: @message_length_limit, size: msg.bytesize
+                log.on_debug { log.debug "The received data is larger than 'message_length_limit':", head: msg[...32] }
+                next
+              end
+
+              message_handler(msg, conn)
+            end
+            buffer.slice!(0, pos) if pos > 0
+
+            # If the buffer size exceeds the limit here, it means that the next message will
+            # definitely exceed the limit. So we should clear the buffer here. Otherwise, it will
+            # keep storing useless data until the next delimiter comes.
+            if buffer.bytesize > @message_length_limit
+              log.info "The buffer size exceeds 'message_length_limit', cleared:", limit: @message_length_limit, size: buffer.bytesize
+              log.on_debug { log.debug "The buffer size exceeds 'message_length_limit':", head: buffer[...32] }
+              buffer.clear
+              # We should discard the subsequent data until the next delimiter comes.
+              discard_till_next_delimiter = true
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def emit_unmatched(data, sock)
+      record = {"unmatched_line" => data}
+      record[@source_address_key] = sock.remote_addr if @source_address_key
+      record[@source_hostname_key] = sock.remote_host if @source_hostname_key
+      emit("#{@tag}.unmatched", Fluent::EventTime.now, record)
+    end
+
+    def message_handler(data, sock)
+      pri = nil
+      text = data
+      unless @parser_parse_priority
+        m = SYSLOG_REGEXP.match(data)
+        unless m
+          if @emit_unmatched_lines
+            emit_unmatched(data, sock)
+          end
+          log.warn "invalid syslog message: #{data.dump}"
+          return
+        end
+        pri = m[1].to_i
+        text = m[2]
+      end
+
+      @parser.parse(text) do |time, record|
+        unless time && record
+          if @emit_unmatched_lines
+            emit_unmatched(data, sock)
+          end
+          log.warn "failed to parse message", data: data
+          return
+        end
+
+        pri ||= record.delete('pri')
+        facility = FACILITY_MAP[pri >> 3]
+        severity = SEVERITY_MAP[pri & 0b111]
+
+        record[@severity_key] = severity if @severity_key
+        record[@facility_key] = facility if @facility_key
+        record[@source_address_key] = sock.remote_addr if @source_address_key
+        record[@source_hostname_key] = sock.remote_host if @source_hostname_key
+
+        tag = "#{@tag}.#{facility}.#{severity}"
+        emit(tag, time, record)
+      end
+    rescue => e
+      if @emit_unmatched_lines
+        emit_unmatched(data, sock)
+      end
+      log.error "invalid input", data: data, error: e
+      log.error_backtrace
+    end
+
+    def emit(tag, time, record)
+      router.emit(tag, time, record)
+    rescue => e
+      log.error "syslog failed to emit", error: e, tag: tag, record: JSON.generate(record)
+    end
+  end
+end

data/lib/fluent/plugin/in_tail/compatibility.rb

@@ -0,0 +1,111 @@
+#
+# Fluentd
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+require 'fluent/plugin/input'
+require 'fluent/clock'
+
+module Fluent::Plugin
+  class TailInput < Fluent::Plugin::Input
+    module Compatibility
+      # Keep these methods as compatibility entry points for plugins which
+      # inherit TailInput and override line processing methods. TailInput is a
+      # built-in plugin, not a public inheritance API, and these methods may be
+      # removed in a future release.
+      def flush_buffer(tw, buf)
+        @line_feeder.flush_buffer(tw, buf)
+      end
+
+      # Feeds lines through the per-file feed, or through LineFeeder for watchers
+      # created by plugins using the deprecated LineBufferTimerFlusher.
+      #
+      # @return true if no error or unrecoverable error happens in emit action. false if got BufferOverflowError
+      def receive_lines(lines, tail_watcher)
+        return async_receive_lines(lines, tail_watcher) if @worker_pool
+
+        file_feed = tail_watcher.file_feed
+        return file_feed.feed_lines(lines, tail_watcher) if file_feed.respond_to?(:feed_lines)
+
+        @line_feeder.feed_lines(lines, tail_watcher)
+      end
+
+      def convert_line_to_event(line, es, tail_watcher)
+        @line_feeder.convert_line_to_event(line, es, tail_watcher)
+      end
+
+      def parse_singleline(lines, tail_watcher)
+        @line_feeder.parse_singleline(lines, tail_watcher)
+      end
+
+      # TailInput's default #parse_multilines path starts the flush timer before
+      # parsing. An override that skips super must call
+      # tail_watcher.line_buffer_timer_flusher.reset_timer when needed.
+      def parse_multilines(lines, tail_watcher)
+        @line_feeder.parse_multilines(lines, tail_watcher)
+      end
+    end
+
+    class TailWatcher
+      # The object which keeps the line buffer of the multiline mode of the file:
+      # the FileFeed built by LineFeeder#new_file_feed, or the deprecated
+      # LineBufferTimerFlusher which a plugin overriding TailInput#setup_watcher
+      # passes to keep working without changes.
+      def line_buffer_timer_flusher
+        @file_feed
+      end
+
+      # Kept for compatibility with the plugins which build it by themselves and
+      # pass it to TailWatcher in the overridden TailInput#setup_watcher.
+      # LineFeeder#feed_lines feeds the lines of a watcher which keeps it, and
+      # LineFeeder::FileFeed built by LineFeeder#new_file_feed replaces it.
+      class LineBufferTimerFlusher
+        attr_accessor :line_buffer
+
+        def initialize(log, flush_interval, &flush_method)
+          @log = log
+          @flush_interval = flush_interval
+          @flush_method = flush_method
+          @start = nil
+          @line_buffer = nil
+        end
+
+        def on_notify(tw)
+          unless @start && @flush_method
+            return
+          end
+
+          if Fluent::Clock.now - @start >= @flush_interval
+            @flush_method.call(tw, @line_buffer) if @line_buffer
+            @line_buffer = nil
+            @start = nil
+          end
+        end
+
+        def close(tw)
+          return unless @line_buffer
+
+          @flush_method.call(tw, @line_buffer)
+          @line_buffer = nil
+        end
+
+        def reset_timer
+          return unless @flush_interval
+
+          @start = Fluent::Clock.now
+        end
+      end
+    end
+  end
+end