fluent-plugin-systemd 1.0.0.rc3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d36c2726704e80195922ab5a2e7cb0f89825f27e
-  data.tar.gz: 93d387a176097b858761bbeb5a0f01682ed30b0b
+  metadata.gz: 05b2387f068e7c0ec23f74f61bb5d1b031fbd670
+  data.tar.gz: 438b9f07ea3b23d6af05077ec460f51e413002e4
 SHA512:
-  metadata.gz: 495c1d1fe28618d1e131a1c540c0143bb4935e80f5f86393bd5504a38fbb04c353bb859e59f6c19773e69d54165094f4a8db2f9d0be20d49565fb83ee836d06c
-  data.tar.gz: de2ac2e4860d441bbd8bc9e3bdaae98cc97aa456b83fc051b7706c8885ef6e56c90b8f0b3905e46156592d346728d6fd89493a02577ec467f011495b082bcb1c
+  metadata.gz: 23d0e490a9befa2d01ea8fd6092dbed234ea8a31e3433cb458a584195d0ba6a08376881641df75db4fb139887e869b66c935a58ce7daf796d24bea8b533020fa
+  data.tar.gz: 7ac5767e188b7ef944c62415a7e13eb100effa83f05784377b7fa071b9a6cbc52eaf72f7f45a5d593d0302474e4ca858d746a616ae1ec2a8522c62f20cc09dc8

data/README.md

@@ -4,8 +4,8 @@
 
 ## Overview
 
-**systemd** input plugin reads logs from the systemd journal  
-**systemd** filter plugin allows for basic manipulation of systemd journal entries
+* **systemd** input plugin to read logs from the systemd journal
+* **systemd** filter plugin for basic manipulation of systemd journal entries
 
 ## Support
 
@@ -21,19 +21,22 @@ 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  |
 
