fluent-plugin-gelf-cg 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bce2b37b05e487d1f07e6ba2ec126ecb8ec38de7
+  data.tar.gz: 71f11d3b670e79181760f4be080db182001b7ac4
+SHA512:
+  metadata.gz: a3acf21a829dec89aba501c4168625ec1099721dd2025d7685c6f0489267ff95cfe7b61d9ad656efe9eb8d313584bca1d512564d2fd90e54ad92ba127bcf6436
+  data.tar.gz: '096882b29390fbfd2599690782993be4caa0529671bc35fb107c34ff8ad6e83a3521a477e69560b60cc44303c99a6cb485e15f25870a201965756f94b6cce06c'

data/.gitignore

@@ -0,0 +1,4 @@
+/certs/*key*
+/certs/*priv*
+**.gem
+**.gem.sha*

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,11 @@
+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/LICENSE-Apache-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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,32 @@
+# Fluentd GELF output and formatter plugins
+This is a fork of the fluent-plugin-gelf (https://github.com/emsearcy/fluent-plugin-gelf-hs) created in order to publish a gem with working json encoding.
+
+## Overview
+Fluentd GELF output and formatter plugins.
+
+## Installation
+```bash
+gem install fluent-plugin-gelf-hs
+```
+
+## 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
+  [ 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>
+```

data/fluent-plugin-gelf-hs.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-gelf-cg"
+  s.version   = ENV.key?('RUBYGEM_VERSION') ? ENV['RUBYGEM_VERSION'] : '1.0.4'
+  s.authors     = ["Craig Lafferty"]
+  s.email       = ["craigplafferty@gmail.com"]
+  s.homepage    = "https://github.com/craigplafferty/fluent-plugin-gelf-cg"
+  s.summary     = "Buffered fluentd output plugin to GELF (Graylog2)"
+  # When building gems, there is always a stupid warning message thrown
+  # if the summary and description are identical.
+  s.description = s.summary + '.'
+  s.licenses    = ["Apache-2.0"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "fluentd"
+  s.add_runtime_dependency "gelf", ">= 2.0.0"
+end

data/lib/fluent/gelf_util.rb

@@ -0,0 +1,101 @@
+# encoding=utf-8
+module Fluent
+  module GelfUtil
+
+    require 'gelf'
+    require ''
+
+    def make_gelfentry(tag,time,record, conf = {})
+      gelfentry = { '_tag' => tag }
+      if defined? Fluent::EventTime and time.is_a? Fluent::EventTime then
+        gelfentry['timestamp'] = time.sec + (time.nsec.to_f/1000000000).round(3)
+      else
+        gelfentry['timestamp'] = time
+      end
+
+      record.each_pair do |k,v|
+        case k
+        when 'host' then
+          if conf[:use_record_host] then
+            gelfentry['host'] = v
+          else
+            gelfentry['_host'] = v
+          end
+        when 'level' then
+          case v.to_s.downcase[0]
+          # emergency and alert aren't supported by gelf-rb
+          when "0" then
+            gelfentry['level'] = GELF::UNKNOWN
+          when "1", "a" then
+            gelfentry['level'] = GELF::UNKNOWN
+          when "2", "c" then
+            gelfentry['level'] = GELF::FATAL
+          when "3" then
+            gelfentry['level'] = GELF::ERROR
+          when "4", "w" then
+            gelfentry['level'] = GELF::WARN
+          # gelf-rb also skips notice
+          when "5", "n" then
+            gelfentry['level'] = GELF::INFO
+          when "6", "i" then
+            gelfentry['level'] = GELF::INFO
+          when "7", "d" then
+            gelfentry['level'] = GELF::DEBUG
+          when "e" then
+            if v.to_s.length >= 2 and v.to_s.downcase[1] != "r" then
+              gelfentry['level'] = GELF::UNKNOWN
+            else
+              gelfentry['level'] = GELF::ERROR
+            end
+          else
+            gelfentry['_level'] = v
+          end
+        when 'msec' then
+          # msec must be three digits (leading/trailing zeroes)
+          if conf[:add_msec_time] then
+            gelfentry['timestamp'] = "#{time.to_s}.#{v}".to_f
+          else
+            gelfentry['_msec'] = v
+          end
+        when 'short_message', 'full_message', 'facility', 'line', 'file' then
+          gelfentry[k] = v
+        else
+          gelfentry['_'+k] = v
+        end
+      end
+
+      if !gelfentry.key?('short_message') or gelfentry['short_message'].to_s.empty? then
+        # allow other non-empty fields to masquerade as the short_message if it is unset
+        if gelfentry.key?('_message') and !gelfentry['_message'].to_s.empty? then
+          gelfentry['short_message'] = gelfentry.delete('_message')
+        elsif gelfentry.key?('_msg') and !gelfentry['_msg'].to_s.empty? then
+          gelfentry['short_message'] = gelfentry.delete('_msg')
+        elsif gelfentry.key?('_log') and !gelfentry['_log'].to_s.empty? then
+          gelfentry['short_message'] = gelfentry.delete('_log')
+        elsif gelfentry.key?('_record') and !gelfentry['_record'].to_s.empty? then
+          gelfentry['short_message'] = gelfentry.delete('_record')
+        else
+          # we must have a short_message, so provide placeholder
+          gelfentry['short_message'] = '(no message)'
+        end
+      end
+
+      # I realize the nulls are will be treated as unset keys, but it does
+      # tend to make for larger files and data transmissions.
+      return gelfentry.delete_if{ |k,v| v.nil? }
+
+    end
+
+    def make_json(gelfentry,conf)
+      gelfentry['version'] = '1.0'
+
+      gelfentry.each_pair  do |k,v|
+        if v.is_a?(String)
+          gelfentry[k] = v.encode(Encoding.find('UTF-8'), {invalid: :replace, undef: :replace, replace: '???'})
+        end
+      end
+
+      gelfentry.to_json + ( conf.is_a?(Hash) and conf.key?(:record_separator) ? conf[:record_separator] : "\0" )
+    end
+  end
+end

data/lib/fluent/plugin/formatter_gelf.rb

@@ -0,0 +1,33 @@
+require 'fluent/formatter'
+
+module Fluent
+  module TextFormatter
+    class GELFFormatter < Formatter
+
+      Plugin.register_formatter("gelf", self)
+
+      require 'fluent/gelf_util'
+      include GelfUtil
+
+      config_param :use_record_host, :bool, :default => true
+      config_param :add_msec_time, :bool, :default => false
+
+      def configure(conf)
+        super(conf)
+      end
+
+      def format(tag, time, record)
+        gelfentry = make_gelfentry(
+          tag,time,record,
+          {
+            :use_record_host => @use_record_host,
+            :add_msec_time => @add_msec_time
+          }
+        )
+
+        make_json(gelfentry,{})
+      end
+
+    end
+  end
+end

data/lib/fluent/plugin/out_gelf.rb

@@ -0,0 +1,90 @@
+module Fluent
+
+  class GELFOutput < BufferedOutput
+
+    Plugin.register_output("gelf", self)
+
+    require 'gelf'
+    require 'fluent/gelf_util'
+    include GelfUtil
+
+    config_param :use_record_host, :bool, :default => false
+    config_param :add_msec_time, :bool, :default => false
+    config_param :host, :string, :default => nil
+    config_param :port, :integer, :default => 12201
+    config_param :protocol, :string, :default => 'udp'
+    config_param :tls, :bool, :default => false
+    config_param :tls_options, :hash, :default => {}
+
+    def initialize
+      super
+    end
+
+    def configure(conf)
+      super(conf)
+
+      # a destination hostname or IP address must be provided
+      raise ConfigError, "'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 ConfigError, "'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, 'WAN', 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)
+      if defined? Fluent::EventTime and time.is_a? Fluent::EventTime then
+        timestamp = time.sec + (time.nsec.to_f/1000000000).round(3)
+      else
+        timestamp = time
+      end
+
+      make_gelfentry(
+        tag,time,record,
+        {
+          :use_record_host => @use_record_host,
+          :add_msec_time => @add_msec_time
+        }
+      ).to_msgpack
+
+    end
+
+    def write(chunk)
+      chunk.msgpack_each do |data|
+        @conn.notify!(data)
+      end
+    end
+
+    def formatted_to_msgpack_binary
+      true
+    end
+  end
+
+end
+
+# vim: sw=2 ts=2 et

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-gelf-cg
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- Craig Lafferty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gelf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Buffered fluentd output plugin to GELF (Graylog2).
+email:
+- craigplafferty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE-Apache-2.0.txt
+- README.md
+- fluent-plugin-gelf-hs.gemspec
+- lib/fluent/gelf_util.rb
+- lib/fluent/plugin/formatter_gelf.rb
+- lib/fluent/plugin/out_gelf.rb
+homepage: https://github.com/craigplafferty/fluent-plugin-gelf-cg
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Buffered fluentd output plugin to GELF (Graylog2)
+test_files: []