fluent-plugin-sumologic_output 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b2260d6a95c18397cc58bb448924c2a24f3c28c
-  data.tar.gz: 1276401aa4df5460ee70dfb4424202874800e997
+  metadata.gz: 49e311e7b4512f25f99942f69fdf4c90405d2351
+  data.tar.gz: ff095f8c1176898c8a7f97c65abc5a0c816f88db
 SHA512:
-  metadata.gz: '09326bd5f95564b91f9d124ce397c292d2069734e3e75bd0d2b73de4cb09389ee903dbbbbad177d299d527d6c8c68dc723fd5d69727f7eaa92ffef223b610b07'
-  data.tar.gz: 80c274b634f568abe34b5eaaeb9521b6407181af7244229fd2c0f5bd28eb58e7ed1435348c67603fcf21dce6d773758d0508da4402ad4d24733d44a19221f058
+  metadata.gz: 7c2c9c4a24a557cecb6e426b5069d5dfa6f6750996a262f8448cd5d79ec7192836ee1c9a0c332c93b2cd54596d48f01e0d032c8ff9b7777ca2ba939d7ba1c20e
+  data.tar.gz: 472fb4fa5312d2734704164e49b073a1b44e378690c9471c95be6f7696103f4e1daf6304c124353c6de128cd46986eda808fa91e41cecab154da1ceab5efc76c

data/Gemfile

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

data/README.md

@@ -21,6 +21,7 @@ Configuration options for fluent.conf are:
   * json - Logs will appear in SumoLogic in json format.
   * json_merge - Same as json but merge content of `log_key` into the top level and strip `log_key`
 * `log_key` - Used to specify the key when merging json or sending logs in text format (default `message`)
