fluent-plugin-systemd 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51791abc856b31177f2053533b7d8d3cf31e9d7d
-  data.tar.gz: 5e306cc82ca65d76d69bf71f50208b5d3aaed005
+SHA256:
+  metadata.gz: 9e95e3feb43d74663b14476d96c92a536ecefdc7c32dc9be68d778640c2fe3e1
+  data.tar.gz: e45bd0896dd0f6e0df61006a9bfc13426f78c1aa0da2eb0b7d60f129d7040793
 SHA512:
-  metadata.gz: 413d7ff33b0224b0af859e58b58045781fda8dd35139a9b11db5cc37f3a33f9a6f26527de8aa380e78a963049588fb01940d2b4414ac8f3b638b49bb24c3d71f
-  data.tar.gz: 6fcab5af997ce17913cd44e7cd81531fcc399e1a998f39dfebb2c7b7721eda29b32f1b6e9ef7c0cf744809aee1915cea25ec224c8e4b9e04bcdf119b4cfe6bd1
+  metadata.gz: 94ee7b4de1a4fec10b4951861b28b27a39d554f3788378549e8c5bac3632544f7201b03f26c619fa0135535c88c2a1a483a671e6b739c254fe96b67fb280cb63
+  data.tar.gz: 27a1148fca72b0b61f4f90c977aebbe3a9e358e78fa81538c6c04e9cdcf04a0894b99e288ed18f4e5779feb97063ebee72e39c58b958ff3e287923f4b4cc2d71

data/README.md

@@ -1,6 +1,6 @@
 # systemd plugin for [Fluentd](http://github.com/fluent/fluentd)
 
