fluent-plugin-utmpx 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abd8859b57661c356e98807d241a7bb4fdfa4ae6149c389ce39c6e8aeab534e3
+  data.tar.gz: 77eda2936a8c2e1995b52bce6880af8d0c577441bd3b0ab6802a442daa7d1f5a
+SHA512:
+  metadata.gz: 4b2ee2617ed6020cd7dcb4f09c4bbe3877122ff6b843d8d80fbcce7d0e585ef131bac42dade48ecbc26ec42010c70773adf5a22135e33cfaeb6a122c35ff79fc
+  data.tar.gz: 4d606ea3f9e04594db21ac2780f41e272a6f7ea76f449cbb47f4499d01214938fcb9e246871b474a3ed72fb650bd32a134a07352d277df2b5343a5e1910bd0b0

data/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+    name: Ruby ${{ matrix.ruby }} unit testing on ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run the default task
+      run: |
+        gem install bundler
+        bundle install
+        TESTOPTS="--verbose" bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# CHANGELOG
+
+## 0.3.0 (2021-03-30)
+
+* Fixed a bug that the content of previous event is discarded
+  with multiple event stream. In the previous version, it always return latest event.
+* Changed to use linux-utmpx 0.2.0
+
+## 0.2.0 (2021-03-29)
+
+* `pos_file` configuration parameter was supported.
+

data/Gemfile

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

data/LICENSE