-* The 0.x.x series is developed from this branch (master)
-* The 0.0.x series (compatible with fluentd v0.12, and td-agent 2) is developed on the [0.0.x branch](https://github.com/reevoo/fluent-plugin-systemd/tree/0.0.x)
-* The next version is currently under development on the [1.0.0 branch](https://github.com/reevoo/fluent-plugin-systemd/tree/1.0.0) it's progress is tracked [here](https://github.com/reevoo/fluent-plugin-systemd/issues/53)
+* 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)
 
 ## Installation
 
 Simply use RubyGems:
 
-    gem install fluent-plugin-systemd -v 0.3.1
+    gem install fluent-plugin-systemd -v 1.0.0
 
 or
 
-    td-agent-gem install fluent-plugin-systemd -v 0.3.1
+    td-agent-gem install fluent-plugin-systemd -v 1.0.0
+
+## Upgrading
+
+If you are upgrading to version 1.0 from a previous version of this plugin take a look at the [upgrade documentation](docs/upgrading.md). A number of deprecated config options were removed so you might need to update your configuration.
 
 ## Input Plugin Configuration
 
@@ -49,7 +52,6 @@ or
         path kube-proxy.pos
       </storage>
       <entry>
-        field_map {"MESSAGE": "log", "_PID": ["process", "pid"], "_CMDLINE": "process", "_COMM": "cmd"}
         fields_strip_underscores true
         fields_lowercase true
       </entry>
@@ -65,7 +67,7 @@ Path to the systemd journal, defaults to `/var/log/journal`
 
 **`filters`**
 
-_This parameter name is deprecated and should be renamed to `matches`_
+_This parameter name is depreciated and should be renamed to `matches`_
 
 **`matches`**
 
@@ -73,40 +75,21 @@ Expects an array of hashes defining desired matches to filter the log
 messages with. When this property is not specified, this plugin will default to
 reading all logs from the journal.
 
-See [matching details](docs/Matching-Details.md) for a more exhaustive
+See [matching details](docs/matching.md) for a more exhaustive
 description of this property and how to use it.
 
-**`pos_file`**
-
-_This parameter is deprecated and will be removed in favour of storage in v1.0._
-
-
-Path to pos file, stores the journald cursor. File is created if does not exist.
-
 **`storage`**
 
 Configuration for a [storage plugin](http://docs.fluentd.org/v0.14/articles/storage-plugin-overview) used to store the journald cursor.
 
-_Upgrading from `pos_file`_
-
-If `pos_file` is specified in addition to a storage plugin with persistent set to true, the cursor will be
-copied from the `pos_file` on startup, and the old `pos_file` removed.
-
 **`read_from_head`**
 
 If true reads all available journal from head, otherwise starts reading from tail,
- ignored if pos file exists (and is valid). Defaults to false.
-
-**`strip_underscores`**
-
-_This parameter is deprecated and will be removed in favour of entry in v1.0._
-
-If true strips underscores from the beginning of systemd field names.
-May be useful if outputting to kibana, as underscore prefixed fields are unindexed there.
+ ignored if cursor exists in storage (and is valid). Defaults to false.
 
 **`entry`**
 
-Optional configuration for an embeded systemd entry filter. See the  [Filter Plugin Configuration](#filter-plugin-configuration) for config reference.
+Optional configuration for an embedded systemd entry filter. See the  [Filter Plugin Configuration](#filter-plugin-configuration) for config reference.
 
 **`tag`**
 
@@ -114,19 +97,20 @@ _Required_
 
 A tag that will be added to events generated by this input.
 
-### Example
-
-For an example of a full working setup including the plugin, [take a look at](https://github.com/assemblyline/fluentd)
 
 ## Filter Plugin Configuration
 
-    <filter kube-proxy>
-      @type systemd_entry
-      field_map {"MESSAGE": "log", "_PID": ["process", "pid"], "_CMDLINE": "process", "_COMM": "cmd"}
-      field_map_strict false
-      fields_lowercase true
-      fields_strip_underscores true
-    </filter>
+```
+<filter kube-proxy>
+  @type systemd_entry
+  field_map {"MESSAGE": "log", "_PID": ["process", "pid"], "_CMDLINE": "process", "_COMM": "cmd"}
+  field_map_strict false
+  fields_lowercase true
+  fields_strip_underscores true
+</filter>
+```
+
+_Note that the following configurations can be embedded in a systemd source block, within an entry block, you only need to use a filter directly for more complicated workflows._
 
 **`field_map`**
 
@@ -151,7 +135,7 @@ If true, lowercase all non-mapped fields. Defaults to false.
 
 If true, strip leading underscores from all non-mapped fields. Defaults to false.
 
-### Example
+### Filter Example
 
 Given a systemd journal source entry:
 ```
@@ -178,26 +162,63 @@ The resulting entry using the above sample configuration:
 
 ## Common Issues
 
-> ### When I look at fluentd logs, everything looks fine but no journal logs are read
+> ### When I look at fluentd logs, everything looks fine but no journal logs are read ?
 
-This is commonly caused when the user running fluentd does not have enough permisions
+This is commonly caused when the user running fluentd does not have the correct permissions
 to read the systemd journal.
 
-Acording to the [systemd documentation](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html):
+According to the [systemd documentation](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html):
 > Journal files are, by default, owned and readable by the "systemd-journal" system group but are not writable. Adding a user to this group thus enables her/him to read the journal files.
 
+> ### How can I deal with multi-line logs ?
+
+Ideally you want to ensure that your logs are saved to the systemd journal as a single entry regardless of how many lines they span.
+
+It is possible for applications to naively support this (but only if they have tight integration with systemd it seems) see: https://github.com/systemd/systemd/issues/5188.
+
+Typically you would not be able to this, so another way is to configure your logger to replace newline characters with something else. See this blog post for an example configuring a Java logging library to do this https://fabianlee.org/2018/03/09/java-collapsing-multiline-stack-traces-into-a-single-log-event-using-spring-backed-by-logback-or-log4j2/
+
+Another strategy would be to use a plugin like [fluent-plugin-concat](https://github.com/fluent-plugins-nursery/fluent-plugin-concat) to combine multi line logs into a single event, this is more tricky though because you need to be able to identify the first and last lines of a multi line message with a regex.
+
+> ### How can I use this plugin inside of a docker container ?
+
+* Install the [systemd dependencies](#dependencies) if required
+* You can use an [offical fluentd docker](https://github.com/fluent/fluentd-docker-image) image as a base, (choose the debian based version, as alpine linux doesn't support systemd).
+* Bind mount `/var/log/journal` into your container.
+
+### Example
+
+For an example of a full working setup including the plugin, take a look at [the fluentd kubernetes daemonset](https://github.com/fluent/fluentd-kubernetes-daemonset)
 
 ## Dependencies
 
 This plugin depends on libsystemd
 
+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:
+
+```
+yum install -y systemd
+```
+
+If you want to do this in a CentOS docker image you might first need to remove the `fakesystemd` package.
+
+```
+yum remove -y fakesystemd
+```
+
 ## Running the tests
 
 To run the tests with docker on several distros simply run `rake`
 
 For systems with systemd installed you can run the tests against your installed libsystemd with `rake test`
 
-## Licence
+## License
 
 [Apache-2.0](LICENCE)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-systemd
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0
 platform: ruby
 authors:
 - Ed Robinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,9 +127,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13