+* `open_timeout` - Set timeout seconds to wait until connection is opened.
 
 Reading from the JSON formatted log files with `in_tail` and wildcard filenames:
 ```

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.warning = false
+end
+
+task :default => :test

data/fluent-plugin-sumologic_output.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-sumologic_output"
-  gem.version       = "0.0.6"
+  gem.version       = "0.0.7"
   gem.authors       = ["Steven Adams"]
   gem.email         = ["stevezau@gmail.com"]
   gem.description   = %q{Output plugin to SumoLogic HTTP Endpoint}
@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "bundler", "~> 1.3"
   gem.add_development_dependency "rake"
   gem.add_runtime_dependency "fluentd"
+  gem.add_development_dependency 'test-unit', '~> 3.1.0'
 end

data/lib/fluent/plugin/out_sumologic.rb

@@ -3,9 +3,10 @@ require 'net/https'
 require 'yajl'
 
 class SumologicConnection
-  def initialize(endpoint, verify_ssl)
+  def initialize(endpoint, verify_ssl, open_timeout)
     @endpoint_uri = URI.parse(endpoint.strip)
     @verify_ssl = verify_ssl
+    @open_timeout = open_timeout
   end
 
   def publish(raw_data, source_host=nil, source_category=nil, source_name=nil)
@@ -30,6 +31,7 @@ class SumologicConnection
     client = Net::HTTP.new(@endpoint_uri.host, @endpoint_uri.port)
     client.use_ssl = true
     client.verify_mode = @verify_ssl ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+    client.open_timeout = @open_timeout
     client
   end
 end
@@ -47,6 +49,8 @@ class Sumologic < Fluent::BufferedOutput
   config_param :source_name_key, :string, :default => 'source_name'
   config_param :source_host, :string, :default => nil
   config_param :verify_ssl, :bool, :default => true
+  config_param :delimiter, :string, :default => "."
+  config_param :open_timeout, :integer, :default => 60
 
   # This method is called before starting.
   def configure(conf)
@@ -58,7 +62,7 @@ class Sumologic < Fluent::BufferedOutput
       raise Fluent::ConfigError, "Invalid log_format #{conf['log_format']} must be text, json or json_merge"
     end
 
-    @sumo_conn = SumologicConnection.new(conf['endpoint'], @verify_ssl)
+    @sumo_conn = SumologicConnection.new(conf['endpoint'], conf['verify_ssl'], conf['open_timeout'].to_i)
     super
   end
 
@@ -98,10 +102,16 @@ class Sumologic < Fluent::BufferedOutput
     [tag, time, record].to_msgpack
   end
 
-  def sumo_key(sumo)
-    source_name = sumo['source'] || @source_name
-    source_category = sumo['category'] || @source_category
-    source_host = sumo['host'] || @source_host
+  def sumo_key(sumo_metadata, record, tag)
+    source_name = sumo_metadata['source'] || @source_name
+    source_name = expand_param(source_name, tag, nil, record)
+
+    source_category = sumo_metadata['category'] || @source_category
+    source_category = expand_param(source_category, tag, nil, record)
+
+    source_host = sumo_metadata['host'] || @source_host
+    source_host = expand_param(source_host, tag, nil, record)
+
     "#{source_name}:#{source_category}:#{source_host}"
   end
 
@@ -110,6 +120,35 @@ class Sumologic < Fluent::BufferedOutput
     time.to_s.length == 13 ? time : time * 1000
   end
 
+  # copy from https://github.com/uken/fluent-plugin-elasticsearch/commit/1722c58758b4da82f596ecb0a5075d3cb6c99b2e#diff-33bfa932bf1443760673c69df745272eR221
+  def expand_param(param, tag, time, record)
+    # check for '${ ... }'
+    #   yes => `eval`
+    #   no  => return param
+    return param if (param =~ /\${.+}/).nil?
+
+    # check for 'tag_parts[]'
+      # separated by a delimiter (default '.')
+    tag_parts = tag.split(@delimiter) unless (param =~ /tag_parts\[.+\]/).nil? || tag.nil?
+
+    # pull out section between ${} then eval
+    inner = param.clone
+    while inner.match(/\${.+}/)
+      to_eval = inner.match(/\${(.+?)}/){$1}
+
+      if !(to_eval =~ /record\[.+\]/).nil? && record.nil?
+        return to_eval
+      elsif !(to_eval =~/tag_parts\[.+\]/).nil? && tag_parts.nil?
+        return to_eval
+      elsif !(to_eval =~/time/).nil? && time.nil?
+        return to_eval
+      else
+        inner.sub!(/\${.+?}/, eval( to_eval ))
+      end
+    end
+    inner
+  end
+
   # This method is called every flush interval. Write the buffer chunk
   def write(chunk)
     messages_list = {}
@@ -120,7 +159,7 @@ class Sumologic < Fluent::BufferedOutput
       # https://github.com/uken/fluent-plugin-elasticsearch/commit/8597b5d1faf34dd1f1523bfec45852d380b26601#diff-ae62a005780cc730c558e3e4f47cc544R94
       next unless record.is_a? Hash
       sumo_metadata = record.fetch('_sumo_metadata', {'source' => record[@source_name_key]})
-      key = sumo_key(sumo_metadata)
+      key = sumo_key(sumo_metadata, record, tag)
       log_format = sumo_metadata['log_format'] || @log_format
 
       # Strip any unwanted newlines

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'fluent/test'

data/test/plugin/test_out_sumologic.rb

@@ -0,0 +1,41 @@
+require 'helper'
+require 'fluent/test/driver/output'
+
+class SumologicOutput < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+    require 'fluent/plugin/out_sumologic'
+    @driver = nil
+    log = Fluent::Engine.log
+    log.out.logs.slice!(0, log.out.logs.length)
+  end
+
+  def driver(conf='')
+    @driver ||= Fluent::Test::Driver::Output.new(Sumologic).configure(conf)
+  end
+
+  def test_configure
+    config = %{
+      endpoint        https://SUMOLOGIC_URL
+      log_format      text
+      log_key         LOG_KEY
+      source_category SOURCE_CATEGORY
+      source_name     SOURCE_NAME
+      source_name_key SOURCE_NAME_KEY
+      source_host     SOURCE_HOST
+      verify_ssl      false
+      open_timeout    10
+    }
+    instance = driver(config).instance
+
+    assert_equal instance.endpoint, 'https://SUMOLOGIC_URL'
+    assert_equal instance.log_format, 'text'
+    assert_equal instance.log_key, 'LOG_KEY'
+    assert_equal instance.source_category, 'SOURCE_CATEGORY'
+    assert_equal instance.source_name, 'SOURCE_NAME'
+    assert_equal instance.source_name_key, 'SOURCE_NAME_KEY'
+    assert_equal instance.source_host, 'SOURCE_HOST'
+    assert_equal instance.verify_ssl, false
+    assert_equal instance.open_timeout, 10
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-sumologic_output
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Steven Adams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 description: Output plugin to SumoLogic HTTP Endpoint
 email:
 - stevezau@gmail.com
@@ -60,10 +74,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - fluent-plugin-sumologic_output.gemspec
 - lib/fluent/plugin/out_sumologic.rb
+- test/helper.rb
+- test/plugin/test_out_sumologic.rb
 homepage: https://github.com/SumoLogic/fluentd-output-sumologic
 licenses:
 - Apache-2.0
@@ -88,4 +106,6 @@ rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Output plugin to SumoLogic HTTP Endpoint
-test_files: []
+test_files:
+- test/helper.rb
+- test/plugin/test_out_sumologic.rb