release 0.2.2

Author: fstab

CONFIG.md

@@ -62,6 +62,7 @@ input:
     type: file
     path: /var/log/sample.log
     readall: false
+    poll_interval_seconds: 5 # should not be needed in most cases, see below
 ```
 
 The `readall` flag defines if `grok_exporter` starts reading from the beginning or the end of the file.
@@ -70,6 +71,15 @@ True is good for debugging, because we process all available log lines.
 False is good for production, because we avoid to process lines multiple times when `grok_exporter` is restarted.
 The default value for `readall` is `false`.
 
+On `poll_interval_seconds`: You probably don't need this. The internal implementation of `grok_exporter`'s
+file input is based on the operating system's file system notification mechanism, which is `inotify` on Linux,
+`kevent` on BSD (or macOS), and `ReadDirectoryChangesW` on Windows. These tools will inform `grok_exporter` as
+soon as a new log line is written to the log file, and let `grok_exporter` sleep as long as the log file doesn't
+change. There is no need for configuring a poll interval. However, there is one combination where the above
+notifications don't work: If the logging application keeps the logfile open and the underlying file system is NTFS
+(see [#17](https://github.com/fstab/grok_exporter/issues/17)). For this specific case you can configure a
+`poll_interval_seconds`. This will disable file system notifications and instead check the log file periodically.
+
 ### Stdin Input Type
 
 The configuration for the `stdin` input type does not have any additional parameters:

release.sh

@@ -10,7 +10,7 @@ set -e
 cd $GOPATH/src/github.com/fstab/grok_exporter
 rm -rf dist
 
-export VERSION=0.2.2-SNAPSHOT
+export VERSION=0.2.2
 
 export VERSION_FLAGS="\
         -X github.com/fstab/grok_exporter/exporter.Version=$VERSION                          \