README.md in fluent-plugin-cat-sweep-0.0.1 vs README.md in fluent-plugin-cat-sweep-0.1.0
- old
+ new
@@ -1,8 +1,8 @@
# fluent-plugin-cat-sweep
-[![Build Status](https://secure.travis-ci.org/civitaspo/fluent-plugin-cat-sweep.png?branch=master)](http://travis-ci.org/civitaspo/fluent-plugin-cat-sweep)
+[![Circle CI](https://circleci.com/gh/civitaspo/fluent-plugin-cat-sweep.svg?style=svg)](https://circleci.com/gh/civitaspo/fluent-plugin-cat-sweep) [![Build Status](https://secure.travis-ci.org/civitaspo/fluent-plugin-cat-sweep.png?branch=master)](http://travis-ci.org/civitaspo/fluent-plugin-cat-sweep)
Fluentd plugin to read data from files and to remove or move after processing.
## Installation
@@ -17,9 +17,26 @@
$ bundle
Or install it yourself as:
$ gem install fluent-plugin-cat-sweep
+
+## Basic Behavior
+
+Assume that an application outputs logs into `/tmp/test` directory as
+
+```
+tmp/test
+├── accesss.log.201509151611
+├── accesss.log.201509151612
+└── accesss.log.201509151613
+```
+
+in every one minute interval.
+
+This plugin watches the directory (`file_path_with_glob tmp/test/access.log.*`), and reads the contents and sweep (deafault: remove) for files whose mtime are passed in 60 seconds (can be configured with `waiting_seconds`).
+
+Our assumption is that this mechanism should provide more durability than `in_tail` (batch read overcomes than streaming read).
## Configuration
```
<source>