docs/index.asciidoc in logstash-output-gelf-3.1.4 vs docs/index.asciidoc in logstash-output-gelf-3.1.7
- old
+ new
@@ -1,7 +1,8 @@
:plugin: gelf
:type: output
+:default_codec: plain
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
@@ -21,11 +22,11 @@
==== Description
This output generates messages in GELF format. This is most useful if you
want to use Logstash to output events to Graylog2.
-More information at http://graylog2.org/gelf#specs[The Graylog2 GELF specs page]
+More information at http://docs.graylog.org/en/2.3/pages/gelf.html#gelf-payload-specification[The Graylog2 GELF specs page]
[id="plugins-{type}s-{plugin}-options"]
==== Gelf Output Configuration Options
This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
@@ -38,10 +39,11 @@
| <<plugins-{type}s-{plugin}-full_message>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-ignore_metadata>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-level>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-protocol>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sender>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-ship_metadata>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-ship_tags>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-short_message>> |<<string,string>>|No
|=======================================================================
@@ -55,11 +57,11 @@
===== `chunksize`
* Value type is <<number,number>>
* Default value is `1420`
-The GELF chunksize. You usually don't need to change this.
+The chunksize. You usually don't need to change this.
[id="plugins-{type}s-{plugin}-custom_fields"]
===== `custom_fields`
* Value type is <<hash,hash>>
@@ -120,10 +122,21 @@
* Value type is <<number,number>>
* Default value is `12201`
Graylog2 server port number.
+[id="plugins-{type}s-{plugin}-protocol"]
+===== `protocol`
+
+By default, this plugin outputs via the UDP transfer protocol, but can be
+configured to use TCP instead.
+
+ * Value type is <<string,string>>
+ * Default value is `"UDP"`
+
+Values here can be either "TCP" or "UDP".
+
[id="plugins-{type}s-{plugin}-sender"]
===== `sender`
* Value type is <<string,string>>
* Default value is `"%{host}"`
@@ -162,6 +175,8 @@
the event message is taken instead.
[id="plugins-{type}s-{plugin}-common-options"]
-include::{include_path}/{type}.asciidoc[]
+include::{include_path}/{type}.asciidoc[]
+
+:default_codec!:
\ No newline at end of file