fluent-plugin-windows-eventlog 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e3441c382ee3af99cf0a4b67e1d059903933ec07f837fbec8ae93b11a2b252c
-  data.tar.gz: 2d8555cc1d825218f03deb00b4d83ac2690df8e138395cdef197319b299b2135
+  metadata.gz: a18857ae590d68bafbdd36879831c94cb3aa59e38c21967f5581e83f1c287a5f
+  data.tar.gz: 98948821d94a57e7073e831976c24fe095f1d35ed98c026dc1f897ba40cac7dd
 SHA512:
-  metadata.gz: 26071af5dda0107d6269dd2a4ff641cbf914a4ff7071d725e4297001e9b1606470cb019e578900a57c7738d49d4f8093cdd8ba164db826dd246a88cef4f1b333
-  data.tar.gz: 318b12aa2ef3d12547001ae1dc17a27fe28bf0622c6249f2ec396a5cf77a12ff4b8f54bb994a746eb517a99e4d1cd8b77325ad43e9704f4b01b205fb1019fd13
+  metadata.gz: b5a6bfb26c3204a1adafc121389849b65545b0f66ed4888bcd300091028997499e6a73ce112fb47947ba49e5cfe9d60719ace67b09e1b30336c3ddfe9c2e13d3
+  data.tar.gz: 3dba72eec964475e55f5e8133cf51c0aff3d80ca501c468e82995b347639b49eda6b7b9b13cfeb65b8eddf9960afa6e283d7ad7c8a46d86fc5c2e1d33ae28371

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# Release v0.7.0 - 2020/05/22
+* in_windows_eventlog2: Support multilingual description
+
 # Release v0.6.0 - 2020/04/15
 * Make fluent-plugin-parser-winevt_xml plugin as optional dependency
 * in_windows_eventlog2: Render Ruby hash object directly by default

data/README.md

@@ -142,6 +142,8 @@ fluentd Input plugin for the Windows Event Log using newer Windows Event Logging
       render_as_xml false       # default is false.
       rate_limit 200            # default is -1(Winevt::EventLog::Subscribe::RATE_INFINITE).
       # preserve_qualifiers_on_hash true # default is false.
+      # read_all_channels false # default is false.
+      # description_locale en_US # default is nil. It means that system locale is used for obtaining description.
       <storage>
         @type local             # @type local is the default.
         persistent true         # default is true. Set to false to use in-memory storage.
@@ -187,6 +189,7 @@ fluentd Input plugin for the Windows Event Log using newer Windows Event Logging
 |`rate_limit`      | (option) Specify rate limit to consume EventLog. Default is `Winevt::EventLog::Subscribe::RATE_INFINITE`.|
 |`preserve_qualifiers_on_hash`      | (option) When set up it as true, this plugin preserves "Qualifiers" and "EventID" keys. When set up it as false, this plugin calculates actual "EventID" from "Qualifiers" and removing "Qualifiers". Default is `false`.|
 |`read_all_channels`| (option) Read from all channels. Default is `false`|
