README.rdoc in fluent-plugin-redis-0.2.3 vs README.rdoc in fluent-plugin-redis-0.3.0
- old
+ new
@@ -1,9 +1,19 @@
= Redis output plugin for Fluent
fluent-plugin-redis is a fluent plugin to output to redis.
+== Requirements
+
+ |fluent-plugin-redis| fluentd | ruby |
+ |-------------------|------------------|--------|
+ | >= 0.3.0 | >= 0.14.8 | >= 2.1 |
+ | == 0.2.3 | ~> 0.12.0 * | >= 1.9 |
+ | < 0.2.3 | >= 0.10.0, < 2 * | >= 1.9 |
+
+ * May not support all future fluentd features
+
== Installation
What you have to do is only installing like this:
gem install fluent-plugin-redis
@@ -11,20 +21,34 @@
Then fluent automatically loads the plugin installed.
== Configuration
<match redis.**>
- type redis
+ @type redis
host localhost
port 6379
# database number is optional.
db_number 0 # 0 is default
# If requirepass is set, please specify this.
# password hogefuga
+ # Users can set '${tag}' or ${tag[0]}.${tag[1]} or ...?
+ # insert_key_prefix '${tag}'
+ # Users can set strftime format.
+ # "%s" will be replaced into unixtime.
+ # "%Y%m%d.%H%M%S" will be replaced like as 20161202.112335.
+ # strftime_format "%s"
+ # Allow insert key duplicate. It will work as update values.
+ # allow_duplicate_key true
</match>
+
+=== Notice
+
+<em>insert_key_prefix</em>, <em>strftime_format</em>, and <em>allow_duplicate_key</em> are newly added config parameters.
+
+They can use v0.3.0 or later. To use this parameters, users must update Fluentd to v0.14 or later and this plugin to v0.3.0 or later.
== Contributing to fluent-plugin-redis
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it