README.md in fluent-plugin-systemd-0.1.1 vs README.md in fluent-plugin-systemd-0.2.0
- old
+ new
@@ -4,12 +4,12 @@
# Requirements <a name="requirements"></a>
|fluent-plugin-systemd|fluentd|td-agent|ruby|
-|----|----|----|
-| 0.1.x | >= 0.14.11, < 2 | 3 | >= 2.1 |
+|----|----|----|----|
+| 0.2.x | >= 0.14.11, < 2 | 3 | >= 2.1 |
| 0.0.x | ~> 0.12.0 | 2 | >= 1.9 |
* The 0.1.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)
@@ -19,54 +19,76 @@
## Installation
Simply use RubyGems:
- gem install fluent-plugin-systemd -v 0.1.1
+ gem install fluent-plugin-systemd -v 0.2.0
- or
+or
- td-agent-gem install fluent-plugin-systemd -v 0.1.1
+ td-agent-gem install fluent-plugin-systemd -v 0.2.0
## Configuration
<source>
@type systemd
path /var/log/journal
filters [{ "_SYSTEMD_UNIT": "kube-proxy.service" }]
- pos_file kube-proxy.pos
+ <storage>
+ @type local
+ persistent true
+ path kube-proxy.pos
+ </storage>
tag kube-proxy
read_from_head true
</source>
-**path**
+ <match kube-proxy>
+ @type stdout
+ </match>
+**`path`**
+
Path to the systemd journal, defaults to `/var/log/journal`
-**filters**
+**`filters`**
Array of filters, see [here](http://www.rubydoc.info/gems/systemd-journal/Systemd%2FJournal%2FFilterable%3Afilter) for further
documentation, defaults to no filtering.
-**pos file**
+**`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.
-**read_from_head**
+**`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**
+**`strip_underscores`**
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.
-**tag**
+**`tag`**
-_Required_ A tag that will be added to events generated by this input.
+_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)
## Dependencies
@@ -97,5 +119,6 @@
* [Mike Kaplinskiy](https://github.com/mikekap)
* [Sadayuki Furuhashi](https://github.com/frsyuki)
* [Richard Megginson](https://github.com/richm)
* [Masahiro Nakagawa](https://github.com/repeatedly)
* [Hiroshi Hatake](https://github.com/cosmo0920)
+* [neko-neko](https://github.com/neko-neko)