+|`description_locale`| (option) Specify description locale. Default is `nil`. See also: [Supported locales](https://github.com/fluent-plugins-nursery/winevt_c#multilingual-description) |
 |`<subscribe>`          | Setting for subscribe channels. |
 
 ##### subscribe section

data/fluent-plugin-winevtlog.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-windows-eventlog"
-  spec.version       = "0.6.0"
+  spec.version       = "0.7.0"
   spec.authors       = ["okahashi117", "Hiroshi Hatake", "Masahiro Nakagawa"]
   spec.email         = ["naruki_okahashi@jbat.co.jp", "cosmo0920.oucc@gmail.com", "repeatedly@gmail.com"]
   spec.summary       = %q{Fluentd Input plugin to read windows event log.}
@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "fluent-plugin-parser-winevt_xml", ">= 0.1.2"
   spec.add_runtime_dependency "fluentd", [">= 0.14.12", "< 2"]
   spec.add_runtime_dependency "win32-eventlog"
-  spec.add_runtime_dependency "winevt_c", ">= 0.7.1"
+  spec.add_runtime_dependency "winevt_c", ">= 0.8.1"
 end

data/lib/fluent/plugin/in_windows_eventlog2.rb

@@ -42,6 +42,7 @@ module Fluent::Plugin
     config_param :rate_limit, :integer, default: Winevt::EventLog::Subscribe::RATE_INFINITE
     config_param :preserve_qualifiers_on_hash, :bool, default: false
     config_param :read_all_channels, :bool, default: false
+    config_param :description_locale, :string, default: nil
 
     config_section :subscribe, param_name: :subscribe_configs, required: false, multi: true do
       config_param :channels, :array
@@ -122,6 +123,15 @@ module Fluent::Plugin
         @keynames.delete('Qualifiers')
       end
       @keynames.delete('EventData') if @parse_description
+
+      locale = Winevt::EventLog::Locale.new
+      if @description_locale && unsupported_locale?(locale, @description_locale)
+        raise Fluent::ConfigError, "'#{@description_locale}' is not supported. Supported locales are: #{locale.each.map{|code, _desc| code}.join(" ")}"
+      end
+    end
+
+    def unsupported_locale?(locale, description_locale)
+      locale.each.select {|c, _d| c.downcase == description_locale.downcase}.empty?
     end
 
     def start
@@ -142,7 +152,7 @@ module Fluent::Plugin
       subscribe.read_existing_events = read_existing_events
       begin
         subscribe.subscribe(ch, "*", bookmark)
-        if !@render_as_xml && @preserve_qualifiers_on_hash && subscribe.respond_to?(:preserve_qualifiers=)
+        if !@render_as_xml && @preserve_qualifiers_on_hash
           subscribe.preserve_qualifiers = @preserve_qualifiers_on_hash
         end
       rescue Winevt::EventLog::Query::Error => e
@@ -150,6 +160,7 @@ module Fluent::Plugin
       end
       subscribe.render_as_xml = @render_as_xml
       subscribe.rate_limit = @rate_limit
+      subscribe.locale = @description_locale if @description_locale
       timer_execute("in_windows_eventlog_#{escape_channel(ch)}".to_sym, @read_interval) do
         on_notify(ch, subscribe)
       end

data/test/plugin/test_in_windows_eventlog2.rb

@@ -111,6 +111,37 @@ class WindowsEventLog2InputTest < Test::Unit::TestCase
                                      ])
       end
     end
+
+    test "invalid description locale" do
+      assert_raise(Fluent::ConfigError) do
+        create_driver config_element("ROOT", "", {"tag" => "fluent.eventlog",
+                                                  "description_locale" => "ex_EX"
+                                                 }, [
+                                       config_element("storage", "", {
+                                                        '@type' => 'local',
+                                                        'persistent' => false
+                                                      })
+                                     ])
+      end
+    end
+  end
+
+  data("Japanese"                => ["ja_JP", false],
+       "English (United States)" => ["en_US", false],
+       "English (UK)"            => ["en_GB", false],
+       "Dutch"                   => ["nl_NL", false],
+       "French"                  => ["fr_FR", false],
+       "German"                  => ["de_DE", false],
+       "Russian"                 => ["ru_RU", false],
+       "Spanish"                 => ["es_ES", false],
+       "Invalid"                 => ["ex_EX", true],
+      )
+  def test_unsupported_locale_p(data)
+    description_locale, expected = data
+    d = create_driver CONFIG
+    locale = Winevt::EventLog::Locale.new
+    result = d.instance.unsupported_locale?(locale, description_locale)
+    assert_equal expected, result
   end
 
   data("application"        => ["Application", "Application"],

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-windows-eventlog
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - okahashi117
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.1
 description: Fluentd Input plugin to read windows event log.
 email:
 - naruki_okahashi@jbat.co.jp