fluent-plugin-windows-eventlog 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4adb2db8018eb70bda4f9c33114901fe73a6e9d418795eacd6c082d2dc5cbe28
-  data.tar.gz: e5061ffe31dd546e51c59cbaac8be76f59a72d2408d5a0d8005cfead39800a6e
+  metadata.gz: 7e3441c382ee3af99cf0a4b67e1d059903933ec07f837fbec8ae93b11a2b252c
+  data.tar.gz: 2d8555cc1d825218f03deb00b4d83ac2690df8e138395cdef197319b299b2135
 SHA512:
-  metadata.gz: baf4475fcd9f425e3e745badc49348d601f77ff932ba73f475a8df7d92a8d464a7f66c1eaaadeee89be2ec9a0655a62c49b900f3e4eb74ebc7b0b268ad4c3c8c
-  data.tar.gz: 1fc8df91e614f7ff3e03fa3dea159743d0ffc86bfec538c2351b03126970886c1bdca30887663bc18eb2a75db94f404a8b3add6a528363a94314924a61265466
+  metadata.gz: 26071af5dda0107d6269dd2a4ff641cbf914a4ff7071d725e4297001e9b1606470cb019e578900a57c7738d49d4f8093cdd8ba164db826dd246a88cef4f1b333
+  data.tar.gz: 318b12aa2ef3d12547001ae1dc17a27fe28bf0622c6249f2ec396a5cf77a12ff4b8f54bb994a746eb517a99e4d1cd8b77325ad43e9704f4b01b205fb1019fd13

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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
+
 # Release v0.5.4 - 2020/04/10
 * Permit using nokogiri 1.11.0
 

data/README.md

@@ -139,7 +139,7 @@ fluentd Input plugin for the Windows Event Log using newer Windows Event Logging
       read_existing_events false
       read_interval 2
       tag winevt.raw
-      render_as_xml false       # default is true.
+      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.
       <storage>
@@ -166,7 +166,7 @@ fluentd Input plugin for the Windows Event Log using newer Windows Event Logging
 
 **NOTE:** When `Description` contains error message such as `The message resource is present but the message was not found in the message table.`, eventlog's resource file (.mui) related to error generating event is something wrong. This issue is also occurred in built-in Windows Event Viewer which is the part of Windows management tool.
 
-**NOTE:** When `render_as_xml` as `false`, the dependent winevt_c gem renders Windows EventLog as Ruby Hash object directly. This reduces bottleneck to consume EventLog. Specifying `render_as_xml` as `false` should be faster consuming than `render_as_xml` as `true` case.
+**NOTE:** When `render_as_xml` as `true`, `fluent-plugin-parser-winevt_xml` plugin should be needed to parse XML rendered Windows EventLog string.
 
 **NOTE:** If you encountered CPU spike due to massively huge EventLog channel, `rate_limit` parameter may help you. Currently, this paramter can handle the multiples of 10 or -1(`Winevt::EventLog::Subscribe::RATE_INFINITE`).
 
@@ -183,7 +183,7 @@ fluentd Input plugin for the Windows Event Log using newer Windows Event Logging
 |`parse_description`| (option) parse `description` field and set parsed result into the record. `Description` and `EventData` fields are removed|
 |`read_from_head`   | **Deprecated** (option) Start to read the entries from the oldest, not from when fluentd is started. Defaults to `false`.|
 |`read_existing_events` | (option) Read the entries which already exist before fluentd is started. Defaults to `false`.|
-|`render_as_xml` | (option) Render Windows EventLog as XML or Ruby Hash object directly. Defaults to `true`.|
+|`render_as_xml` | (option) Render Windows EventLog as XML or Ruby Hash object directly. Defaults to `false`.|
 |`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`|

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.5.4"
+  spec.version       = "0.6.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.}
@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "test-unit", "~> 3.2.0"
+  spec.add_development_dependency "nokogiri", [">= 1.10", "< 1.12"]
+  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 "nokogiri", [">= 1.10", "< 1.12"]
-  spec.add_runtime_dependency "fluent-plugin-parser-winevt_xml", ">= 0.1.2"
 end

data/lib/fluent/plugin/in_windows_eventlog2.rb

@@ -38,7 +38,7 @@ module Fluent::Plugin
     config_param :read_from_head, :bool, default: false, deprecated: "Use `read_existing_events' instead."
     config_param :read_existing_events, :bool, default: false
     config_param :parse_description, :bool, default: false
-    config_param :render_as_xml, :bool, default: true
+    config_param :render_as_xml, :bool, default: false
     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

data/test/plugin/test_in_windows_eventlog2.rb

@@ -15,6 +15,14 @@ class WindowsEventLog2InputTest < Test::Unit::TestCase
                                            })
                           ])
 
+  XML_RENDERING_CONFIG = config_element("ROOT", "", {"tag" => "fluent.eventlog",
+                                                     "render_as_xml" => true}, [
+                                          config_element("storage", "", {
+                                                           '@type' => 'local',
+                                                           'persistent' => false
+                                                         })
+                                        ])
+
   def create_driver(conf = CONFIG)
     Fluent::Test::Driver::Input.new(Fluent::Plugin::WindowsEventLog2Input).configure(conf)
   end
@@ -25,7 +33,7 @@ class WindowsEventLog2InputTest < Test::Unit::TestCase
     assert_equal 2, d.instance.read_interval
     assert_equal [], d.instance.channels
     assert_false d.instance.read_existing_events
-    assert_true d.instance.render_as_xml
+    assert_false d.instance.render_as_xml
   end
 
   sub_test_case "configure" do
@@ -389,7 +397,8 @@ EOS
   end
 
   def test_write_with_none_parser
-    d = create_driver(config_element("ROOT", "", {"tag" => "fluent.eventlog"}, [
+    d = create_driver(config_element("ROOT", "", {"tag" => "fluent.eventlog",
+                                                  "render_as_xml" => true}, [
                                        config_element("storage", "", {
                                                         '@type' => 'local',
                                                         'persistent' => false
@@ -419,7 +428,8 @@ EOS
   end
 
   def test_write_with_winevt_xml_parser_without_qualifiers
-    d = create_driver(config_element("ROOT", "", {"tag" => "fluent.eventlog"}, [
+    d = create_driver(config_element("ROOT", "", {"tag" => "fluent.eventlog",
+                                                  "render_as_xml" => true}, [
                                        config_element("storage", "", {
                                                         '@type' => 'local',
                                                         'persistent' => false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-windows-eventlog
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - okahashi117
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,87 +55,87 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: fluentd
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.12
+        version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
+        version: '1.12'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.12
+        version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: win32-eventlog
+  name: fluent-plugin-parser-winevt_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 0.1.2
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
-  name: winevt_c
+  name: fluentd
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.14.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.14.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: win32-eventlog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: fluent-plugin-parser-winevt_xml
+  name: winevt_c
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.7.1
 description: Fluentd Input plugin to read windows event log.
 email:
 - naruki_okahashi@jbat.co.jp