Update README, CHANGELOG, VERSION

fluent-plugins-nursery · Dec 22, 2017 · 11bdbe3 · 11bdbe3
1 parent b9fe891
commit 11bdbe3
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.0.0
+
+* Support fluentd-0.14 or later features [#24](https://github.com/dlackty/fluent-plugin-remote_syslog/pull/24)
+* Support TCP and TLS protocol [#24](https://github.com/dlackty/fluent-plugin-remote_syslog/pull/24)
+* Not support fluentd-0.12.0 from this version
+
 ## 0.3.3
 
 * Allow override "severity" or "facility" from records [#19](https://github.com/dlackty/fluent-plugin-remote_syslog/pull/19)

diff --git a/README.md b/README.md
@@ -6,10 +6,10 @@
 
 ## Requirements
 
-| fluent-plugin-remote_syslog | fluentd    | ruby   |
-| -------------------         | ---------  | ------ |
-| >= 1.0.0                    | >= v0.14.0 | >= 2.1 |
-| < 1.0.0                     | >= v0.12.0 | >= 1.9 |
+| fluent-plugin-remote_syslog | fluentd                 | ruby   |
+| -------------------         | ---------               | ------ |
+| >= 1.0.0                    | >= v0.14.0 or >= v1.0.0 | >= 2.1 |
+| < 1.0.0                     | >= v0.12.0              | >= 1.9 |
 
 ## Installation
 
@@ -30,9 +30,54 @@
 
   <buffer tag>
   </buffer>
+
+  <format>
+    @type single_value
+    message_key msg
+  </format>
 </match>
 ```
 
+## Configuration
+
+| name              | type                             | placeholder support | description                                           |
+| --------------    | -------                          | -----------         | ---------------------------------                     |
+| hostname          | string                           | support             | departure of log                                      |
+| host              | string                           | support             | syslog target host                                    |
+| port              | integer (default: `514`)         |                     | syslog target port                                    |
+| host_with_port    | string                           | support             | parameter for <host>:<port> style                     |
+| facility          | string (default: `"user"`)       | support             | syslog facility                                       |
+| severity          | string (default: `"notice"`      | support             | syslog severity                                       |
+| program           | string (default: `"fluentd"`     | support             | syslog program name                                   |
+| protocol          | enum (udp, tcp) (default: `udp`) |                     | transfer protocol                                     |
+| tls               | bool (default: false)            |                     | use TLS (tcp only)                                    |
+| ca_file           | string                           |                     | ca_file path (tls mode only)                          |
+| verify_mode       | integer                          |                     | SSL verification mode (tls mode only)                 |
+| packet_size       | integer (default: `1024`)        |                     | size limitation for syslog packet                     |
+| timeout           | integer                          |                     | TCP transfer timeout. if value is 0, wait forever     |
+| timeout_exception | bool (default: `false`)          |                     | if value is true, raise exception by transfer timeout |
+| keep_alive        | bool (default: `false`)          |                     | use TCP keep alive                                    |
+| keep_alive_idle   | integer                          |                     | set TCP keep alive idle time                          |
+| keep_alive_cnt    | integer                          |                     | set TCP keep alive probe count                        |
+| keep_alive_intvl  | integer                          |                     | set TCP keep alive probe interval                     |
+
+### Common Configuration
+
+#### Buffer Section
+
+| name                        | default  |
+| --------------              | -------  |
+| flush_mode                  | interval |
+| flush_interval              | 5        |
+| flush_thread_interval       | 0.5      |
+| flush_thread_burst_interval | 0.5      |
+
+#### Format Section
+
+| name           | default |
+| -------------- | ------- |
+| @type          | ltsv    |
+
 ## License
 
 Copyright (c) 2014-2017 Richard Lee. See LICENSE for details.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.3.3
+1.0.0