-[![Build Status](https://travis-ci.org/reevoo/fluent-plugin-systemd.svg?branch=master)](https://travis-ci.org/reevoo/fluent-plugin-systemd) [![Code Climate GPA](https://codeclimate.com/github/reevoo/fluent-plugin-systemd/badges/gpa.svg)](https://codeclimate.com/github/reevoo/fluent-plugin-systemd) [![Gem Version](https://badge.fury.io/rb/fluent-plugin-systemd.svg)](https://rubygems.org/gems/fluent-plugin-systemd)
+[![Build Status](https://github.com/fluent-plugin-systemd/fluent-plugin-systemd/actions/workflows/ci.yml/badge.svg)](https://github.com/fluent-plugin-systemd/fluent-plugin-systemd/actions/workflows/ci.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/5c773a4c1c6a6964fa4b/maintainability)](https://codeclimate.com/github/fluent-plugin-systemd/fluent-plugin-systemd/maintainability) [![Gem Version](https://badge.fury.io/rb/fluent-plugin-systemd.svg)](https://rubygems.org/gems/fluent-plugin-systemd)
 
 ## Overview
 
@@ -9,11 +9,8 @@
 
 ## Support
 
-[![Fluentd Slack](http://slack.fluentd.org/badge.svg)](http://slack.fluentd.org/)
-
 Join the #plugin-systemd channel on the [Fluentd Slack](http://slack.fluentd.org/)
 
-
 ## Requirements
 
 |fluent-plugin-systemd|fluentd|td-agent|ruby|
@@ -21,6 +18,10 @@ Join the #plugin-systemd channel on the [Fluentd Slack](http://slack.fluentd.org
 | > 0.1.0 | >= 0.14.11, < 2 | 3 | >= 2.1 |
 | 0.0.x | ~> 0.12.0       | 2 | >= 1.9  |
 
+|fluent-plugin-systemd|fluentd|fluent-package|ruby|
+|----|----|----|----|
+| >= 1.1.0 | >= 0.14.11, < 2 | 5 | >= 3.0 |
+
 * The 1.x.x series is developed from this branch (master)
 * The 0.0.x series (compatible with fluentd v0.12, and td-agent 2) is maintained on the [0.0.x branch](https://github.com/reevoo/fluent-plugin-systemd/tree/0.0.x)
 
@@ -28,11 +29,11 @@ Join the #plugin-systemd channel on the [Fluentd Slack](http://slack.fluentd.org
 
 Simply use RubyGems:
 
-    gem install fluent-plugin-systemd -v 1.0.1
+    gem install fluent-plugin-systemd -v 1.0.3
 
 or
 
-    td-agent-gem install fluent-plugin-systemd -v 1.0.1
+    td-agent-gem install fluent-plugin-systemd -v 1.0.3
 
 ## Upgrading
 
@@ -47,8 +48,9 @@ If you are upgrading to version 1.0 from a previous version of this plugin take
       matches [{ "_SYSTEMD_UNIT": "kubelet.service" }]
       read_from_head true
 
-      <storage kubelet-pos>
+      <storage>
         @type local
+        path /var/log/fluentd-journald-kubelet-cursor.json
       </storage>
 
       <entry>
@@ -84,7 +86,7 @@ description of this property and how to use it.
 
 **`storage`**
 
-Configuration for a [storage plugin](http://docs.fluentd.org/v0.14/articles/storage-plugin-overview) used to store the journald cursor.
+Configuration for a [storage plugin](https://docs.fluentd.org/storage) used to store the journald cursor.
 
 **`read_from_head`**
 
@@ -214,13 +216,13 @@ On Debian or Ubuntu you might need to install the libsystemd0 package:
 apt-get install libsystemd0
 ```
 
-On CentOS or RHEL you might need to install the systemd package:
+On AlmaLinux or RHEL you might need to install the systemd package:
 
 ```
 yum install -y systemd
 ```
 
-If you want to do this in a CentOS docker image you might first need to remove the `fakesystemd` package.
+If you want to do this in a AlmaLinux docker image you might first need to remove the `fakesystemd` package.
 
 ```
 yum remove -y fakesystemd
@@ -252,14 +254,17 @@ We have adopted the [Contributor Covenant](CODE_OF_CONDUCT.md) and thus expect a
 
 Many thanks to our fantastic contributors
 
-* [Hiroshi Hatake](https://github.com/cosmo0920)
 * [Erik Maciejewski](https://github.com/emacski)
-* [Masahiro Nakagawa](https://github.com/repeatedly)
-* [Richard Megginson](https://github.com/richm)
-* [Mike Kaplinskiy](https://github.com/mikekap)
-* [neko-neko](https://github.com/neko-neko)
-* [Sadayuki Furuhashi](https://github.com/frsyuki)
+* [Ernie Hershey](https://github.com/ehershey)
+* [Hiroshi Hatake](https://github.com/cosmo0920)
 * [Jesus Rafael Carrillo](https://github.com/jescarri)
+* [Joel Gerber](https://github.com/Jitsusama)
 * [John Thomas Wile II](https://github.com/jtwile2)
 * [Kazuhiro Suzuki](https://github.com/ksauzz)
-* [Joel Gerber](https://github.com/Jitsusama)
+* [Marius Grigoriu](https://github.com/mariusgrigoriu)
+* [Masahiro Nakagawa](https://github.com/repeatedly)
+* [Mike Kaplinskiy](https://github.com/mikekap)
+* [Richard Megginson](https://github.com/richm)
+* [Sadayuki Furuhashi](https://github.com/frsyuki)
+* [Seiichi Nishikata](https://github.com/neko-neko)
+* [Kentaro Hayashi](https://github.com/kenhys)

data/lib/fluent/plugin/in_systemd.rb

@@ -21,7 +21,7 @@ require 'fluent/plugin/systemd/entry_mutator'
 module Fluent
   module Plugin
     # Fluentd plugin for reading from the systemd journal
-    class SystemdInput < Input
+    class SystemdInput < Input # rubocop:disable Metrics/ClassLength
       Fluent::Plugin.register_input('systemd', self)
 
       helpers :timer, :storage
@@ -57,9 +57,19 @@ module Fluent
 
       def start
         super
+        @running = true
         timer_execute(:in_systemd_emit_worker, 1, &method(:run))
       end
 
+      def shutdown
+        @running = false
+        @journal&.close
+        @journal = nil
+        @pos_storage = nil
+        @mutator = nil
+        super
+      end
+
       private
 
       def init_journal
@@ -92,6 +102,7 @@ module Fluent
       def seek_to(pos)
         @journal.seek(pos)
         return if pos == :head
+
         if pos == :tail
           @journal.move(-2)
         else
@@ -105,6 +116,7 @@ module Fluent
 
       def run
         return unless @journal || init_journal
+
         init_journal if @journal.wait(0) == :invalidate
         watch do |entry|
           emit(entry)
@@ -116,6 +128,7 @@ module Fluent
       rescue Fluent::Plugin::Buffer::BufferOverflowError => e
         retries ||= 0
         raise e if retries > 10
+
         retries += 1
         sleep 1.5**retries + rand(0..3)
         retry
@@ -128,7 +141,9 @@ module Fluent
       end
 
       def watch(&block)
-        yield_current_entry(&block) while @journal.move_next
+        yield_current_entry(&block) while @running && @journal.move_next
+      rescue Systemd::JournalError => e
+        log.warn("Error moving to next Journal entry: #{e.class}: #{e.message}")
       end
 
       def yield_current_entry

data/lib/fluent/plugin/systemd/entry_mutator.rb

@@ -67,6 +67,7 @@ module Fluent
       # Expose config state as read-only instance properties of the mutator.
       def method_missing(sym, *args)
         return @opts[sym] if @opts.members.include?(sym)
+
         super
       end
 
@@ -80,6 +81,7 @@ module Fluent
       def run(entry)
         return entry.to_h if @no_transform
         return map_fields(entry) if @opts.field_map_strict
+
         format_fields(entry, map_fields(entry))
       end
 
@@ -90,6 +92,7 @@ module Fluent
         @map.each_with_object({}) do |(cstm, sysds), mapped|
           vals = sysds.collect { |fld| entry[fld] }.compact
           next if vals.empty? # systemd field does not exist in source entry
+
           mapped[cstm] = join_if_needed(vals)
         end
       end
@@ -103,6 +106,7 @@ module Fluent
         entry.each_with_object(mapped || {}) do |(fld, val), formatted_entry|
           # don't mess with explicitly mapped fields
           next if @map_src_fields.include?(fld)
+
           fld = format_field_name(fld)
           # account for mapping (appending) to an existing systemd field
           formatted_entry[fld] = join_if_needed([val, mapped[fld]])
@@ -111,6 +115,7 @@ module Fluent
 
       def warnings
         return [] unless field_map_strict && field_map.empty?
+
         '`field_map_strict` set to true with empty `field_map`, expect no fields'
       end
 
@@ -119,6 +124,7 @@ module Fluent
       def join_if_needed(values)
         values.compact!
         return values.first if values.length == 1
+
         values.join(' ')
       end
 
@@ -146,7 +152,7 @@ module Fluent
         end
       end
 
-      def validate_all_strings(arr, message, allow_nesting = false)
+      def validate_all_strings(arr, message, allow_nesting = false) # rubocop:disable Style/OptionalBooleanParameter
         valid = arr.all? do |value|
           value.is_a?(String) || allow_nesting && value.is_a?(Array) && value.all? { |key| key.is_a?(String) }
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-systemd
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Ed Robinson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2024-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 2.0.0
 description: This is a fluentd input plugin. It reads logs from the systemd journal.
 email:
 - edward-robinson@cookpad.com
@@ -116,7 +116,7 @@ homepage: https://github.com/reevoo/fluent-plugin-systemd
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -131,9 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Input plugin to read from systemd journal.
 test_files: []