fluent-plugin-gelf-test 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 511579748f55d71a47298c8a14dd28819c0282e6b0985fe11c3804e2c2434f44
+  data.tar.gz: 4de6adc83deefd6fa870557b5391d9a614426a58d6cd6b374dec97c7a1cd0043
+SHA512:
+  metadata.gz: e3a73909ebef2e21186617333517a32cac0807989a7820a15f80b66662b8a32e3f60c2dd8543fce8115091500694e5d811a2526ed3043dd68be9a77d1a160eea
+  data.tar.gz: 56cfebea89bdb7255e3f2bd8118b13470aee4134fb163a34d3916425c579c49e223f11b535e8ecf2879641db76a074d2931a5adc09f0be9430b5a14188d4f597

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 New Relic, Inc.
+
+   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.

data/README.md

@@ -0,0 +1,54 @@
+# Fluentd GELF output and formatter plugins
+This is a fork of the fluent-plugin-gelf-hs (https://github.com/hotschedules/fluent-plugin-gelf-hs), which is no longer maintained.
+
+## Overview
+A Fluentd output plugin that sends logs to Graylog2.
+
+## Prerequisites
+Fluentd version 1.0 or higher.
+
+## Installation
+
+Add the plugin to your fluentd agent:
+
+`fluent-gem install fluent-plugin-gelf-best`
+
+If you are using td-agent:
+
+`td-agent-gem install fluent-plugin-gelf-best`
+
+For more info, review [Fluentd's official documentation](https://docs.fluentd.org/deployment/plugin-management).
+
+
+## Output plugin configuration
+```
+<match **>
+  type gelf
+  host <remote GELF host>
+  port <remote GELF port>
+  protocol <tcp or udp (default)>
+  tls <true or false (default)>
+  tls_options <{} (default)> for options see https://github.com/graylog-labs/gelf-rb/blob/72916932b789f7a6768c3cdd6ab69a3c942dbcef/lib/gelf/transport/tcp_tls.rb#L7-L12
+  max_bytes <maximum message size (3200 default)>
+  [ fluent buffered output plugin configuration ]
+</match>
+```
+
+## Formatter plugin configuration
+```
+<match **>
+  type file (any type that that takes a format argument)
+  format gelf
+  [ fluent file output plugin configuration ]
+</match>
+```
+
+## License
+
+fluent-plugin-gelf-best is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.
+
+## Copyright
+
+* Copyright(c) 2024 - Bartosz Michałkiewicz
+* License
+  * Apache License, Version 2.0

data/lib/fluent/plugin/formatter_gelf.rb

@@ -0,0 +1,49 @@
+# typed: false
+require "fluent/plugin/formatter"
+require "fluent/plugin/gelf_plugin_util"
+require 'oj'
+
+module Fluent
+  module TextFormatter
+    class GelfFormatter < Formatter
+
+      unless method_defined?(:log)
+        define_method('log') { $log }
+      end
+
+      Plugin.register_formatter("gelf", self)
+
+      include Fluent::GelfPluginUtil
+
+      config_param :use_record_host, :bool, :default => true
+      config_param :add_msec_time, :bool, :default => false
+      config_param :max_bytes, :integer, :default => 32000
+
+      def configure(conf)
+        super(conf)
+      end
+
+      def format(tag, time, record)
+        begin
+          gelfentry = make_gelfentry(
+            tag, time, record,
+            {
+              use_record_host: @use_record_host,
+              add_msec_time: @add_msec_time,
+              max_bytes: @max_bytes
+            }
+          )
+
+          Oj.dump(gelfentry)
+
+        rescue Exception => e
+          log.error sprintf(
+            'Error trying to serialize %s: %s',
+            record.to_s.force_encoding('UTF-8'),
+            e.message.to_s.force_encoding('UTF-8')
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fluent/plugin/gelf_plugin_util.rb

@@ -0,0 +1,84 @@
+# typed: false
+module Fluent
+  module GelfPluginUtil
+    require "gelf"
+    require "date"
+
+    LEVEL_MAP = {
+      "0" => GELF::UNKNOWN, "1" => GELF::UNKNOWN, "a" => GELF::UNKNOWN,
+      "2" => GELF::FATAL, "c" => GELF::FATAL,
+      "3" => GELF::ERROR,
+      "4" => GELF::WARN, "w" => GELF::WARN,
+      "5" => GELF::INFO, "n" => GELF::INFO,
+      "6" => GELF::INFO, "i" => GELF::INFO,
+      "7" => GELF::DEBUG, "d" => GELF::DEBUG,
+      "e" => GELF::ERROR  # assuming 'e' stands typically for 'error'
+    }.freeze
+
+    def make_gelfentry(tag, time, record, conf = {})
+      gelfentry = {'_fluentd_tag' => tag, 'timestamp' => calculate_timestamp(time)}
+
+      record.each_pair do |k, v|
+        gelfentry.merge!(process_record_entry(k, v, conf, gelfentry))
+      end
+
+      ensure_short_message(gelfentry)
+      gelfentry.compact
+    end
+
+    private
+
+    def calculate_timestamp(time)
+      if defined?(Fluent::EventTime) && time.is_a?(Fluent::EventTime)
+        time.sec + (time.nsec.to_f / 1_000_000_000).round(3)
+      else
+        time
+      end
+    end
+
+    def process_record_entry(k, v, conf, gelfentry)
+      # Truncate values longer than max_bytes
+      v = (v.respond_to?(:bytesize) && v.bytesize > conf[:max_bytes]) ? "#{v.byteslice(0, conf[:max_bytes] - 3)}..." : v
+
+      case k
+      when 'host', 'hostname'
+        return {'host' => (conf[:use_record_host] ? v : gelfentry['_host'] = v)}
+      when 'timestamp', 'time'
+        { 'timestamp' => parse_timestamp(v) }
+      when 'level'
+        {'level' => LEVEL_MAP[v.to_s.downcase[0]] || (v.to_s.length >= 2 && v.to_s.downcase[1] != "r" ? GELF::UNKNOWN : v)}
+      when 'msec'
+        conf[:add_msec_time] ? {'timestamp' => "#{time.to_s}.#{v}".to_f} : {'_msec' => v}
+      when 'short_message', 'version', 'full_message', 'facility', 'file', 'line'
+        {k => v}
+      else
+        {k.start_with?('_') ? k : "_#{k}" => v}
+      end
+    end
+
+    def parse_timestamp(v)
+      if v.is_a?(Integer) || v.is_a?(Float)
+        v
+      else
+        begin
+          (DateTime.parse(v).strftime("%Q").to_f / 1_000).round(3)
+        rescue ArgumentError
+          v
+        end
+      end
+    end
+
+    def ensure_short_message(gelfentry)
+      return if gelfentry['short_message'] && !gelfentry['short_message'].to_s.strip.empty?
+
+      ['_message', '_msg', '_log', '_record'].each do |key|
+        if gelfentry[key] && !gelfentry[key].to_s.strip.empty?
+          gelfentry['short_message'] = gelfentry.delete(key)
+          return
+        end
+      end
+
+      gelfentry['short_message'] = '(no message)' unless gelfentry['short_message']
+    end
+  end
+end

data/lib/fluent/plugin/out_gelf.rb

@@ -0,0 +1,113 @@
+# typed: true
+require "fluent/plugin/output"
+require "fluent/plugin/gelf_plugin_util"
+
+module Fluent
+  module Plugin
+    class GelfOutput < Fluent::Plugin::Output
+      Fluent::Plugin.register_output('gelf', self)
+
+      include Fluent::GelfPluginUtil
+
+      config_param :use_record_host, :bool, :default => false
+      config_param :add_msec_time, :bool, :default => false
+      config_param :max_bytes, :integer, :default => 32000
+      config_param :host, :string, :default => nil
+      config_param :port, :integer, :default => 12201
+      config_param :protocol, :string, :default => 'udp'
+      config_param :max_chunk_size_type, :string, :default => 'LAN'
+      config_param :tls, :bool, :default => false
+      config_param :tls_options, :hash, :default => {}
+
+      define_method('log') {$log} unless method_defined?(:log)
+
+      DEFAULT_BUFFER_TYPE = 'memory'.freeze
+      DEFAULT_TIMEKEY = 5
+      DEFAULT_TIMEKEY_WAIT = 0
+      MAX_PAYLOAD_SIZE = 1000000 # bytes
+
+      config_section :buffer do
+        config_set_default :@type, DEFAULT_BUFFER_TYPE
+        config_set_default :chunk_keys, ['time']
+        config_set_default :timekey, DEFAULT_TIMEKEY
+        config_set_default :timekey_wait, DEFAULT_TIMEKEY_WAIT
+      end
+
+      def multi_workers_ready?
+        true
+      end
+
+      def formatted_to_msgpack_binary
+        true
+      end
+
+      def configure(conf)
+        super(conf)
+
+        # a destination hostname or IP address must be provided
+        raise Fluent::ConfigError.new("'host' parameter (hostname or address of Graylog2 server) is required") unless conf.has_key?('host')
+
+        # choose protocol to pass to gelf-rb Notifier constructor
+        # (@protocol is used instead of conf['protocol'] to leverage config_param default)
+        if @protocol == 'udp' then @proto = GELF::Protocol::UDP
+        elsif @protocol == 'tcp' then @proto = GELF::Protocol::TCP
+        else raise Fluent::ConfigError.new("'protocol' parameter should be either 'udp' (default) or 'tcp'")
+        end
+      end
+
+      def start
+        super
+
+        options = {:facility => 'fluentd', :protocol => @proto}
+
+        # add tls key (tls_options) only when tls = True
+        # see https://github.com/graylog-labs/gelf-rb/blob/72916932b789f7a6768c3cdd6ab69a3c942dbcef/lib/gelf/notifier.rb#L133-L140
+        if @tls then
+          options[:tls] = @tls_options
+        end
+
+        @conn = GELF::Notifier.new(@host, @port, @max_chunk_size_type, options)
+
+        # Errors are not coming from Ruby so we use direct mapping
+        @conn.level_mapping = 'direct'
+        # file and line from Ruby are in this class, not relevant
+        @conn.collect_file_and_line = false
+      end
+
+      def shutdown
+        super
+      end
+
+      def format(tag, time, record)
+
+        begin
+          make_gelfentry(
+            tag,time,record,
+            {
+              :use_record_host => @use_record_host,
+              :add_msec_time => @add_msec_time,
+              :max_bytes => @max_bytes
+            }
+          ).to_msgpack
+        rescue Exception => e
+          log.error sprintf(
+            'Error trying to serialize %s: %s',
+            record.to_s.force_encoding('UTF-8'),
+            e.message.to_s.force_encoding('UTF-8')
+          )
+        end
+      end
+
+      def write(chunk)
+        chunk.msgpack_each do |data|
+          begin
+            @conn.notify!(data)
+          rescue Exception => e
+            log.warn "failed to flush the buffer.", error_class: e.class.to_s, error: e.to_s, plugin_id: plugin_id
+            raise e
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-gelf-test
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Alex Yamauchi
+- Eric Searcy
+- Bartosz Michaliewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: gelf_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.16.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.16.9
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- bartosz.michalkiewicz@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fluent/plugin/formatter_gelf.rb
+- lib/fluent/plugin/gelf_plugin_util.rb
+- lib/fluent/plugin/out_gelf.rb
+homepage: https://github.com/bmichalkiewicz/fluent-plugin-gelf-best
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Sends Fluentd events Graylog2 by GELF
+test_files: []