README.md in fluent-plugin-redis-enrichment-0.3.1 vs README.md in fluent-plugin-redis-enrichment-1.0.0
- old
+ new
@@ -1,41 +1,59 @@
# fluent-plugin-redis-enrichment
-[Fluentd](https://fluentd.org/) filter plugin to do something.
+Filter plugin that allow to update record with data fetch from redis.
-TODO: write description for you plugin.
-
## Installation
-### RubyGems
-```
-$ gem install fluent-plugin-redis-enrichment
-```
+Manual install, by executing:
-### Bundler
+ $ gem install fluent-plugin-redis-enrichment
-Add following line to your Gemfile:
+Add to Gemfile with:
-```ruby
-gem "fluent-plugin-redis-enrichment"
-```
+ $ bundle add fluent-plugin-redis-enrichment
-And then execute:
+## Compatibility
-```
-$ bundle
-```
+- ruby >= 2.4.10
+- td-agent >= 3.8.1-0
## Configuration
+### template
You can generate configuration template:
```
$ fluent-plugin-config-format filter redis-enrichment
```
You can copy and paste generated documents here.
+
+### example
+
+- in the current record, get the value associated to *field* key,
+- use this value in redis to get associated data
+- complete current record with fetched redis data
+
+```
+<filter data_stream_tag>
+ @type redis_enrichment
+
+ sentinels "sentinel-1:26379,sentinel-2:26379,sentinel-:26379"
+ sentinel_password "abc123"
+ sentinel_master "mymaster"
+ redis_db "1"
+ redis_password "123abc"
+
+ key ${record["field"]}
+
+ <record>
+ additional_1 "${redis["data1"]}"
+ additional_2 "${redis["data2"]}"
+ </record>
+</filter>
+```
## Copyright
* Copyright(c) 2022- Thomas Tych
* License