@@ -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,95 @@
+# fluent-plugin-utmpx
+
+[Fluentd](https://fluentd.org/) input plugin to extract `/var/log/wtmp` or `/var/run/utmp`.
+
+This plugin uses [linux-utmpx](https://github.com/fluent-plugins-nursery/linux-utmpx) to parse above files.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-utmpx
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-utmpx"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+## Fluent::Plugin::UtmpxInput
+
+| parameter | type               | description                             | default |
+|-----------|--------------------|-----------------------------------------|---------|
+| path      | string (required)  | Path to wtmp,utmp                       |         |
+| tag       | string (required)  | Tag string                              |         |
+| interval  | integer (optional) | Interval to check `path` (N seconds)    | `10`    |
+| pos_file  | string (required)  | Record the position it last read into this file |         |
+
+
+The extracted record contains:
+
+| field | type   | description       |
+|-------|--------|-------------------|
+| type  | string | Type of login. It must be either `EMPTY`, `RUN_LVL`, `BOOT_TIME`, `NEW_TIME`, `OLD_TIME`, `INIT_PROCESS`, `LOGIN_PROCESS`, `USER_PROCESS`, `DEAD_PROCESS` or `ACCOUNTING`. |
+| pid  | integer | Process ID |
+| line  | string | Device name (e.g. `pts/N`) |
+| user  | string | Username |
+| host  | string | Hostname for remote login |
+
+## Usage
+
+Here is the example to use `utmpx` input plugin.
+
+```
+<source>
+  @type utmpx
+  tag wtmp
+  pos_file wtmp.pos
+  path /var/log/wtmp
+</source>
+
+<match **>
+  @type stdout
+</match>
+```
+
+Then you can retrieve these events.
+
+```
+2021-03-05 09:03:42.629627000 +0900 wtmp: {"user":"kenhys","type":"RUN_LVL","pid":53,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 09:03:46.521452000 +0900 wtmp: {"user":"kenhys","type":"INIT_PROCESS","pid":1673,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 09:03:46.521452000 +0900 wtmp: {"user":"kenhys","type":"LOGIN_PROCESS","pid":1673,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 09:03:58.026903000 +0900 wtmp: {"user":"kenhys","type":"USER_PROCESS","pid":3018,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 09:05:21.940292000 +0900 wtmp: {"user":"kenhys","type":"USER_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 09:05:22.473919000 +0900 wtmp: {"user":"kenhys","type":"USER_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 09:05:22.921871000 +0900 wtmp: {"user":"kenhys","type":"USER_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 09:05:23.337814000 +0900 wtmp: {"user":"kenhys","type":"USER_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 09:05:23.753983000 +0900 wtmp: {"user":"kenhys","type":"USER_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 09:05:24.170198000 +0900 wtmp: {"user":"kenhys","type":"USER_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 20:54:58.325838000 +0900 wtmp: {"user":"kenhys","type":"DEAD_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"}
+2021-03-05 20:54:58.941467000 +0900 wtmp: {"user":"kenhys","type":"DEAD_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"} 
+2021-03-05 20:54:59.459935000 +0900 wtmp: {"user":"kenhys","type":"DEAD_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"} 
+2021-03-05 20:54:59.923351000 +0900 wtmp: {"user":"kenhys","type":"DEAD_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"} 
+2021-03-05 21:31:43.002278000 +0900 wtmp: {"user":"kenhys","type":"DEAD_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"} 
+2021-03-05 21:31:43.900405000 +0900 wtmp: {"user":"kenhys","type":"DEAD_PROCESS","pid":10248,"line":"pts/8","host":"tmux(9528).%4"} 
+2021-03-05 21:32:06.755036000 +0900 wtmp: {"user":"kenhys","type":"DEAD_PROCESS","pid":0,"line":"pts/8","host":"tmux(9528).%4"}
+```
+
+
+## Copyright
+
+* Copyright(c) 2021- Kentaro Hayashi
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/examples/in_utmp.conf

@@ -0,0 +1,13 @@
+<source>
+  @type utmpx
+  tag utmp
+  path /var/run/utmp
+  <parse>
+    @type none
+  </parse>
+</source>
+
+<match **>
+  @type stdout
+</match>
+

data/examples/in_wtmp.conf

@@ -0,0 +1,10 @@
+<source>
+  @type utmpx
+  tag wtmp
+  path /var/log/wtmp
+</source>
+
+<match **>
+  @type stdout
+</match>
+

data/examples/utmp.conf

@@ -0,0 +1,11 @@
+<source>
+  @type utmpx
+  tag utmp
+  path /var/run/utmp
+  pos_file utmp.pos
+</source>
+
+<match **>
+  @type stdout
+</match>
+

data/examples/wtmp.conf

@@ -0,0 +1,11 @@
+<source>
+  @type utmpx
+  tag wtmp
+  pos_file wtmp.pos
+  path /var/log/wtmp
+</source>
+
+<match **>
+  @type stdout
+</match>
+

data/fluent-plugin-utmpx.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-utmpx"
+  spec.version = "0.3.0"
+  spec.authors = ["Kentaro Hayashi"]
+  spec.email   = ["kenhys@gmail.com"]
+
+  spec.summary       = %q{Fluentd Parser plugin to parse login records}
+  spec.description   = %q{Fluentd Parser plugin to parse /var/log/wtmp,/var/run/utmp}
+  spec.homepage      = "https://github.com/fluent-plugins-nursery/fluent-plugin-utmpx"
+  spec.license       = "Apache-2.0"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "linux-utmpx", "~> 0.2.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+
+  spec.add_development_dependency "bundler", "~> 2.2.15"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_development_dependency "webrick"
+end

data/lib/fluent/plugin/in_utmpx.rb

@@ -0,0 +1,114 @@
+#
+# Copyright 2021- Kentaro Hayashi
+#
+# 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.
+
+require "fluent/plugin/input"
+require "fluent/plugin/in_tail/position_file"
+require 'fluent/variable_store'
+require "linux/utmpx"
+
+Fluent::FileWrapper = File
+
+module Fluent
+  module Plugin
+    class UtmpxInput < Fluent::Plugin::Input
+      Fluent::Plugin.register_input("utmpx", self)
+
+      helpers :timer
+
+      desc "Path to wtmp,utmp"
+      config_param :path, :string
+      desc "Tag string"
+      config_param :tag, :string
+      desc "Interval to check `path` (N seconds)"
+      config_param :interval, :integer, default: 10
+      desc "Record the position it last read into this file"
+      config_param :pos_file, :string
+
+      def configure(conf)
+        @variable_store = Fluent::VariableStore.fetch_or_build(:in_utmpx)
+        super
+        @utmpx = Linux::Utmpx::UtmpxParser.new
+        @buffer = ""
+        @tail_position = 0
+        @previous_position = 0
+
+        if @variable_store.key?(@pos_file) && !called_in_test?
+          plugin_id_using_this_path = @variable_store[@pos_file]
+          raise Fluent::ConfigError, "Other 'in_utmpx' plugin already use same pos_file path: plugin_id = #{plugin_id_using_this_path}, pos_file path = #{@pos_file}"
+        end
+        @variable_store[@pos_file] = self.plugin_id
+      end
+
+      def start
+        super
+
+        pos_file_dir = File.dirname(@pos_file)
+        FileUtils.mkdir_p(pos_file_dir, mode: Fluent::DEFAULT_DIR_PERMISSION) unless Dir.exist?(pos_file_dir)
+        @pf_file = File.open(@pos_file, File::RDWR|File::CREAT|File::BINARY, Fluent::DEFAULT_FILE_PERMISSION)
+        @pf_file.sync = true
+        target_info = TailInput::TargetInfo.new(@path, Fluent::FileWrapper.stat(@path).ino)
+        @pf = TailInput::PositionFile.load(@pf_file, false, {target_info.path => target_info}, logger: log)
+
+        timer_execute(:execute_utmpx, @interval, &method(:refresh_watchers))
+      end
+
+      def refresh_watchers
+        @tail_position = Fluent::FileWrapper.stat(@path).size
+        @pe = @pf[TailInput::TargetInfo.new(@path, Fluent::FileWrapper.stat(@path).ino)]
+        return if (@tail_position - @pe.read_pos) == 0
+
+        if (@tail_position - @pe.read_pos) < 0
+          # may be truncated, read from head
+          @pe.update_pos(0)
+          log.warn("#{@path} may be truncated")
+          return
+        end
+
+        count = (@tail_position - @pe.read_pos) / @utmpx.num_bytes
+        es = MultiEventStream.new
+        File.open(@path) do |io|
+          io.seek(@pe.read_pos)
+          count.times do |n|
+            time, record = parse_entry(@utmpx.read(io))
+            es.add(time,record)
+          end
+          @pe.update_pos(@pe.read_pos + count * @utmpx.num_bytes)
+          router.emit_stream(@tag, es)
+        end
+      end
+
+      def shutdown
+        @pf_file.close if @pf_file
+      end
+
+      def multi_workers_ready?
+        false
+      end
+
+      private
+
+      def parse_entry(entry)
+        record = {
+          user: entry.user.dup,
+          type: entry.type.dup,
+          pid: entry.pid.to_i,
+          line: entry.line.dup,
+          host: entry.host.dup
+        }
+        [entry.time, record]
+      end
+    end
+  end
+end

data/test/fixtures/Makefile

@@ -0,0 +1,4 @@
+all: $(patsubst %.txt,%.dump,$(wildcard *.txt))
+
+%.dump: %.txt
+	utmpdump -r < $< -o $@

data/test/fixtures/alice_login.txt

@@ -0,0 +1 @@
+[7] [121110] [:0  ] [alice  ] [tty7        ] [:0                  ] [127.0.0.1        ] [2021-03-23T06:49:58,716235+00:00]

data/test/helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/parser"
+require "fluent/test/driver/input"
+require "fluent/test/helpers"
+require "linux/utmpx"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)
+
+def dump_fixture_path(name)
+  File.join(File.dirname(__FILE__),
+            "fixtures",
+            "#{name}.dump")
+end

data/test/plugin/test_in_utmpx.rb

@@ -0,0 +1,190 @@
+require "helper"
+require "fluent/plugin/in_utmpx"
+
+class UtmpxInputTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+    cleanup_directory(TMP_DIR)
+  end
+
+  teardown do
+    cleanup_directory(TMP_DIR)
+    Fluent::Engine.stop
+  end
+
+  CONFIG = config_element('ROOT')
+
+  TMP_DIR = File.expand_path(File.dirname(__FILE__) + "/../tmp/utmpx")
+
+  sub_test_case "configure" do
+    def test_missing_path
+      assert_raise Fluent::ConfigError.new("'path' parameter is required") do
+        create_driver(CONFIG + config_element("", "", { "tag" => "utmpx",
+                                                        "pos_file" => "wtmp.pos" }))
+      end
+    end
+
+    def test_missing_tag
+      assert_raise Fluent::ConfigError.new("'tag' parameter is required") do
+        create_driver(CONFIG + config_element("", "", { "path" => "/var/log/wtmp",
+                                                        "pos_file" => "wtmp.pos" }))
+      end
+    end
+
+    def test_missing_pos_file
+      assert_raise Fluent::ConfigError.new("'pos_file' parameter is required") do
+        create_driver(CONFIG + config_element("", "", { "path" => "/var/log/wtmp",
+                                                        "tag" => "wtmp" }))
+      end
+    end
+
+    def test_default_parameters
+      d = create_driver(utmpx_config)
+      assert_equal("", d.instance.path)
+      assert_equal("utmpx", d.instance.tag)
+      assert_equal(10, d.instance.interval)
+      assert_equal(utmpx_pos_path, d.instance.pos_file)
+    end
+  end
+
+  sub_test_case "parse wtmp/utmp" do
+    def test_one_record
+      FileUtils.touch(wtmp_path)
+      d = create_driver(utmpx_config(wtmp_path))
+      d.run(expect_emits: 1) do
+        append_utmpx
+      end
+      assert_equal(1, d.events.size)
+    end
+
+    def test_multiple_records
+      FileUtils.touch(wtmp_path)
+      d = create_driver(utmpx_config(wtmp_path))
+      d.run(expect_emits: 1) do
+        File.open(wtmp_path, "ab") do |io|
+          3.times do
+            append_utmpx
+          end
+        end
+      end
+      assert_equal(3, d.events.size)
+    end
+
+    def test_append_record
+      create_wtmp
+      d = create_driver(utmpx_config(wtmp_path))
+      d.run(expect_emits: 1) do
+        append_utmpx
+      end
+      assert_equal(2, d.events.size)
+    end
+  end
+
+  sub_test_case "pos_file use cases" do
+    def test_pos_file
+      create_wtmp
+      @tail_position = Fluent::FileWrapper.stat(wtmp_path).size
+      File.open(utmpx_pos_path, "w+") do |file|
+        target_info = Fluent::Plugin::TailInput::TargetInfo.new(wtmp_path, Fluent::FileWrapper.stat(wtmp_path).ino)
+        @pf = Fluent::Plugin::TailInput::PositionFile.new(file, false, {wtmp_path => target_info}, logger: nil)
+        @pe = @pf[target_info]
+        @pe.update_pos(@tail_position)
+      end
+      d = create_driver(utmpx_config(wtmp_path))
+      d.run(expect_emits: 1) do
+        append_utmpx
+      end
+      assert_equal(1, d.events.size)
+    end
+
+    def test_truncated
+      create_wtmp
+      10.times do
+        append_utmpx
+      end
+      @tail_position = Fluent::FileWrapper.stat(wtmp_path).size
+      File.open(utmpx_pos_path, "w+") do |file|
+        target_info = Fluent::Plugin::TailInput::TargetInfo.new(wtmp_path, Fluent::FileWrapper.stat(wtmp_path).ino)
+        @pf = Fluent::Plugin::TailInput::PositionFile.new(file, false, {wtmp_path => target_info}, logger: nil)
+        @pe = @pf[target_info]
+        @pe.update_pos(@tail_position)
+      end
+      File.open(wtmp_path, "w+") do |file|
+        file.truncate(0)
+      end
+      d = create_driver(utmpx_config(wtmp_path))
+      d.run(expect_emits: 1) do
+        append_utmpx(user: "bob")
+        append_utmpx(user: "carol")
+      end
+      who = d.events.collect do |event|
+        event.last[:user]
+      end
+      assert_equal(["bob", "carol"], who)
+      assert_equal(2, d.events.size)
+    end
+  end
+
+  private
+
+  def wtmp_path
+    File.join(TMP_DIR, "wtmp")
+  end
+
+  def utmpx_pos_path
+    File.join(TMP_DIR, "utmpx.pos")
+  end
+
+  def create_wtmp(path = "#{TMP_DIR}/wtmp")
+    File.open(path, "wb") do |io|
+      utmpx = Linux::Utmpx::UtmpxParser.new(
+        ut_type: Linux::Utmpx::Type::LOGIN_PROCESS,
+        ut_user: "alice",
+        ut_pid: 10000,
+        ut_line: "pts/1",
+        ut_host: "localhost"
+      )
+      utmpx.write(io)
+    end
+  end
+
+  def utmpx_config(path = "", input = "utmpx", tag = "utmpx", pos_file = "#{TMP_DIR}/utmpx.pos" )
+    CONFIG + config_element("", "", { "@type" => input,
+                                      "path" => path,
+                                      "tag" => tag,
+                                      "pos_file" => pos_file })
+  end
+
+  def append_utmpx(path: wtmp_path, type: Linux::Utmpx::Type::LOGIN_PROCESS, user: "alice", host: "localhost", line: "pts/1", pid: 10000)
+    File.open(path, "ab") do |io|
+      utmpx = Linux::Utmpx::UtmpxParser.new(
+        ut_type: type,
+        ut_user: user,
+        ut_pid: pid,
+        ut_line: line,
+        ut_host: host
+      )
+      utmpx.write(io)
+    end
+  end
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Input.new(Fluent::Plugin::UtmpxInput).configure(conf)
+  end
+
+  def cleanup_directory(path)
+    unless Dir.exist?(path)
+      FileUtils.mkdir_p(path)
+      return
+    end
+    begin
+      FileUtils.rm_f(path, secure:true)
+    rescue ArgumentError
+      FileUtils.rm_f(path) # For Ruby 2.6 or before.
+    end
+    if File.exist?(path)
+      FileUtils.remove_entry_secure(path, true)
+    end
+    FileUtils.mkdir_p(path)
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-utmpx
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Kentaro Hayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: linux-utmpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.15
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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: Fluentd Parser plugin to parse /var/log/wtmp,/var/run/utmp
+email:
+- kenhys@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/in_utmp.conf
+- examples/in_wtmp.conf
+- examples/utmp.conf
+- examples/wtmp.conf
+- fluent-plugin-utmpx.gemspec
+- lib/fluent/plugin/in_utmpx.rb
+- test/fixtures/Makefile
+- test/fixtures/alice_login.dump
+- test/fixtures/alice_login.txt
+- test/helper.rb
+- test/plugin/test_in_utmpx.rb
+homepage: https://github.com/fluent-plugins-nursery/fluent-plugin-utmpx
+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.1.4
+signing_key: 
+specification_version: 4
+summary: Fluentd Parser plugin to parse login records
+test_files:
+- test/fixtures/Makefile
+- test/fixtures/alice_login.dump
+- test/fixtures/alice_login.txt
+- test/helper.rb
+- test/plugin/test_in_utmpx.rb