diff --git a/docs/plugins/codecs/cef.asciidoc b/docs/plugins/codecs/cef.asciidoc index c66013774..2d4fbe427 100644 --- a/docs/plugins/codecs/cef.asciidoc +++ b/docs/plugins/codecs/cef.asciidoc @@ -122,7 +122,7 @@ Fields to be included in CEV extension part as key/value pairs * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/collectd.asciidoc b/docs/plugins/codecs/collectd.asciidoc index 8c3547ddb..11c947c20 100644 --- a/docs/plugins/codecs/collectd.asciidoc +++ b/docs/plugins/codecs/collectd.asciidoc @@ -111,7 +111,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/dots.asciidoc b/docs/plugins/codecs/dots.asciidoc index bffca669e..fb3f1b362 100644 --- a/docs/plugins/codecs/dots.asciidoc +++ b/docs/plugins/codecs/dots.asciidoc @@ -63,7 +63,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/edn.asciidoc b/docs/plugins/codecs/edn.asciidoc index ea70c5869..c8d1152f2 100644 --- a/docs/plugins/codecs/edn.asciidoc +++ b/docs/plugins/codecs/edn.asciidoc @@ -63,7 +63,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/edn_lines.asciidoc b/docs/plugins/codecs/edn_lines.asciidoc index b5506e0c0..2e923c87b 100644 --- a/docs/plugins/codecs/edn_lines.asciidoc +++ b/docs/plugins/codecs/edn_lines.asciidoc @@ -63,7 +63,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/es_bulk.asciidoc b/docs/plugins/codecs/es_bulk.asciidoc index 8b37b07a0..85b29796f 100644 --- a/docs/plugins/codecs/es_bulk.asciidoc +++ b/docs/plugins/codecs/es_bulk.asciidoc @@ -67,7 +67,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/fluent.asciidoc b/docs/plugins/codecs/fluent.asciidoc index 325b08879..09a067104 100644 --- a/docs/plugins/codecs/fluent.asciidoc +++ b/docs/plugins/codecs/fluent.asciidoc @@ -83,7 +83,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/graphite.asciidoc b/docs/plugins/codecs/graphite.asciidoc index aa84b90b3..4b4425424 100644 --- a/docs/plugins/codecs/graphite.asciidoc +++ b/docs/plugins/codecs/graphite.asciidoc @@ -84,7 +84,7 @@ Indicate that the event @fields should be treated as metrics and will be sent as * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/json.asciidoc b/docs/plugins/codecs/json.asciidoc index d7c8c71bf..5d4b7f5ab 100644 --- a/docs/plugins/codecs/json.asciidoc +++ b/docs/plugins/codecs/json.asciidoc @@ -90,7 +90,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/json_lines.asciidoc b/docs/plugins/codecs/json_lines.asciidoc index ddf9899a6..45ec4310e 100644 --- a/docs/plugins/codecs/json_lines.asciidoc +++ b/docs/plugins/codecs/json_lines.asciidoc @@ -95,7 +95,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/line.asciidoc b/docs/plugins/codecs/line.asciidoc index 6ac6e3e5d..5cf4d00e6 100644 --- a/docs/plugins/codecs/line.asciidoc +++ b/docs/plugins/codecs/line.asciidoc @@ -100,7 +100,7 @@ Set the desired text format for encoding. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/msgpack.asciidoc b/docs/plugins/codecs/msgpack.asciidoc index 4ffbf1c44..d1d0be8f6 100644 --- a/docs/plugins/codecs/msgpack.asciidoc +++ b/docs/plugins/codecs/msgpack.asciidoc @@ -72,7 +72,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/multiline.asciidoc b/docs/plugins/codecs/multiline.asciidoc index 62da6598c..a94d3d6ee 100644 --- a/docs/plugins/codecs/multiline.asciidoc +++ b/docs/plugins/codecs/multiline.asciidoc @@ -2,11 +2,18 @@ === multiline * Version: 3.0.3 -* Released on: 2016-09-15 +* Released on: September 15, 2016 * https://github.com/logstash-plugins/logstash-codec-multiline/blob/master/CHANGELOG.md#303[Changelog] +==== Getting Help + +For questions about the plugin, open a topic in the http://discuss.elastic.co[Discuss] forums. For bugs or feature requests, open an issue in https://github.com/elastic/logstash[Github]. +For the list of Elastic supported plugins, please consult the https://www.elastic.co/support/matrix#show_logstash_plugins[Elastic Support Matrix]. + +==== Description + The multiline codec will collapse multiline messages and merge them into a single event. @@ -101,20 +108,20 @@ multiline { Available configuration options: -[cols="<,<,<,> |<>|No| -| <> |<>, one of `["ASCII-8BIT", "UTF-8", "US-ASCII", "Big5", "Big5-HKSCS", "Big5-UAO", "CP949", "Emacs-Mule", "EUC-JP", "EUC-KR", "EUC-TW", "GB2312", "GB18030", "GBK", "ISO-8859-1", "ISO-8859-2", "ISO-8859-3", "ISO-8859-4", "ISO-8859-5", "ISO-8859-6", "ISO-8859-7", "ISO-8859-8", "ISO-8859-9", "ISO-8859-10", "ISO-8859-11", "ISO-8859-13", "ISO-8859-14", "ISO-8859-15", "ISO-8859-16", "KOI8-R", "KOI8-U", "Shift_JIS", "UTF-16BE", "UTF-16LE", "UTF-32BE", "UTF-32LE", "Windows-31J", "Windows-1250", "Windows-1251", "Windows-1252", "IBM437", "IBM737", "IBM775", "CP850", "IBM852", "CP852", "IBM855", "CP855", "IBM857", "IBM860", "IBM861", "IBM862", "IBM863", "IBM864", "IBM865", "IBM866", "IBM869", "Windows-1258", "GB1988", "macCentEuro", "macCroatian", "macCyrillic", "macGreek", "macIceland", "macRoman", "macRomania", "macThai", "macTurkish", "macUkraine", "CP950", "CP951", "IBM037", "stateless-ISO-2022-JP", "eucJP-ms", "CP51932", "EUC-JIS-2004", "GB12345", "ISO-2022-JP", "ISO-2022-JP-2", "CP50220", "CP50221", "Windows-1256", "Windows-1253", "Windows-1255", "Windows-1254", "TIS-620", "Windows-874", "Windows-1257", "MacJapanese", "UTF-7", "UTF8-MAC", "UTF-16", "UTF-32", "UTF8-DoCoMo", "SJIS-DoCoMo", "UTF8-KDDI", "SJIS-KDDI", "ISO-2022-JP-KDDI", "stateless-ISO-2022-JP-KDDI", "UTF8-SoftBank", "SJIS-SoftBank", "BINARY", "CP437", "CP737", "CP775", "IBM850", "CP857", "CP860", "CP861", "CP862", "CP863", "CP864", "CP865", "CP866", "CP869", "CP1258", "Big5-HKSCS:2008", "ebcdic-cp-us", "eucJP", "euc-jp-ms", "EUC-JISX0213", "eucKR", "eucTW", "EUC-CN", "eucCN", "CP936", "ISO2022-JP", "ISO2022-JP2", "ISO8859-1", "ISO8859-2", "ISO8859-3", "ISO8859-4", "ISO8859-5", "ISO8859-6", "CP1256", "ISO8859-7", "CP1253", "ISO8859-8", "CP1255", "ISO8859-9", "CP1254", "ISO8859-10", "ISO8859-11", "CP874", "ISO8859-13", "CP1257", "ISO8859-14", "ISO8859-15", "ISO8859-16", "CP878", "MacJapan", "ASCII", "ANSI_X3.4-1968", "646", "CP65000", "CP65001", "UTF-8-MAC", "UTF-8-HFS", "UCS-2BE", "UCS-4BE", "UCS-4LE", "CP932", "csWindows31J", "SJIS", "PCK", "CP1250", "CP1251", "CP1252", "external", "locale"]`|No|`"UTF-8"` -| <> |<>|No|`true` -| <> |<>|No| -| <> |<>|No|`"10 MiB"` -| <> |<>|No|`500` -| <> |<>|No|`"multiline"` -| <> |<>|No|`false` -| <> |<>|Yes| -| <> |<>|No|`[]` -| <> |<>, one of `["previous", "next"]`|Yes| +|Setting |Input type|Required +| <> |<>|No +| <> |<>, one of `["ASCII-8BIT", "UTF-8", "US-ASCII", "Big5", "Big5-HKSCS", "Big5-UAO", "CP949", "Emacs-Mule", "EUC-JP", "EUC-KR", "EUC-TW", "GB2312", "GB18030", "GBK", "ISO-8859-1", "ISO-8859-2", "ISO-8859-3", "ISO-8859-4", "ISO-8859-5", "ISO-8859-6", "ISO-8859-7", "ISO-8859-8", "ISO-8859-9", "ISO-8859-10", "ISO-8859-11", "ISO-8859-13", "ISO-8859-14", "ISO-8859-15", "ISO-8859-16", "KOI8-R", "KOI8-U", "Shift_JIS", "UTF-16BE", "UTF-16LE", "UTF-32BE", "UTF-32LE", "Windows-31J", "Windows-1250", "Windows-1251", "Windows-1252", "IBM437", "IBM737", "IBM775", "CP850", "IBM852", "CP852", "IBM855", "CP855", "IBM857", "IBM860", "IBM861", "IBM862", "IBM863", "IBM864", "IBM865", "IBM866", "IBM869", "Windows-1258", "GB1988", "macCentEuro", "macCroatian", "macCyrillic", "macGreek", "macIceland", "macRoman", "macRomania", "macThai", "macTurkish", "macUkraine", "CP950", "CP951", "IBM037", "stateless-ISO-2022-JP", "eucJP-ms", "CP51932", "EUC-JIS-2004", "GB12345", "ISO-2022-JP", "ISO-2022-JP-2", "CP50220", "CP50221", "Windows-1256", "Windows-1253", "Windows-1255", "Windows-1254", "TIS-620", "Windows-874", "Windows-1257", "MacJapanese", "UTF-7", "UTF8-MAC", "UTF-16", "UTF-32", "UTF8-DoCoMo", "SJIS-DoCoMo", "UTF8-KDDI", "SJIS-KDDI", "ISO-2022-JP-KDDI", "stateless-ISO-2022-JP-KDDI", "UTF8-SoftBank", "SJIS-SoftBank", "BINARY", "CP437", "CP737", "CP775", "IBM850", "CP857", "CP860", "CP861", "CP862", "CP863", "CP864", "CP865", "CP866", "CP869", "CP1258", "Big5-HKSCS:2008", "ebcdic-cp-us", "eucJP", "euc-jp-ms", "EUC-JISX0213", "eucKR", "eucTW", "EUC-CN", "eucCN", "CP936", "ISO2022-JP", "ISO2022-JP2", "ISO8859-1", "ISO8859-2", "ISO8859-3", "ISO8859-4", "ISO8859-5", "ISO8859-6", "CP1256", "ISO8859-7", "CP1253", "ISO8859-8", "CP1255", "ISO8859-9", "CP1254", "ISO8859-10", "ISO8859-11", "CP874", "ISO8859-13", "CP1257", "ISO8859-14", "ISO8859-15", "ISO8859-16", "CP878", "MacJapan", "ASCII", "ANSI_X3.4-1968", "646", "CP65000", "CP65001", "UTF-8-MAC", "UTF-8-HFS", "UCS-2BE", "UCS-4BE", "UCS-4LE", "CP932", "csWindows31J", "SJIS", "PCK", "CP1250", "CP1251", "CP1252", "external", "locale"]`|No +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>|Yes +| <> |<>|No +| <> |<>, one of `["previous", "next"]`|Yes |======================================================================= diff --git a/docs/plugins/codecs/netflow.asciidoc b/docs/plugins/codecs/netflow.asciidoc index bc271b1a7..17c7f4695 100644 --- a/docs/plugins/codecs/netflow.asciidoc +++ b/docs/plugins/codecs/netflow.asciidoc @@ -145,7 +145,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/plain.asciidoc b/docs/plugins/codecs/plain.asciidoc index a79810e25..01fd31c4b 100644 --- a/docs/plugins/codecs/plain.asciidoc +++ b/docs/plugins/codecs/plain.asciidoc @@ -93,7 +93,7 @@ This setting only affects outputs (encoding of events). * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/codecs/rubydebug.asciidoc b/docs/plugins/codecs/rubydebug.asciidoc index ce168722c..316678bf4 100644 --- a/docs/plugins/codecs/rubydebug.asciidoc +++ b/docs/plugins/codecs/rubydebug.asciidoc @@ -66,7 +66,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/clone.asciidoc b/docs/plugins/filters/clone.asciidoc index 35240217a..a79e10abc 100644 --- a/docs/plugins/filters/clone.asciidoc +++ b/docs/plugins/filters/clone.asciidoc @@ -139,7 +139,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/csv.asciidoc b/docs/plugins/filters/csv.asciidoc index 37ee131a6..831c1bc35 100644 --- a/docs/plugins/filters/csv.asciidoc +++ b/docs/plugins/filters/csv.asciidoc @@ -177,7 +177,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/date.asciidoc b/docs/plugins/filters/date.asciidoc index dff0bf371..3a8f154ca 100644 --- a/docs/plugins/filters/date.asciidoc +++ b/docs/plugins/filters/date.asciidoc @@ -149,7 +149,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/dns.asciidoc b/docs/plugins/filters/dns.asciidoc index 0f5b0945a..39111e1c2 100644 --- a/docs/plugins/filters/dns.asciidoc +++ b/docs/plugins/filters/dns.asciidoc @@ -206,7 +206,7 @@ Use custom hosts file(s). For example: `["/var/db/my_custom_hosts"]` * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -315,10 +315,6 @@ Forward resolve one or more fields. * Value type is <> * There is no default value for this setting. -TODO(sissel): The timeout limitation does seem to be fixed in here: http://redmine.ruby-lang.org/issues/5100 # but isn't currently in JRuby. -TODO(sissel): make `action` required? This was always the intent, but it -due to a typo it was never enforced. Thus the default behavior in past -versions was `append` by accident. Reverse resolve one or more fields. [[plugins-filters-dns-timeout]] diff --git a/docs/plugins/filters/drop.asciidoc b/docs/plugins/filters/drop.asciidoc index 0737cdc36..8a857bfc2 100644 --- a/docs/plugins/filters/drop.asciidoc +++ b/docs/plugins/filters/drop.asciidoc @@ -142,7 +142,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/elapsed.asciidoc b/docs/plugins/filters/elapsed.asciidoc index 4bc934491..fa82634f2 100644 --- a/docs/plugins/filters/elapsed.asciidoc +++ b/docs/plugins/filters/elapsed.asciidoc @@ -9,9 +9,6 @@ NOTE: This plugin does not ship with Logstash by default, but it is easy to install by running `bin/logstash-plugin install logstash-filter-elapsed`. - -elapsed filter - This filter tracks a pair of start/end events and calculates the elapsed time between them. The elapsed filter tracks a pair of start/end events and uses their diff --git a/docs/plugins/filters/fingerprint.asciidoc b/docs/plugins/filters/fingerprint.asciidoc index d2009c116..ad3e58d05 100644 --- a/docs/plugins/filters/fingerprint.asciidoc +++ b/docs/plugins/filters/fingerprint.asciidoc @@ -14,7 +14,7 @@ For the list of Elastic supported plugins, please consult the https://www.elasti ==== Description - Fingerprint fields using by replacing values with a consistent hash. +Fingerprint fields using by replacing values with a consistent hash.   @@ -152,7 +152,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/geoip.asciidoc b/docs/plugins/filters/geoip.asciidoc index 81e7d43bd..0d9dcbb98 100644 --- a/docs/plugins/filters/geoip.asciidoc +++ b/docs/plugins/filters/geoip.asciidoc @@ -200,7 +200,7 @@ For the built-in GeoLite2 City database, the following are available: * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/grok.asciidoc b/docs/plugins/filters/grok.asciidoc index 83257ac72..253b0f7de 100644 --- a/docs/plugins/filters/grok.asciidoc +++ b/docs/plugins/filters/grok.asciidoc @@ -278,7 +278,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/json.asciidoc b/docs/plugins/filters/json.asciidoc index a973fbbff..2625c7a4f 100644 --- a/docs/plugins/filters/json.asciidoc +++ b/docs/plugins/filters/json.asciidoc @@ -147,7 +147,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/kv.asciidoc b/docs/plugins/filters/kv.asciidoc index 7472b6b16..2499d937d 100644 --- a/docs/plugins/filters/kv.asciidoc +++ b/docs/plugins/filters/kv.asciidoc @@ -249,7 +249,7 @@ fields: * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/metrics.asciidoc b/docs/plugins/filters/metrics.asciidoc index 828f3e17e..0aa7bc9d0 100644 --- a/docs/plugins/filters/metrics.asciidoc +++ b/docs/plugins/filters/metrics.asciidoc @@ -259,7 +259,7 @@ The flush interval, when the metrics event is created. Must be a multiple of 5s. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/mutate.asciidoc b/docs/plugins/filters/mutate.asciidoc index 3b2ce880d..ee59da925 100644 --- a/docs/plugins/filters/mutate.asciidoc +++ b/docs/plugins/filters/mutate.asciidoc @@ -197,7 +197,7 @@ Example: * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/ruby.asciidoc b/docs/plugins/filters/ruby.asciidoc index f28ee18f9..48dc23eee 100644 --- a/docs/plugins/filters/ruby.asciidoc +++ b/docs/plugins/filters/ruby.asciidoc @@ -160,7 +160,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/sleep.asciidoc b/docs/plugins/filters/sleep.asciidoc index 76b92d69a..877b9cbd9 100644 --- a/docs/plugins/filters/sleep.asciidoc +++ b/docs/plugins/filters/sleep.asciidoc @@ -151,7 +151,7 @@ Example: * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/split.asciidoc b/docs/plugins/filters/split.asciidoc index 8e622defe..0b7e386c1 100644 --- a/docs/plugins/filters/split.asciidoc +++ b/docs/plugins/filters/split.asciidoc @@ -178,7 +178,7 @@ Nested arrays are referenced like: "[object_id][array_id]" * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/syslog_pri.asciidoc b/docs/plugins/filters/syslog_pri.asciidoc index 2a6d4f86d..128aacd71 100644 --- a/docs/plugins/filters/syslog_pri.asciidoc +++ b/docs/plugins/filters/syslog_pri.asciidoc @@ -145,7 +145,7 @@ Labels for facility levels. This comes from RFC3164. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/throttle.asciidoc b/docs/plugins/filters/throttle.asciidoc index 446d12ff2..049091450 100644 --- a/docs/plugins/filters/throttle.asciidoc +++ b/docs/plugins/filters/throttle.asciidoc @@ -292,7 +292,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/urldecode.asciidoc b/docs/plugins/filters/urldecode.asciidoc index b72a79c1b..95ebcb798 100644 --- a/docs/plugins/filters/urldecode.asciidoc +++ b/docs/plugins/filters/urldecode.asciidoc @@ -159,7 +159,7 @@ The field which value is urldecoded * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/useragent.asciidoc b/docs/plugins/filters/useragent.asciidoc index 1a3a9936e..c18e277ee 100644 --- a/docs/plugins/filters/useragent.asciidoc +++ b/docs/plugins/filters/useragent.asciidoc @@ -141,7 +141,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/uuid.asciidoc b/docs/plugins/filters/uuid.asciidoc index 0b004e280..fa166c0db 100644 --- a/docs/plugins/filters/uuid.asciidoc +++ b/docs/plugins/filters/uuid.asciidoc @@ -135,7 +135,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/filters/xml.asciidoc b/docs/plugins/filters/xml.asciidoc index 95f2298aa..ef9fba470 100644 --- a/docs/plugins/filters/xml.asciidoc +++ b/docs/plugins/filters/xml.asciidoc @@ -158,7 +158,7 @@ parse to a hash value. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/beats.asciidoc b/docs/plugins/inputs/beats.asciidoc index 7870c5091..3bd426a4d 100644 --- a/docs/plugins/inputs/beats.asciidoc +++ b/docs/plugins/inputs/beats.asciidoc @@ -109,7 +109,7 @@ Add a field to an event ===== `cipher_suites` * Value type is <> - * Default value is `java.lang.String[TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256]@22fbd` + * Default value is `java.lang.String[TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256]@365fdb5a` The list of ciphers suite to use, listed by priorities. @@ -164,7 +164,7 @@ The IP address to listen on. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/couchdb_changes.asciidoc b/docs/plugins/inputs/couchdb_changes.asciidoc index a3c005aeb..32141211d 100644 --- a/docs/plugins/inputs/couchdb_changes.asciidoc +++ b/docs/plugins/inputs/couchdb_changes.asciidoc @@ -156,7 +156,7 @@ IP or hostname of your CouchDB instance * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/elasticsearch.asciidoc b/docs/plugins/inputs/elasticsearch.asciidoc index aa60ec6d3..29d43c8e4 100644 --- a/docs/plugins/inputs/elasticsearch.asciidoc +++ b/docs/plugins/inputs/elasticsearch.asciidoc @@ -190,7 +190,7 @@ port defaults to 9200 * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/exec.asciidoc b/docs/plugins/inputs/exec.asciidoc index 81a1117f5..8e92fb4cc 100644 --- a/docs/plugins/inputs/exec.asciidoc +++ b/docs/plugins/inputs/exec.asciidoc @@ -102,7 +102,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/file.asciidoc b/docs/plugins/inputs/file.asciidoc index 7104cdc36..5a5011ce5 100644 --- a/docs/plugins/inputs/file.asciidoc +++ b/docs/plugins/inputs/file.asciidoc @@ -76,7 +76,6 @@ written to the end of the file between the last read operation prior to the rotation and its reopening under the new name (an interval determined by the `stat_interval` and `discover_interval` options) will not get picked up. -TODO - move this to core   @@ -204,7 +203,7 @@ You might want to exclude gzipped files: * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/ganglia.asciidoc b/docs/plugins/inputs/ganglia.asciidoc index 8e0c84bac..7e602589e 100644 --- a/docs/plugins/inputs/ganglia.asciidoc +++ b/docs/plugins/inputs/ganglia.asciidoc @@ -94,7 +94,7 @@ The address to listen on * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/gelf.asciidoc b/docs/plugins/inputs/gelf.asciidoc index 2b9c7e6f2..4177d831f 100644 --- a/docs/plugins/inputs/gelf.asciidoc +++ b/docs/plugins/inputs/gelf.asciidoc @@ -108,7 +108,7 @@ The IP address or hostname to listen on. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/generator.asciidoc b/docs/plugins/inputs/generator.asciidoc index cbf486480..92562859e 100644 --- a/docs/plugins/inputs/generator.asciidoc +++ b/docs/plugins/inputs/generator.asciidoc @@ -101,7 +101,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/graphite.asciidoc b/docs/plugins/inputs/graphite.asciidoc index 4a98553d5..8ea1702e1 100644 --- a/docs/plugins/inputs/graphite.asciidoc +++ b/docs/plugins/inputs/graphite.asciidoc @@ -129,7 +129,7 @@ When mode is `client`, the address to connect to. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/heartbeat.asciidoc b/docs/plugins/inputs/heartbeat.asciidoc index 2ab0bfdd4..1fcc4532a 100644 --- a/docs/plugins/inputs/heartbeat.asciidoc +++ b/docs/plugins/inputs/heartbeat.asciidoc @@ -100,7 +100,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/http.asciidoc b/docs/plugins/inputs/http.asciidoc index 65a3eecff..6fb87261b 100644 --- a/docs/plugins/inputs/http.asciidoc +++ b/docs/plugins/inputs/http.asciidoc @@ -14,12 +14,6 @@ For the list of Elastic supported plugins, please consult the https://www.elasti ==== Description -We keep the redefined method in a new http server class, this is because -in other parts of logstash we might be using puma as webserver, for example -in the sinatra part we need this method to actually return the REQUEST_PATH, -so it can actually infer the right resource to use. -Fixes https://github.com/logstash-plugins/logstash-input-http/issues/51 -ensure this method doesn't mess up our vanilla request Using this input you can receive single or multiline events over http(s). Applications can send a HTTP POST request with a body to the endpoint started by this input and Logstash will convert it into an event for subsequent processing. Users @@ -140,7 +134,7 @@ The host or ip to bind * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/http_poller.asciidoc b/docs/plugins/inputs/http_poller.asciidoc index 07278ac96..6860e942c 100644 --- a/docs/plugins/inputs/http_poller.asciidoc +++ b/docs/plugins/inputs/http_poller.asciidoc @@ -235,7 +235,7 @@ Should redirects be followed? Defaults to `true` * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/imap.asciidoc b/docs/plugins/inputs/imap.asciidoc index 75a2dab6f..bae3f2d3c 100644 --- a/docs/plugins/inputs/imap.asciidoc +++ b/docs/plugins/inputs/imap.asciidoc @@ -161,7 +161,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/irc.asciidoc b/docs/plugins/inputs/irc.asciidoc index 82dff8f62..a1801a592 100644 --- a/docs/plugins/inputs/irc.asciidoc +++ b/docs/plugins/inputs/irc.asciidoc @@ -138,7 +138,7 @@ Host of the IRC Server to connect to. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/jdbc.asciidoc b/docs/plugins/inputs/jdbc.asciidoc index 0f728d0fb..ffbdba46f 100644 --- a/docs/plugins/inputs/jdbc.asciidoc +++ b/docs/plugins/inputs/jdbc.asciidoc @@ -72,7 +72,7 @@ Logstash configuration for this. The `schedule` option in this example will instruct the plugin to execute this input statement on the minute, every minute. [source,ruby] --------------------------------------------------------------------------- +---------------------------------- input { jdbc { jdbc_driver_library => "mysql-connector-java-5.1.36-bin.jar" @@ -84,7 +84,7 @@ input { statement => "SELECT * from songs where artist = :favorite_artist" } } --------------------------------------------------------------------------- +---------------------------------- ==== Configuring SQL statement @@ -107,7 +107,7 @@ this is set to Thursday, 1 January 1970, or 0 if `use_column_value` is true and Example: [source,ruby] --------------------------------------------------------------------------- +---------------------------------- input { jdbc { statement => "SELECT id, mycolumn1, mycolumn2 FROM my_table WHERE id > :sql_last_value" @@ -116,7 +116,7 @@ input { # ... other configuration bits } } --------------------------------------------------------------------------- +----------------------------------   @@ -238,7 +238,8 @@ input { ... } } ----------------------------------- +----------------------------------- + this will only convert column0 that has ISO-8859-1 as an original encoding. [[plugins-inputs-jdbc-connection_retry_attempts]] @@ -274,7 +275,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -423,7 +424,7 @@ How often to validate a connection (in seconds) ===== `last_run_metadata_path` * Value type is <> - * Default value is `"/Users/suyog/.logstash_jdbc_last_run"` + * Default value is `"/Users/dedemorton/.logstash_jdbc_last_run"` Path to file with last run time @@ -499,9 +500,9 @@ To use parameters, use named parameter syntax. For example: [source, ruby] ------------------------------------------------ +---------------------------------- "SELECT * FROM MYTABLE WHERE id = :target_id" ------------------------------------------------ +---------------------------------- here, `:target_id` is a named parameter. You can configure named parameters with the `parameters` setting. diff --git a/docs/plugins/inputs/kafka.asciidoc b/docs/plugins/inputs/kafka.asciidoc index edd3ec7f1..6b3673b7c 100644 --- a/docs/plugins/inputs/kafka.asciidoc +++ b/docs/plugins/inputs/kafka.asciidoc @@ -310,7 +310,7 @@ It can be adjusted even lower to control the expected time for normal rebalances * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/log4j.asciidoc b/docs/plugins/inputs/log4j.asciidoc index e0cea9b52..fc5a368d0 100644 --- a/docs/plugins/inputs/log4j.asciidoc +++ b/docs/plugins/inputs/log4j.asciidoc @@ -115,7 +115,7 @@ When mode is `client`, the address to connect to. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/lumberjack.asciidoc b/docs/plugins/inputs/lumberjack.asciidoc index 8e47bd20e..e0addd147 100644 --- a/docs/plugins/inputs/lumberjack.asciidoc +++ b/docs/plugins/inputs/lumberjack.asciidoc @@ -114,7 +114,7 @@ The IP address to listen on. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/pipe.asciidoc b/docs/plugins/inputs/pipe.asciidoc index 860cba565..111c6c000 100644 --- a/docs/plugins/inputs/pipe.asciidoc +++ b/docs/plugins/inputs/pipe.asciidoc @@ -79,8 +79,6 @@ The codec used for input data. Input codecs are a convenient method for decoding * Value type is <> * There is no default value for this setting. -TODO(sissel): This should switch to use the `line` codec by default -once we switch away from doing 'readline' Command to run and read events from, one line at a time. Example: @@ -104,7 +102,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/rabbitmq.asciidoc b/docs/plugins/inputs/rabbitmq.asciidoc index 1b0f8c827..81c0ab22e 100644 --- a/docs/plugins/inputs/rabbitmq.asciidoc +++ b/docs/plugins/inputs/rabbitmq.asciidoc @@ -293,7 +293,7 @@ Note that only one host connection is active at a time. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/redis.asciidoc b/docs/plugins/inputs/redis.asciidoc index 80190d8dc..d41119169 100644 --- a/docs/plugins/inputs/redis.asciidoc +++ b/docs/plugins/inputs/redis.asciidoc @@ -2,11 +2,18 @@ === redis * Version: 3.1.2 -* Released on: 2017-02-01 +* Released on: February 1, 2017 * https://github.com/logstash-plugins/logstash-input-redis/blob/master/CHANGELOG.md#312[Changelog] +==== Getting Help + +For questions about the plugin, open a topic in the http://discuss.elastic.co[Discuss] forums. For bugs or feature requests, open an issue in https://github.com/elastic/logstash[Github]. +For the list of Elastic supported plugins, please consult the https://www.elastic.co/support/matrix#show_logstash_plugins[Elastic Support Matrix]. + +==== Description + This input will read events from a Redis instance; it supports both Redis channels and lists. The list command (BLPOP) used by Logstash is supported in Redis v1.3.1+, and the channel commands used by Logstash are found in Redis v1.3.8+. @@ -40,24 +47,24 @@ redis { Available configuration options: -[cols="<,<,<,> |<>|No|`{}` -| <> |<>|No|`125` -| <> |<>|No|`"plain"` -| <> |<>, one of `["list", "channel", "pattern_channel"]`|Yes| -| <> |<>|No|`0` -| <> |<>|No|`true` -| <> |<>|No|`"127.0.0.1"` -| <> |<>|No| -| <> |<>|Yes| -| <> |<>|No| -| <> |<>|No|`6379` -| <> |<>|No| -| <> |<>|No|`1` -| <> |<>|No|`5` -| <> |<>|No| +|Setting |Input type|Required +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>, one of `["list", "channel", "pattern_channel"]`|Yes +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>|Yes +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>|No +| <> |<>|No |======================================================================= @@ -204,6 +211,7 @@ Initial connection timeout in seconds. * Value type is <> * There is no default value for this setting. +This is the base class for Logstash inputs. Add a `type` field to all events handled by this input. Types are used mainly for filter activation. diff --git a/docs/plugins/inputs/s3.asciidoc b/docs/plugins/inputs/s3.asciidoc index a9fecb630..237a58b3d 100644 --- a/docs/plugins/inputs/s3.asciidoc +++ b/docs/plugins/inputs/s3.asciidoc @@ -186,7 +186,7 @@ Ruby style regexp of keys to exclude from the bucket * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -274,7 +274,7 @@ This can help with processing later. ===== `temporary_directory` * Value type is <> - * Default value is `"/var/folders/_9/x4bq65rs6vd0rrjthct3zxjw0000gn/T/logstash"` + * Default value is `"/var/folders/s9/fp9p03r525d_cgclm9ps2n6r0000gn/T/logstash"` Set the directory where logstash will store the tmp files before processing them. default to the current OS temporary directory in linux /tmp/logstash diff --git a/docs/plugins/inputs/snmptrap.asciidoc b/docs/plugins/inputs/snmptrap.asciidoc index 5cc7e93fb..37cf42145 100644 --- a/docs/plugins/inputs/snmptrap.asciidoc +++ b/docs/plugins/inputs/snmptrap.asciidoc @@ -111,7 +111,7 @@ The address to listen on * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/sqs.asciidoc b/docs/plugins/inputs/sqs.asciidoc index ed2bc290d..f4b0d9efc 100644 --- a/docs/plugins/inputs/sqs.asciidoc +++ b/docs/plugins/inputs/sqs.asciidoc @@ -180,7 +180,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/stdin.asciidoc b/docs/plugins/inputs/stdin.asciidoc index 37d19ff3c..219b84c3d 100644 --- a/docs/plugins/inputs/stdin.asciidoc +++ b/docs/plugins/inputs/stdin.asciidoc @@ -86,7 +86,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/stomp.asciidoc b/docs/plugins/inputs/stomp.asciidoc index fd5d0f320..4f7540e4c 100644 --- a/docs/plugins/inputs/stomp.asciidoc +++ b/docs/plugins/inputs/stomp.asciidoc @@ -10,8 +10,7 @@ NOTE: This plugin does not ship with Logstash by default, but it is easy to install by running `bin/logstash-plugin install logstash-input-stomp`. -Handle disconnects - +Creates events received with the STOMP protocol   ==== Synopsis diff --git a/docs/plugins/inputs/syslog.asciidoc b/docs/plugins/inputs/syslog.asciidoc index 7236d175f..af4736e11 100644 --- a/docs/plugins/inputs/syslog.asciidoc +++ b/docs/plugins/inputs/syslog.asciidoc @@ -122,7 +122,7 @@ The address to listen on. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/tcp.asciidoc b/docs/plugins/inputs/tcp.asciidoc index a471c2ce8..98c4f3783 100644 --- a/docs/plugins/inputs/tcp.asciidoc +++ b/docs/plugins/inputs/tcp.asciidoc @@ -117,7 +117,7 @@ When mode is `client`, the address to connect to. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/twitter.asciidoc b/docs/plugins/inputs/twitter.asciidoc index 25ebec84f..f8841a7fb 100644 --- a/docs/plugins/inputs/twitter.asciidoc +++ b/docs/plugins/inputs/twitter.asciidoc @@ -146,7 +146,7 @@ Record full tweet object as given to us by the Twitter Streaming API. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/udp.asciidoc b/docs/plugins/inputs/udp.asciidoc index 73f8344f5..b815b1587 100644 --- a/docs/plugins/inputs/udp.asciidoc +++ b/docs/plugins/inputs/udp.asciidoc @@ -109,7 +109,7 @@ The address which logstash will listen on. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/unix.asciidoc b/docs/plugins/inputs/unix.asciidoc index c0ad7b809..1948a1b44 100644 --- a/docs/plugins/inputs/unix.asciidoc +++ b/docs/plugins/inputs/unix.asciidoc @@ -114,7 +114,7 @@ Remove socket file in case of EADDRINUSE failure * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/inputs/xmpp.asciidoc b/docs/plugins/inputs/xmpp.asciidoc index 17713a902..4bec01bfb 100644 --- a/docs/plugins/inputs/xmpp.asciidoc +++ b/docs/plugins/inputs/xmpp.asciidoc @@ -102,7 +102,7 @@ the host on the user/identity is used. (`foo.com` for `user@foo.com`) * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. diff --git a/docs/plugins/outputs/boundary.asciidoc b/docs/plugins/outputs/boundary.asciidoc index c065f8adc..eb5b7790f 100644 --- a/docs/plugins/outputs/boundary.asciidoc +++ b/docs/plugins/outputs/boundary.asciidoc @@ -185,8 +185,3 @@ By default this is set to `event["@timestamp"].to_i` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/circonus.asciidoc b/docs/plugins/outputs/circonus.asciidoc index 8e04c8ace..a45e22602 100644 --- a/docs/plugins/outputs/circonus.asciidoc +++ b/docs/plugins/outputs/circonus.asciidoc @@ -51,7 +51,7 @@ Available configuration options:   [[plugins-outputs-circonus-annotation]] -===== `annotation` +===== `annotation` * This is a required setting. * Value type is <> @@ -72,7 +72,7 @@ or ["title":"Logstash event", "description":"Logstash event for %{host}", "parent_id", "1"] [[plugins-outputs-circonus-api_token]] -===== `api_token` +===== `api_token` * This is a required setting. * Value type is <> @@ -84,7 +84,7 @@ Circonus based on Logstash events Your Circonus API Token [[plugins-outputs-circonus-app_name]] -===== `app_name` +===== `app_name` * This is a required setting. * Value type is <> @@ -98,7 +98,7 @@ Example: `app_name => "%{myappname}"` [[plugins-outputs-circonus-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -106,7 +106,7 @@ Example: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-circonus-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -116,7 +116,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-circonus-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -135,13 +135,11 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-circonus-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/cloudwatch.asciidoc b/docs/plugins/outputs/cloudwatch.asciidoc index 280faafba..3a48d17c1 100644 --- a/docs/plugins/outputs/cloudwatch.asciidoc +++ b/docs/plugins/outputs/cloudwatch.asciidoc @@ -249,7 +249,7 @@ The name of the field used to set the value (float) on an event metric * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -367,8 +367,4 @@ If you set this option you should probably set the `unit` option along with it * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - diff --git a/docs/plugins/outputs/csv.asciidoc b/docs/plugins/outputs/csv.asciidoc index e9fb06fd8..5bb852cee 100644 --- a/docs/plugins/outputs/csv.asciidoc +++ b/docs/plugins/outputs/csv.asciidoc @@ -168,7 +168,7 @@ Gzip the output stream before writing to disk. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -227,8 +227,4 @@ may not make the values safe in your spreadsheet application * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - diff --git a/docs/plugins/outputs/datadog.asciidoc b/docs/plugins/outputs/datadog.asciidoc index 04ae2a4c1..e6ba04368 100644 --- a/docs/plugins/outputs/datadog.asciidoc +++ b/docs/plugins/outputs/datadog.asciidoc @@ -54,7 +54,7 @@ Available configuration options:   [[plugins-outputs-datadog-alert_type]] -===== `alert_type` +===== `alert_type` * Value can be any of: `info`, `error`, `warning`, `success` * There is no default value for this setting. @@ -62,7 +62,7 @@ Available configuration options: Alert type [[plugins-outputs-datadog-api_key]] -===== `api_key` +===== `api_key` * This is a required setting. * Value type is <> @@ -77,7 +77,7 @@ these will be one-shot events Your DatadogHQ API key [[plugins-outputs-datadog-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -85,7 +85,7 @@ Your DatadogHQ API key The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-datadog-date_happened]] -===== `date_happened` +===== `date_happened` * Value type is <> * There is no default value for this setting. @@ -93,7 +93,7 @@ The codec used for output data. Output codecs are a convenient method for encodi Date Happened [[plugins-outputs-datadog-dd_tags]] -===== `dd_tags` +===== `dd_tags` * Value type is <> * There is no default value for this setting. @@ -103,7 +103,7 @@ Set any custom tags for this event Default are the Logstash tags if any [[plugins-outputs-datadog-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -113,7 +113,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-datadog-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -132,7 +132,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-datadog-priority]] -===== `priority` +===== `priority` * Value can be any of: `normal`, `low` * There is no default value for this setting. @@ -140,7 +140,7 @@ If you don't explicitely set this variable Logstash will generate a unique name. Priority [[plugins-outputs-datadog-source_type_name]] -===== `source_type_name` +===== `source_type_name` * Value can be any of: `nagios`, `hudson`, `jenkins`, `user`, `my apps`, `feed`, `chef`, `puppet`, `git`, `bitbucket`, `fabric`, `capistrano` * Default value is `"my apps"` @@ -148,7 +148,7 @@ Priority Source type name [[plugins-outputs-datadog-text]] -===== `text` +===== `text` * Value type is <> * Default value is `"%{message}"` @@ -156,7 +156,7 @@ Source type name Text [[plugins-outputs-datadog-title]] -===== `title` +===== `title` * Value type is <> * Default value is `"Logstash event for %{host}"` @@ -164,13 +164,11 @@ Text Title [[plugins-outputs-datadog-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/datadog_metrics.asciidoc b/docs/plugins/outputs/datadog_metrics.asciidoc index 290441e0f..c92582cca 100644 --- a/docs/plugins/outputs/datadog_metrics.asciidoc +++ b/docs/plugins/outputs/datadog_metrics.asciidoc @@ -58,7 +58,7 @@ Available configuration options:   [[plugins-outputs-datadog_metrics-api_key]] -===== `api_key` +===== `api_key` * This is a required setting. * Value type is <> @@ -67,7 +67,7 @@ Available configuration options: Your DatadogHQ API key. https://app.datadoghq.com/account/settings#api [[plugins-outputs-datadog_metrics-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -75,7 +75,7 @@ Your DatadogHQ API key. https://app.datadoghq.com/account/settings#api The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-datadog_metrics-dd_tags]] -===== `dd_tags` +===== `dd_tags` * Value type is <> * There is no default value for this setting. @@ -84,7 +84,7 @@ Set any custom tags for this event, default are the Logstash tags if any. [[plugins-outputs-datadog_metrics-device]] -===== `device` +===== `device` * Value type is <> * Default value is `"%{metric_device}"` @@ -92,7 +92,7 @@ default are the Logstash tags if any. The name of the device that produced the metric. [[plugins-outputs-datadog_metrics-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -102,7 +102,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-datadog_metrics-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"%{host}"` @@ -110,7 +110,7 @@ for a specific plugin. The name of the host that produced the metric. [[plugins-outputs-datadog_metrics-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -129,7 +129,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-datadog_metrics-metric_name]] -===== `metric_name` +===== `metric_name` * Value type is <> * Default value is `"%{metric_name}"` @@ -137,7 +137,7 @@ If you don't explicitely set this variable Logstash will generate a unique name. The name of the time series. [[plugins-outputs-datadog_metrics-metric_type]] -===== `metric_type` +===== `metric_type` * Value can be any of: `gauge`, `counter`, `%{metric_type}` * Default value is `"%{metric_type}"` @@ -145,7 +145,7 @@ The name of the time series. The type of the metric. [[plugins-outputs-datadog_metrics-metric_value]] -===== `metric_value` +===== `metric_value` * Value type is <> * Default value is `"%{metric_value}"` @@ -153,7 +153,7 @@ The type of the metric. The value. [[plugins-outputs-datadog_metrics-queue_size]] -===== `queue_size` +===== `queue_size` * Value type is <> * Default value is `10` @@ -162,7 +162,7 @@ How many events to queue before flushing to Datadog prior to schedule set in `@timeframe` [[plugins-outputs-datadog_metrics-timeframe]] -===== `timeframe` +===== `timeframe` * Value type is <> * Default value is `10` @@ -170,13 +170,11 @@ prior to schedule set in `@timeframe` How often (in seconds) to flush queued events to Datadog [[plugins-outputs-datadog_metrics-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/elasticsearch.asciidoc b/docs/plugins/outputs/elasticsearch.asciidoc index 777611837..73824a379 100644 --- a/docs/plugins/outputs/elasticsearch.asciidoc +++ b/docs/plugins/outputs/elasticsearch.asciidoc @@ -298,7 +298,7 @@ Any special characters present in the URLs here MUST be URL escaped! This means * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -708,8 +708,4 @@ See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-in * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - diff --git a/docs/plugins/outputs/email.asciidoc b/docs/plugins/outputs/email.asciidoc index 50161c573..b43fcba98 100644 --- a/docs/plugins/outputs/email.asciidoc +++ b/docs/plugins/outputs/email.asciidoc @@ -11,7 +11,7 @@ NOTE: This plugin does not ship with Logstash by default, but it is easy to inst Send email when an output is received. Alternatively, you may include or -exclude the email output execution using conditionals. +exclude the email output execution using conditionals.   @@ -65,7 +65,7 @@ Available configuration options:   [[plugins-outputs-email-address]] -===== `address` +===== `address` * Value type is <> * Default value is `"localhost"` @@ -73,7 +73,7 @@ Available configuration options: The address used to connect to the mail server [[plugins-outputs-email-attachments]] -===== `attachments` +===== `attachments` * Value type is <> * Default value is `[]` @@ -81,7 +81,7 @@ The address used to connect to the mail server Attachments - specify the name(s) and location(s) of the files. [[plugins-outputs-email-authentication]] -===== `authentication` +===== `authentication` * Value type is <> * There is no default value for this setting. @@ -89,7 +89,7 @@ Attachments - specify the name(s) and location(s) of the files. Authentication method used when identifying with the server [[plugins-outputs-email-body]] -===== `body` +===== `body` * Value type is <> * Default value is `""` @@ -97,18 +97,18 @@ Authentication method used when identifying with the server Body for the email - plain text only. [[plugins-outputs-email-cc]] -===== `cc` +===== `cc` * Value type is <> * There is no default value for this setting. The fully-qualified email address(es) to include as cc: address(es). -This field also accepts a comma-separated string of addresses, for example: +This field also accepts a comma-separated string of addresses, for example: `"me@host.com, you@host.com"` [[plugins-outputs-email-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -116,7 +116,7 @@ This field also accepts a comma-separated string of addresses, for example: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-email-contenttype]] -===== `contenttype` +===== `contenttype` * Value type is <> * Default value is `"text/html; charset=UTF-8"` @@ -125,7 +125,7 @@ contenttype : for multipart messages, set the content-type and/or charset of the NOTE: this may not be functional (KH) [[plugins-outputs-email-debug]] -===== `debug` +===== `debug` * Value type is <> * Default value is `false` @@ -133,7 +133,7 @@ NOTE: this may not be functional (KH) Run the mail relay in debug mode [[plugins-outputs-email-domain]] -===== `domain` +===== `domain` * Value type is <> * Default value is `"localhost"` @@ -141,7 +141,7 @@ Run the mail relay in debug mode Domain used to send the email messages [[plugins-outputs-email-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -151,7 +151,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-email-from]] -===== `from` +===== `from` * Value type is <> * Default value is `"logstash.alert@nowhere.com"` @@ -159,7 +159,7 @@ for a specific plugin. The fully-qualified email address for the From: field in the email. [[plugins-outputs-email-htmlbody]] -===== `htmlbody` +===== `htmlbody` * Value type is <> * Default value is `""` @@ -167,7 +167,7 @@ The fully-qualified email address for the From: field in the email. HTML Body for the email, which may contain HTML markup. [[plugins-outputs-email-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -186,7 +186,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-email-password]] -===== `password` +===== `password` * Value type is <> * There is no default value for this setting. @@ -194,7 +194,7 @@ If you don't explicitely set this variable Logstash will generate a unique name. Password to authenticate with the server [[plugins-outputs-email-port]] -===== `port` +===== `port` * Value type is <> * Default value is `25` @@ -202,7 +202,7 @@ Password to authenticate with the server Port used to communicate with the mail server [[plugins-outputs-email-replyto]] -===== `replyto` +===== `replyto` * Value type is <> * There is no default value for this setting. @@ -210,7 +210,7 @@ Port used to communicate with the mail server The fully qualified email address for the Reply-To: field. [[plugins-outputs-email-subject]] -===== `subject` +===== `subject` * Value type is <> * Default value is `""` @@ -218,7 +218,7 @@ The fully qualified email address for the Reply-To: field. Subject: for the email. [[plugins-outputs-email-to]] -===== `to` +===== `to` * This is a required setting. * Value type is <> @@ -226,13 +226,13 @@ Subject: for the email. The fully-qualified email address to send the email to. -This field also accepts a comma-separated string of addresses, for example: +This field also accepts a comma-separated string of addresses, for example: `"me@host.com, you@host.com"` You can also use dynamic fields from the event with the `%{fieldname}` syntax. [[plugins-outputs-email-use_tls]] -===== `use_tls` +===== `use_tls` * Value type is <> * Default value is `false` @@ -240,7 +240,7 @@ You can also use dynamic fields from the event with the `%{fieldname}` syntax. Enables TLS when communicating with the server [[plugins-outputs-email-username]] -===== `username` +===== `username` * Value type is <> * There is no default value for this setting. @@ -248,7 +248,7 @@ Enables TLS when communicating with the server Username to authenticate with the server [[plugins-outputs-email-via]] -===== `via` +===== `via` * Value type is <> * Default value is `"smtp"` @@ -256,13 +256,11 @@ Username to authenticate with the server How Logstash should send the email, either via SMTP or by invoking sendmail. [[plugins-outputs-email-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/exec.asciidoc b/docs/plugins/outputs/exec.asciidoc index d8e500897..18495ad9c 100644 --- a/docs/plugins/outputs/exec.asciidoc +++ b/docs/plugins/outputs/exec.asciidoc @@ -70,7 +70,7 @@ Available configuration options:   [[plugins-outputs-exec-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -78,7 +78,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-exec-command]] -===== `command` +===== `command` * This is a required setting. * Value type is <> @@ -89,7 +89,7 @@ make it non blocking. This value can include `%{name}` and other dynamic strings. [[plugins-outputs-exec-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -99,7 +99,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-exec-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -118,7 +118,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-exec-quiet]] -===== `quiet` +===== `quiet` * Value type is <> * Default value is `false` @@ -126,13 +126,11 @@ If you don't explicitely set this variable Logstash will generate a unique name. display the result of the command to the terminal [[plugins-outputs-exec-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/file.asciidoc b/docs/plugins/outputs/file.asciidoc index ec3b88ec2..e5a137e24 100644 --- a/docs/plugins/outputs/file.asciidoc +++ b/docs/plugins/outputs/file.asciidoc @@ -149,7 +149,7 @@ Gzip the output stream before writing to disk. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -187,8 +187,4 @@ E.g: `/%{myfield}/`, `/test-%{myfield}/` are not valid paths * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - diff --git a/docs/plugins/outputs/ganglia.asciidoc b/docs/plugins/outputs/ganglia.asciidoc index d3ee7504b..d79b38387 100644 --- a/docs/plugins/outputs/ganglia.asciidoc +++ b/docs/plugins/outputs/ganglia.asciidoc @@ -58,7 +58,7 @@ Available configuration options:   [[plugins-outputs-ganglia-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -66,7 +66,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-ganglia-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -76,7 +76,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-ganglia-group]] -===== `group` +===== `group` * Value type is <> * Default value is `""` @@ -84,7 +84,7 @@ for a specific plugin. Metric group [[plugins-outputs-ganglia-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"localhost"` @@ -92,7 +92,7 @@ Metric group The address of the ganglia server. [[plugins-outputs-ganglia-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -111,7 +111,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-ganglia-lifetime]] -===== `lifetime` +===== `lifetime` * Value type is <> * Default value is `300` @@ -119,7 +119,7 @@ If you don't explicitely set this variable Logstash will generate a unique name. Lifetime in seconds of this metric [[plugins-outputs-ganglia-max_interval]] -===== `max_interval` +===== `max_interval` * Value type is <> * Default value is `60` @@ -127,7 +127,7 @@ Lifetime in seconds of this metric Maximum time in seconds between gmetric calls for this metric. [[plugins-outputs-ganglia-metric]] -===== `metric` +===== `metric` * This is a required setting. * Value type is <> @@ -136,7 +136,7 @@ Maximum time in seconds between gmetric calls for this metric. The metric to use. This supports dynamic strings like `%{host}` [[plugins-outputs-ganglia-metric_type]] -===== `metric_type` +===== `metric_type` * Value can be any of: `string`, `int8`, `uint8`, `int16`, `uint16`, `int32`, `uint32`, `float`, `double` * Default value is `"uint8"` @@ -144,7 +144,7 @@ The metric to use. This supports dynamic strings like `%{host}` The type of value for this metric. [[plugins-outputs-ganglia-port]] -===== `port` +===== `port` * Value type is <> * Default value is `8649` @@ -152,7 +152,7 @@ The type of value for this metric. The port to connect on your ganglia server. [[plugins-outputs-ganglia-slope]] -===== `slope` +===== `slope` * Value can be any of: `zero`, `positive`, `negative`, `both`, `unspecified` * Default value is `"both"` @@ -160,7 +160,7 @@ The port to connect on your ganglia server. Metric slope, represents metric behavior [[plugins-outputs-ganglia-units]] -===== `units` +===== `units` * Value type is <> * Default value is `""` @@ -169,7 +169,7 @@ Gmetric units for metric, such as "kb/sec" or "ms" or whatever unit this metric uses. [[plugins-outputs-ganglia-value]] -===== `value` +===== `value` * This is a required setting. * Value type is <> @@ -180,13 +180,11 @@ It will be coerced to a floating point value. Values which cannot be coerced will zero (0) [[plugins-outputs-ganglia-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/gelf.asciidoc b/docs/plugins/outputs/gelf.asciidoc index 703d2be0d..50e37961e 100644 --- a/docs/plugins/outputs/gelf.asciidoc +++ b/docs/plugins/outputs/gelf.asciidoc @@ -60,7 +60,7 @@ Available configuration options:   [[plugins-outputs-gelf-chunksize]] -===== `chunksize` +===== `chunksize` * Value type is <> * Default value is `1420` @@ -68,7 +68,7 @@ Available configuration options: The GELF chunksize. You usually don't need to change this. [[plugins-outputs-gelf-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -76,7 +76,7 @@ The GELF chunksize. You usually don't need to change this. The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-gelf-custom_fields]] -===== `custom_fields` +===== `custom_fields` * Value type is <> * Default value is `{}` @@ -87,7 +87,7 @@ e.g. `custom_fields => ['foo_field', 'some_value']` sets `_foo_field` = `some_value`. [[plugins-outputs-gelf-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -97,7 +97,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-gelf-full_message]] -===== `full_message` +===== `full_message` * Value type is <> * Default value is `"%{message}"` @@ -105,7 +105,7 @@ for a specific plugin. The GELF full message. Dynamic values like `%{foo}` are permitted here. [[plugins-outputs-gelf-host]] -===== `host` +===== `host` * This is a required setting. * Value type is <> @@ -114,7 +114,7 @@ The GELF full message. Dynamic values like `%{foo}` are permitted here. Graylog2 server IP address or hostname. [[plugins-outputs-gelf-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -133,7 +133,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-gelf-ignore_metadata]] -===== `ignore_metadata` +===== `ignore_metadata` * Value type is <> * Default value is `["@timestamp", "@version", "severity", "host", "source_host", "source_path", "short_message"]` @@ -142,7 +142,7 @@ Ignore these fields when `ship_metadata` is set. Typically this lists the fields used in dynamic values for GELF fields. [[plugins-outputs-gelf-level]] -===== `level` +===== `level` * Value type is <> * Default value is `["%{severity}", "INFO"]` @@ -160,7 +160,7 @@ are accepted: "emergency", "alert", "critical", "warning", "notice", and "informational". [[plugins-outputs-gelf-port]] -===== `port` +===== `port` * Value type is <> * Default value is `12201` @@ -168,7 +168,7 @@ are accepted: "emergency", "alert", "critical", "warning", "notice", and Graylog2 server port number. [[plugins-outputs-gelf-sender]] -===== `sender` +===== `sender` * Value type is <> * Default value is `"%{host}"` @@ -179,7 +179,7 @@ want to use something other than the event's source host as the instead of the hostname. [[plugins-outputs-gelf-ship_metadata]] -===== `ship_metadata` +===== `ship_metadata` * Value type is <> * Default value is `true` @@ -189,7 +189,7 @@ to ship any fields in the event (such as those created by grok) in the GELF messages. These will be sent as underscored "additional fields". [[plugins-outputs-gelf-ship_tags]] -===== `ship_tags` +===== `ship_tags` * Value type is <> * Default value is `true` @@ -198,7 +198,7 @@ Ship tags within events. This will cause Logstash to ship the tags of an event as the field `\_tags`. [[plugins-outputs-gelf-short_message]] -===== `short_message` +===== `short_message` * Value type is <> * Default value is `"short_message"` @@ -207,13 +207,11 @@ The GELF short message field name. If the field does not exist or is empty, the event message is taken instead. [[plugins-outputs-gelf-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/google_bigquery.asciidoc b/docs/plugins/outputs/google_bigquery.asciidoc index cdf324b22..af0831ca6 100644 --- a/docs/plugins/outputs/google_bigquery.asciidoc +++ b/docs/plugins/outputs/google_bigquery.asciidoc @@ -9,7 +9,8 @@ NOTE: This plugin does not ship with Logstash by default, but it is easy to install by running `bin/logstash-plugin install logstash-output-google_bigquery`. - +[source,txt] +----- Author: Rodrigo De Castro Date: 2013-09-20 @@ -26,16 +27,20 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. +----- + Summary: plugin to upload log events to Google BigQuery (BQ), rolling files based on the date pattern provided as a configuration setting. Events are written to files locally and, once file is closed, this plugin uploads it to the configured BigQuery dataset. VERY IMPORTANT: -1 - To make good use of BigQuery, your log events should be parsed and + +. To make good use of BigQuery, your log events should be parsed and structured. Consider using grok to parse your events into fields that can be uploaded to BQ. -2 - You must configure your plugin so it gets events with the same structure, + +. You must configure your plugin so it gets events with the same structure, so the BigQuery schema suits them. In case you want to upload log events with different structures, you can utilize multiple configuration blocks, separating different log events with Logstash conditionals. More details on @@ -50,14 +55,16 @@ more information, please refer to: https://developers.google.com/storage/docs/authentication#service_accounts Recommendations: -a - Experiment with the settings depending on how much log data you generate, + +. Experiment with the settings depending on how much log data you generate, your needs to see "fresh" data, and how much data you could lose in the event of crash. For instance, if you want to see recent data in BQ quickly, you could configure the plugin to upload data every minute or so (provided you have enough log events to justify that). Note also, that if uploads are too frequent, there is no guarantee that they will be imported in the same order, so later data may be available before earlier data. -b - BigQuery charges for storage and for queries, depending on how much data + +. BigQuery charges for storage and for queries, depending on how much data it reads to perform a query. These are other aspects to consider when considering the date pattern which will be used to create new tables and also how to compose the queries when using BQ. For more info on BigQuery Pricing, @@ -67,11 +74,13 @@ https://developers.google.com/bigquery/pricing USAGE: This is an example of logstash config: +[source,json] +-------------------------- output { google_bigquery { project_id => "folkloric-guru-278" (required) dataset => "logs" (required) - csv_schema => "path:STRING,status:INTEGER,score:FLOAT" (required*) + csv_schema => "path:STRING,status:INTEGER,score:FLOAT" (required) <1> key_path => "/path/to/privatekey.p12" (required) key_password => "notasecret" (optional) service_account => "1234@developer.gserviceaccount.com" (required) @@ -83,13 +92,15 @@ output { deleter_interval_secs => 60 (optional) } } +-------------------------- -* Specify either a csv_schema or a json_schema. +<1> Specify either a csv_schema or a json_schema. Improvements TODO list: -- Refactor common code between Google BQ and GCS plugins. -- Turn Google API code into a Plugin Mixin (like AwsConfig). -- There's no recover method, so if logstash/plugin crashes, files may not + +* Refactor common code between Google BQ and GCS plugins. +* Turn Google API code into a Plugin Mixin (like AwsConfig). +* There's no recover method, so if logstash/plugin crashes, files may not be uploaded to BQ.   @@ -145,7 +156,7 @@ Available configuration options:   [[plugins-outputs-google_bigquery-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -153,7 +164,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-google_bigquery-csv_schema]] -===== `csv_schema` +===== `csv_schema` * Value type is <> * Default value is `nil` @@ -163,7 +174,7 @@ Schema for log data. It must follow this format: Example: path:STRING,status:INTEGER,score:FLOAT [[plugins-outputs-google_bigquery-dataset]] -===== `dataset` +===== `dataset` * This is a required setting. * Value type is <> @@ -172,7 +183,7 @@ Example: path:STRING,status:INTEGER,score:FLOAT BigQuery dataset to which these events will be added to. [[plugins-outputs-google_bigquery-date_pattern]] -===== `date_pattern` +===== `date_pattern` * Value type is <> * Default value is `"%Y-%m-%dT%H:00"` @@ -181,7 +192,7 @@ Time pattern for BigQuery table, defaults to hourly tables. Must Time.strftime patterns: www.ruby-doc.org/core-2.0/Time.html#method-i-strftime [[plugins-outputs-google_bigquery-deleter_interval_secs]] -===== `deleter_interval_secs` +===== `deleter_interval_secs` * Value type is <> * Default value is `60` @@ -190,7 +201,7 @@ Deleter interval when checking if upload jobs are done for file deletion. This only affects how long files are on the hard disk after the job is done. [[plugins-outputs-google_bigquery-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -200,7 +211,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-google_bigquery-flush_interval_secs]] -===== `flush_interval_secs` +===== `flush_interval_secs` * Value type is <> * Default value is `2` @@ -209,7 +220,7 @@ Flush interval in seconds for flushing writes to log files. 0 will flush on every message. [[plugins-outputs-google_bigquery-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -228,7 +239,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-google_bigquery-ignore_unknown_values]] -===== `ignore_unknown_values` +===== `ignore_unknown_values` * Value type is <> * Default value is `false` @@ -237,7 +248,7 @@ Indicates if BigQuery should allow extra values that are not represented in the If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. [[plugins-outputs-google_bigquery-json_schema]] -===== `json_schema` +===== `json_schema` * Value type is <> * Default value is `nil` @@ -257,7 +268,7 @@ json_schema => { } [[plugins-outputs-google_bigquery-key_password]] -===== `key_password` +===== `key_password` * Value type is <> * Default value is `"notasecret"` @@ -265,7 +276,7 @@ json_schema => { Private key password for service account private key. [[plugins-outputs-google_bigquery-key_path]] -===== `key_path` +===== `key_path` * This is a required setting. * Value type is <> @@ -274,7 +285,7 @@ Private key password for service account private key. Path to private key file for Google Service Account. [[plugins-outputs-google_bigquery-project_id]] -===== `project_id` +===== `project_id` * This is a required setting. * Value type is <> @@ -283,7 +294,7 @@ Path to private key file for Google Service Account. Google Cloud Project ID (number, not Project Name!). [[plugins-outputs-google_bigquery-service_account]] -===== `service_account` +===== `service_account` * This is a required setting. * Value type is <> @@ -292,7 +303,7 @@ Google Cloud Project ID (number, not Project Name!). Service account to access Google APIs. [[plugins-outputs-google_bigquery-table_prefix]] -===== `table_prefix` +===== `table_prefix` * Value type is <> * Default value is `"logstash"` @@ -301,7 +312,7 @@ BigQuery table ID prefix to be used when creating new tables for log data. Table name will be [[plugins-outputs-google_bigquery-table_separator]] -===== `table_separator` +===== `table_separator` * Value type is <> * Default value is `"_"` @@ -310,7 +321,7 @@ BigQuery table separator to be added between the table_prefix and the date suffix. [[plugins-outputs-google_bigquery-temp_directory]] -===== `temp_directory` +===== `temp_directory` * Value type is <> * Default value is `""` @@ -319,7 +330,7 @@ Directory where temporary files are stored. Defaults to /tmp/logstash-bq- [[plugins-outputs-google_bigquery-temp_file_prefix]] -===== `temp_file_prefix` +===== `temp_file_prefix` * Value type is <> * Default value is `"logstash_bq"` @@ -328,7 +339,7 @@ Temporary local file prefix. Log file will follow the format: _hostname_date.part?.log [[plugins-outputs-google_bigquery-uploader_interval_secs]] -===== `uploader_interval_secs` +===== `uploader_interval_secs` * Value type is <> * Default value is `60` @@ -338,13 +349,11 @@ on your time pattern (for example, for hourly files, this interval can be around one hour). [[plugins-outputs-google_bigquery-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/google_cloud_storage.asciidoc b/docs/plugins/outputs/google_cloud_storage.asciidoc index 6a84f3d7e..4847ba194 100644 --- a/docs/plugins/outputs/google_cloud_storage.asciidoc +++ b/docs/plugins/outputs/google_cloud_storage.asciidoc @@ -4,7 +4,8 @@ NOTE: This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running `bin/logstash-plugin install logstash-output-google_cloud_storage`. - +[source,txt] +----- Author: Rodrigo De Castro Date: 2013-09-20 @@ -21,6 +22,8 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. +----- + Summary: plugin to upload log events to Google Cloud Storage (GCS), rolling files based on the date pattern provided as a configuration setting. Events are written to files locally and, once file is closed, this plugin uploads @@ -41,6 +44,8 @@ uploading the log files and in terms of storage costs as well. USAGE: This is an example of logstash config: +[source,json] +-------------------------- output { google_cloud_storage { bucket => "my_bucket" (required) @@ -57,14 +62,16 @@ output { uploader_interval_secs => 60 (optional) } } +-------------------------- Improvements TODO list: -- Support logstash event variables to determine filename. -- Turn Google API code into a Plugin Mixin (like AwsConfig). -- There's no recover method, so if logstash/plugin crashes, files may not + +* Support logstash event variables to determine filename. +* Turn Google API code into a Plugin Mixin (like AwsConfig). +* There's no recover method, so if logstash/plugin crashes, files may not be uploaded to GCS. -- Allow user to configure file name. -- Allow parallel uploads for heavier loads (+ connection configuration if +* Allow user to configure file name. +* Allow parallel uploads for heavier loads (+ connection configuration if exposed by Ruby API client)   diff --git a/docs/plugins/outputs/graphite.asciidoc b/docs/plugins/outputs/graphite.asciidoc index 63871e689..601e61ddb 100644 --- a/docs/plugins/outputs/graphite.asciidoc +++ b/docs/plugins/outputs/graphite.asciidoc @@ -115,7 +115,7 @@ The hostname or IP address of the Graphite server. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -223,8 +223,4 @@ graphite since you probably have a cache layer infront of Logstash. * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - diff --git a/docs/plugins/outputs/graphtastic.asciidoc b/docs/plugins/outputs/graphtastic.asciidoc index 9fd2efe5b..eee466010 100644 --- a/docs/plugins/outputs/graphtastic.asciidoc +++ b/docs/plugins/outputs/graphtastic.asciidoc @@ -63,7 +63,7 @@ Available configuration options:   [[plugins-outputs-graphtastic-batch_number]] -===== `batch_number` +===== `batch_number` * Value type is <> * Default value is `60` @@ -72,7 +72,7 @@ the number of metrics to send to GraphTastic at one time. 60 seems to be the per amount for UDP, with default packet size. [[plugins-outputs-graphtastic-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -80,7 +80,7 @@ amount for UDP, with default packet size. The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-graphtastic-context]] -===== `context` +===== `context` * Value type is <> * Default value is `"graphtastic"` @@ -93,7 +93,7 @@ Please consult your application server documentation for more on application contexts. [[plugins-outputs-graphtastic-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -103,7 +103,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-graphtastic-error_file]] -===== `error_file` +===== `error_file` * Value type is <> * Default value is `""` @@ -114,7 +114,7 @@ on how we reintegrate these error metrics NOT IMPLEMENTED! [[plugins-outputs-graphtastic-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"127.0.0.1"` @@ -122,7 +122,7 @@ NOT IMPLEMENTED! host for the graphtastic server - defaults to 127.0.0.1 [[plugins-outputs-graphtastic-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -141,7 +141,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-graphtastic-integration]] -===== `integration` +===== `integration` * Value can be any of: `udp`, `tcp`, `rmi`, `rest` * Default value is `"udp"` @@ -149,7 +149,7 @@ If you don't explicitely set this variable Logstash will generate a unique name. options are udp(fastest - default) - rmi(faster) - rest(fast) - tcp(don't use TCP yet - some problems - errors out on linux) [[plugins-outputs-graphtastic-metrics]] -===== `metrics` +===== `metrics` * Value type is <> * Default value is `{}` @@ -168,7 +168,7 @@ metrics => [ "Response", "%{response}" ] NOTE: you can also use the dynamic fields for the key value as well as the actual value [[plugins-outputs-graphtastic-port]] -===== `port` +===== `port` * Value type is <> * There is no default value for this setting. @@ -176,7 +176,7 @@ NOTE: you can also use the dynamic fields for the key value as well as the actua port for the graphtastic instance - defaults to 1199 for RMI, 1299 for TCP, 1399 for UDP, and 8080 for REST [[plugins-outputs-graphtastic-retries]] -===== `retries` +===== `retries` * Value type is <> * Default value is `1` @@ -187,13 +187,11 @@ either by graphtastic utility or by this program after connectivity is ensured to be established. [[plugins-outputs-graphtastic-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/hipchat.asciidoc b/docs/plugins/outputs/hipchat.asciidoc index 7e36f3209..afb7b0bc7 100644 --- a/docs/plugins/outputs/hipchat.asciidoc +++ b/docs/plugins/outputs/hipchat.asciidoc @@ -58,7 +58,7 @@ Available configuration options:   [[plugins-outputs-hipchat-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -66,7 +66,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-hipchat-color]] -===== `color` +===== `color` * Value type is <> * Default value is `"yellow"` @@ -76,7 +76,7 @@ HipChat currently supports one of "yellow", "red", "green", "purple", "gray", or "random". (default: yellow), support fieldref [[plugins-outputs-hipchat-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -86,7 +86,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-hipchat-format]] -===== `format` +===== `format` * Value type is <> * Default value is `"%{message}"` @@ -94,7 +94,7 @@ for a specific plugin. Message format to send, event tokens are usable here. [[plugins-outputs-hipchat-from]] -===== `from` +===== `from` * Value type is <> * Default value is `"logstash"` @@ -102,7 +102,7 @@ Message format to send, event tokens are usable here. The name the message will appear be sent from, you can use fieldref [[plugins-outputs-hipchat-host]] -===== `host` +===== `host` * Value type is <> * There is no default value for this setting. @@ -110,7 +110,7 @@ The name the message will appear be sent from, you can use fieldref HipChat host to use [[plugins-outputs-hipchat-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -129,7 +129,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-hipchat-message_format]] -===== `message_format` +===== `message_format` * Value can be any of: `html`, `text` * Default value is `"html"` @@ -137,7 +137,7 @@ If you don't explicitely set this variable Logstash will generate a unique name. Specify `Message Format` [[plugins-outputs-hipchat-room_id]] -===== `room_id` +===== `room_id` * This is a required setting. * Value type is <> @@ -146,7 +146,7 @@ Specify `Message Format` The ID or name of the room, support fieldref [[plugins-outputs-hipchat-token]] -===== `token` +===== `token` * This is a required setting. * Value type is <> @@ -155,7 +155,7 @@ The ID or name of the room, support fieldref The HipChat authentication token. [[plugins-outputs-hipchat-trigger_notify]] -===== `trigger_notify` +===== `trigger_notify` * Value type is <> * Default value is `false` @@ -163,13 +163,11 @@ The HipChat authentication token. Whether or not this message should trigger a notification for people in the room. [[plugins-outputs-hipchat-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/http.asciidoc b/docs/plugins/outputs/http.asciidoc index 38a091ec5..a69a9b194 100644 --- a/docs/plugins/outputs/http.asciidoc +++ b/docs/plugins/outputs/http.asciidoc @@ -212,7 +212,7 @@ The HTTP Verb. One of "put", "post", "patch", "delete", "get", "head" * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -433,8 +433,3 @@ See https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/influxdb.asciidoc b/docs/plugins/outputs/influxdb.asciidoc index 50f9583a5..74c5ee582 100644 --- a/docs/plugins/outputs/influxdb.asciidoc +++ b/docs/plugins/outputs/influxdb.asciidoc @@ -73,7 +73,7 @@ Available configuration options:   [[plugins-outputs-influxdb-allow_time_override]] -===== `allow_time_override` +===== `allow_time_override` * Value type is <> * Default value is `false` @@ -88,7 +88,7 @@ Setting this to `true` allows you to explicitly set the `time` column yourself Note: **`time` must be an epoch value in either seconds, milliseconds or microseconds** [[plugins-outputs-influxdb-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -96,7 +96,7 @@ Note: **`time` must be an epoch value in either seconds, milliseconds or microse The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-influxdb-coerce_values]] -===== `coerce_values` +===== `coerce_values` * Value type is <> * Default value is `{}` @@ -111,7 +111,7 @@ currently supported datatypes are `integer` and `float` [[plugins-outputs-influxdb-data_points]] -===== `data_points` +===== `data_points` * This is a required setting. * Value type is <> @@ -124,7 +124,7 @@ Events for the same measurement will be batched together where possible Both keys and values support sprintf formatting [[plugins-outputs-influxdb-db]] -===== `db` +===== `db` * Value type is <> * Default value is `"statistics"` @@ -132,7 +132,7 @@ Both keys and values support sprintf formatting The database to write - supports sprintf formatting [[plugins-outputs-influxdb-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -142,22 +142,22 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-influxdb-exclude_fields]] -===== `exclude_fields` +===== `exclude_fields` * Value type is <> * Default value is `["@timestamp", "@version", "sequence", "message", "type"]` An array containing the names of fields from the event to exclude from the -data points +data points Events, in general, contain keys "@version" and "@timestamp". Other plugins -may add others that you'll want to exclude (such as "command" from the +may add others that you'll want to exclude (such as "command" from the exec plugin). This only applies when use_event_fields_for_data_points is true. [[plugins-outputs-influxdb-flush_size]] -===== `flush_size` +===== `flush_size` * Value type is <> * Default value is `100` @@ -166,7 +166,7 @@ This setting controls how many events will be buffered before sending a batch of events. Note that these are only batched for the same measurement [[plugins-outputs-influxdb-host]] -===== `host` +===== `host` * This is a required setting. * Value type is <> @@ -175,7 +175,7 @@ of events. Note that these are only batched for the same measurement The hostname or IP address to reach your InfluxDB instance [[plugins-outputs-influxdb-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -194,7 +194,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-influxdb-idle_flush_time]] -===== `idle_flush_time` +===== `idle_flush_time` * Value type is <> * Default value is `1` @@ -210,7 +210,7 @@ This helps keep both fast and slow log streams moving along in near-real-time. [[plugins-outputs-influxdb-measurement]] -===== `measurement` +===== `measurement` * Value type is <> * Default value is `"logstash"` @@ -218,7 +218,7 @@ near-real-time. Measurement name - supports sprintf formatting [[plugins-outputs-influxdb-password]] -===== `password` +===== `password` * Value type is <> * Default value is `nil` @@ -226,7 +226,7 @@ Measurement name - supports sprintf formatting The password for the user who access to the named database [[plugins-outputs-influxdb-port]] -===== `port` +===== `port` * Value type is <> * Default value is `8086` @@ -234,7 +234,7 @@ The password for the user who access to the named database The port for InfluxDB [[plugins-outputs-influxdb-retention_policy]] -===== `retention_policy` +===== `retention_policy` * Value type is <> * Default value is `"default"` @@ -242,17 +242,17 @@ The port for InfluxDB The retention policy to use [[plugins-outputs-influxdb-send_as_tags]] -===== `send_as_tags` +===== `send_as_tags` * Value type is <> * Default value is `["host"]` -An array containing the names of fields to send to Influxdb as tags instead +An array containing the names of fields to send to Influxdb as tags instead of fields. Influxdb 0.9 convention is that values that do not change every request should be considered metadata and given as tags. [[plugins-outputs-influxdb-ssl]] -===== `ssl` +===== `ssl` * Value type is <> * Default value is `false` @@ -260,7 +260,7 @@ request should be considered metadata and given as tags. Enable SSL/TLS secured communication to InfluxDB [[plugins-outputs-influxdb-time_precision]] -===== `time_precision` +===== `time_precision` * Value can be any of: `n`, `u`, `ms`, `s`, `m`, `h` * Default value is `"ms"` @@ -270,7 +270,7 @@ Set the level of precision of `time` only useful when overriding the time value [[plugins-outputs-influxdb-use_event_fields_for_data_points]] -===== `use_event_fields_for_data_points` +===== `use_event_fields_for_data_points` * Value type is <> * Default value is `false` @@ -278,7 +278,7 @@ only useful when overriding the time value Automatically use fields from the event as the data points sent to Influxdb [[plugins-outputs-influxdb-user]] -===== `user` +===== `user` * Value type is <> * Default value is `nil` @@ -286,13 +286,11 @@ Automatically use fields from the event as the data points sent to Influxdb The user who has access to the named database [[plugins-outputs-influxdb-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/irc.asciidoc b/docs/plugins/outputs/irc.asciidoc index 5366d4f54..81f0f32fc 100644 --- a/docs/plugins/outputs/irc.asciidoc +++ b/docs/plugins/outputs/irc.asciidoc @@ -117,7 +117,7 @@ Address of the host to connect to * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -209,8 +209,4 @@ IRC Username * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - diff --git a/docs/plugins/outputs/jira.asciidoc b/docs/plugins/outputs/jira.asciidoc index 5a34d51c1..336f8ffc3 100644 --- a/docs/plugins/outputs/jira.asciidoc +++ b/docs/plugins/outputs/jira.asciidoc @@ -8,11 +8,13 @@ NOTE: This is a community-maintained plugin! It does not ship with Logstash by d Origin https://groups.google.com/forum/#!msg/logstash-users/exgrB4iQ-mw/R34apku5nXsJ and https://botbot.me/freenode/logstash/msg/4169496/ via https://gist.github.com/electrical/4660061e8fff11cdcf37#file-jira-rb + Uses jiralicious as the bridge to JIRA + By Martin Cleaver, Blended Perspectives with a lot of help from 'electrical' in #logstash -This is so is most useful so you can use logstash to parse and structure +This is most useful so you can use logstash to parse and structure your logs and ship structured, json events to JIRA To use this, you'll need to ensure your JIRA instance allows REST calls diff --git a/docs/plugins/outputs/juggernaut.asciidoc b/docs/plugins/outputs/juggernaut.asciidoc index 70086850e..79379f99a 100644 --- a/docs/plugins/outputs/juggernaut.asciidoc +++ b/docs/plugins/outputs/juggernaut.asciidoc @@ -60,7 +60,7 @@ Available configuration options:   [[plugins-outputs-juggernaut-channels]] -===== `channels` +===== `channels` * This is a required setting. * Value type is <> @@ -70,7 +70,7 @@ List of channels to which to publish. Dynamic names are valid here, for example `logstash-%{type}`. [[plugins-outputs-juggernaut-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -78,7 +78,7 @@ valid here, for example `logstash-%{type}`. The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-juggernaut-db]] -===== `db` +===== `db` * Value type is <> * Default value is `0` @@ -86,7 +86,7 @@ The codec used for output data. Output codecs are a convenient method for encodi The redis database number. [[plugins-outputs-juggernaut-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -96,7 +96,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-juggernaut-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"127.0.0.1"` @@ -104,7 +104,7 @@ for a specific plugin. The hostname of the redis server to which juggernaut is listening. [[plugins-outputs-juggernaut-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -123,7 +123,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-juggernaut-message_format]] -===== `message_format` +===== `message_format` * Value type is <> * There is no default value for this setting. @@ -131,7 +131,7 @@ If you don't explicitely set this variable Logstash will generate a unique name. How should the message be formatted before pushing to the websocket. [[plugins-outputs-juggernaut-password]] -===== `password` +===== `password` * Value type is <> * There is no default value for this setting. @@ -139,7 +139,7 @@ How should the message be formatted before pushing to the websocket. Password to authenticate with. There is no authentication by default. [[plugins-outputs-juggernaut-port]] -===== `port` +===== `port` * Value type is <> * Default value is `6379` @@ -147,7 +147,7 @@ Password to authenticate with. There is no authentication by default. The port to connect on. [[plugins-outputs-juggernaut-timeout]] -===== `timeout` +===== `timeout` * Value type is <> * Default value is `5` @@ -155,13 +155,11 @@ The port to connect on. Redis initial connection timeout in seconds. [[plugins-outputs-juggernaut-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/kafka.asciidoc b/docs/plugins/outputs/kafka.asciidoc index 8af9f13d1..e72440c90 100644 --- a/docs/plugins/outputs/kafka.asciidoc +++ b/docs/plugins/outputs/kafka.asciidoc @@ -222,7 +222,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -501,8 +501,4 @@ Serializer class for the value of the message * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - diff --git a/docs/plugins/outputs/librato.asciidoc b/docs/plugins/outputs/librato.asciidoc index 9220c844f..e5969fae2 100644 --- a/docs/plugins/outputs/librato.asciidoc +++ b/docs/plugins/outputs/librato.asciidoc @@ -53,7 +53,7 @@ Available configuration options:   [[plugins-outputs-librato-account_id]] -===== `account_id` +===== `account_id` * This is a required setting. * Value type is <> @@ -67,7 +67,7 @@ Your Librato account usually an email address [[plugins-outputs-librato-annotation]] -===== `annotation` +===== `annotation` * Value type is <> * Default value is `{}` @@ -94,7 +94,7 @@ or } [[plugins-outputs-librato-api_token]] -===== `api_token` +===== `api_token` * This is a required setting. * Value type is <> @@ -103,7 +103,7 @@ or Your Librato API Token [[plugins-outputs-librato-batch_size]] -===== `batch_size` +===== `batch_size` * Value type is <> * Default value is `"10"` @@ -113,7 +113,7 @@ Number of events to batch up before sending to Librato. [[plugins-outputs-librato-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -121,7 +121,7 @@ Number of events to batch up before sending to Librato. The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-librato-counter]] -===== `counter` +===== `counter` * Value type is <> * Default value is `{}` @@ -136,7 +136,7 @@ Example: "source" => "%{host}" "name" => "messages_received" } - + Additionally, you can override the `measure_time` for the event. Must be a unix timestamp: [source,ruby] { @@ -148,7 +148,7 @@ Additionally, you can override the `measure_time` for the event. Must be a unix Default is to use the event's timestamp [[plugins-outputs-librato-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -158,7 +158,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-librato-gauge]] -===== `gauge` +===== `gauge` * Value type is <> * Default value is `{}` @@ -184,7 +184,7 @@ Additionally, you can override the `measure_time` for the event. Must be a unix Default is to use the event's timestamp [[plugins-outputs-librato-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -203,13 +203,11 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-librato-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/loggly.asciidoc b/docs/plugins/outputs/loggly.asciidoc index 191cc41dc..395e321be 100644 --- a/docs/plugins/outputs/loggly.asciidoc +++ b/docs/plugins/outputs/loggly.asciidoc @@ -9,9 +9,7 @@ NOTE: This plugin does not ship with Logstash by default, but it is easy to install by running `bin/logstash-plugin install logstash-output-loggly`. - -TODO(sissel): Move to something that performs better than net/http -Ugly monkey patch to get around http://jira.codehaus.org/browse/JRUBY-5529 +Ships logs to Loggly.   @@ -57,7 +55,7 @@ Available configuration options:   [[plugins-outputs-loggly-can_retry]] -===== `can_retry` +===== `can_retry` * Value type is <> * Default value is `true` @@ -66,7 +64,7 @@ Can Retry. Setting this value true helps user to send multiple retry attempts if the first request fails [[plugins-outputs-loggly-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -74,7 +72,7 @@ Setting this value true helps user to send multiple retry attempts if the first The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-loggly-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -84,7 +82,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-loggly-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"logs-01.loggly.com"` @@ -95,7 +93,7 @@ See Loggly HTTP endpoint documentation at https://www.loggly.com/docs/http-endpoint/ [[plugins-outputs-loggly-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -114,7 +112,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-loggly-key]] -===== `key` +===== `key` * This is a required setting. * Value type is <> @@ -132,7 +130,7 @@ the event. This is mainly aimed at multitenant hosting providers who want to offer shipping a customer's logs to that customer's loggly account. [[plugins-outputs-loggly-proto]] -===== `proto` +===== `proto` * Value type is <> * Default value is `"http"` @@ -140,7 +138,7 @@ to offer shipping a customer's logs to that customer's loggly account. Should the log action be sent over https instead of plain http [[plugins-outputs-loggly-proxy_host]] -===== `proxy_host` +===== `proxy_host` * Value type is <> * There is no default value for this setting. @@ -148,7 +146,7 @@ Should the log action be sent over https instead of plain http Proxy Host [[plugins-outputs-loggly-proxy_password]] -===== `proxy_password` +===== `proxy_password` * Value type is <> * Default value is `""` @@ -156,7 +154,7 @@ Proxy Host Proxy Password [[plugins-outputs-loggly-proxy_port]] -===== `proxy_port` +===== `proxy_port` * Value type is <> * There is no default value for this setting. @@ -164,7 +162,7 @@ Proxy Password Proxy Port [[plugins-outputs-loggly-proxy_user]] -===== `proxy_user` +===== `proxy_user` * Value type is <> * There is no default value for this setting. @@ -172,18 +170,18 @@ Proxy Port Proxy Username [[plugins-outputs-loggly-retry_count]] -===== `retry_count` +===== `retry_count` * Value type is <> * Default value is `5` -Retry count. +Retry count. It may be possible that the request may timeout due to slow Internet connection if such condition appears, retry_count helps in retrying request for multiple times It will try to submit request until retry_count and then halt [[plugins-outputs-loggly-tag]] -===== `tag` +===== `tag` * Value type is <> * Default value is `"logstash"` @@ -198,13 +196,11 @@ Helpful for leveraging Loggly source groups. https://www.loggly.com/docs/source-groups/ [[plugins-outputs-loggly-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/lumberjack.asciidoc b/docs/plugins/outputs/lumberjack.asciidoc index a164c23ba..75f8466f3 100644 --- a/docs/plugins/outputs/lumberjack.asciidoc +++ b/docs/plugins/outputs/lumberjack.asciidoc @@ -53,7 +53,7 @@ Available configuration options:   [[plugins-outputs-lumberjack-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -61,7 +61,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-lumberjack-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -71,7 +71,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-lumberjack-flush_size]] -===== `flush_size` +===== `flush_size` * Value type is <> * Default value is `1024` @@ -81,7 +81,7 @@ if the number of events exceed the number the declared `flush_size` we will send them to the logstash server. [[plugins-outputs-lumberjack-hosts]] -===== `hosts` +===== `hosts` * This is a required setting. * Value type is <> @@ -90,7 +90,7 @@ send them to the logstash server. list of addresses lumberjack can send to [[plugins-outputs-lumberjack-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -109,7 +109,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-lumberjack-idle_flush_time]] -===== `idle_flush_time` +===== `idle_flush_time` * Value type is <> * Default value is `1` @@ -125,7 +125,7 @@ This helps keep both fast and slow log streams moving along in near-real-time. [[plugins-outputs-lumberjack-port]] -===== `port` +===== `port` * This is a required setting. * Value type is <> @@ -134,7 +134,7 @@ near-real-time. the port to connect to [[plugins-outputs-lumberjack-ssl_certificate]] -===== `ssl_certificate` +===== `ssl_certificate` * This is a required setting. * Value type is <> @@ -143,13 +143,11 @@ the port to connect to ssl certificate to use [[plugins-outputs-lumberjack-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/metriccatcher.asciidoc b/docs/plugins/outputs/metriccatcher.asciidoc index 118fa0329..9b4ec2184 100644 --- a/docs/plugins/outputs/metriccatcher.asciidoc +++ b/docs/plugins/outputs/metriccatcher.asciidoc @@ -68,7 +68,7 @@ Available configuration options:   [[plugins-outputs-metriccatcher-biased]] -===== `biased` +===== `biased` * Value type is <> * There is no default value for this setting. @@ -81,7 +81,7 @@ The value will be coerced to a floating point value. Values which cannot be coerced will zero (0) [[plugins-outputs-metriccatcher-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -89,7 +89,7 @@ coerced will zero (0) The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-metriccatcher-counter]] -===== `counter` +===== `counter` * Value type is <> * There is no default value for this setting. @@ -104,7 +104,7 @@ The value will be coerced to a floating point value. Values which cannot be coerced will zero (0) [[plugins-outputs-metriccatcher-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -114,7 +114,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-metriccatcher-gauge]] -===== `gauge` +===== `gauge` * Value type is <> * There is no default value for this setting. @@ -127,7 +127,7 @@ The value will be coerced to a floating point value. Values which cannot be coerced will zero (0) [[plugins-outputs-metriccatcher-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"localhost"` @@ -135,7 +135,7 @@ coerced will zero (0) The address of the MetricCatcher [[plugins-outputs-metriccatcher-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -154,7 +154,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-metriccatcher-meter]] -===== `meter` +===== `meter` * Value type is <> * There is no default value for this setting. @@ -167,7 +167,7 @@ The value will be coerced to a floating point value. Values which cannot be coerced will zero (0) [[plugins-outputs-metriccatcher-port]] -===== `port` +===== `port` * Value type is <> * Default value is `1420` @@ -175,7 +175,7 @@ coerced will zero (0) The port to connect on your MetricCatcher [[plugins-outputs-metriccatcher-timer]] -===== `timer` +===== `timer` * Value type is <> * There is no default value for this setting. @@ -190,7 +190,7 @@ The value will be coerced to a floating point value. Values which cannot be coerced will zero (0) [[plugins-outputs-metriccatcher-uniform]] -===== `uniform` +===== `uniform` * Value type is <> * There is no default value for this setting. @@ -203,13 +203,11 @@ The value will be coerced to a floating point value. Values which cannot be coerced will zero (0) [[plugins-outputs-metriccatcher-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/mongodb.asciidoc b/docs/plugins/outputs/mongodb.asciidoc index af6cbf604..912e8cd51 100644 --- a/docs/plugins/outputs/mongodb.asciidoc +++ b/docs/plugins/outputs/mongodb.asciidoc @@ -9,8 +9,7 @@ NOTE: This plugin does not ship with Logstash by default, but it is easy to install by running `bin/logstash-plugin install logstash-output-mongodb`. - -require_relative "bson/logstash_event" +Writes events to MongoDB.   @@ -54,7 +53,7 @@ Available configuration options:   [[plugins-outputs-mongodb-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -62,7 +61,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-mongodb-collection]] -===== `collection` +===== `collection` * This is a required setting. * Value type is <> @@ -72,7 +71,7 @@ The collection to use. This value can use `%{foo}` values to dynamically select a collection based on data in the event. [[plugins-outputs-mongodb-database]] -===== `database` +===== `database` * This is a required setting. * Value type is <> @@ -81,7 +80,7 @@ select a collection based on data in the event. The database to use [[plugins-outputs-mongodb-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -91,7 +90,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-mongodb-generateId]] -===== `generateId` +===== `generateId` * Value type is <> * Default value is `false` @@ -101,7 +100,7 @@ The "_id" field will use the timestamp of the event and overwrite an existing "_id" field in the event. [[plugins-outputs-mongodb-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -120,7 +119,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-mongodb-isodate]] -===== `isodate` +===== `isodate` * Value type is <> * Default value is `false` @@ -130,7 +129,7 @@ of an ISO8601 string. For more information about this, see http://www.mongodb.org/display/DOCS/Dates [[plugins-outputs-mongodb-retry_delay]] -===== `retry_delay` +===== `retry_delay` * Value type is <> * Default value is `3` @@ -138,7 +137,7 @@ http://www.mongodb.org/display/DOCS/Dates Number of seconds to wait after failure before retrying [[plugins-outputs-mongodb-uri]] -===== `uri` +===== `uri` * This is a required setting. * Value type is <> @@ -148,13 +147,11 @@ a MongoDB URI to connect to See http://docs.mongodb.org/manual/reference/connection-string/ [[plugins-outputs-mongodb-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/nagios.asciidoc b/docs/plugins/outputs/nagios.asciidoc index 0275f5920..27565095d 100644 --- a/docs/plugins/outputs/nagios.asciidoc +++ b/docs/plugins/outputs/nagios.asciidoc @@ -111,7 +111,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -140,8 +140,3 @@ The Nagios check level. Should be one of 0=OK, 1=WARNING, 2=CRITICAL, * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/nagios_nsca.asciidoc b/docs/plugins/outputs/nagios_nsca.asciidoc index d810c26d5..51457b2b0 100644 --- a/docs/plugins/outputs/nagios_nsca.asciidoc +++ b/docs/plugins/outputs/nagios_nsca.asciidoc @@ -72,7 +72,7 @@ Available configuration options:   [[plugins-outputs-nagios_nsca-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -80,7 +80,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-nagios_nsca-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -90,7 +90,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-nagios_nsca-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"localhost"` @@ -98,7 +98,7 @@ for a specific plugin. The nagios host or IP to send logs to. It should have a NSCA daemon running. [[plugins-outputs-nagios_nsca-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -117,7 +117,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-nagios_nsca-message_format]] -===== `message_format` +===== `message_format` * Value type is <> * Default value is `"%{@timestamp} %{host}: %{message}"` @@ -127,7 +127,7 @@ supports any string and can include `%{name}` and other dynamic strings. [[plugins-outputs-nagios_nsca-nagios_host]] -===== `nagios_host` +===== `nagios_host` * Value type is <> * Default value is `"%{host}"` @@ -137,7 +137,7 @@ parameter accepts interpolation, e.g. you can use `@source_host` or other logstash internal variables. [[plugins-outputs-nagios_nsca-nagios_service]] -===== `nagios_service` +===== `nagios_service` * Value type is <> * Default value is `"LOGSTASH"` @@ -147,7 +147,7 @@ parameter accepts interpolation, e.g. you can use `@source_host` or other logstash internal variables. [[plugins-outputs-nagios_nsca-nagios_status]] -===== `nagios_status` +===== `nagios_status` * This is a required setting. * Value type is <> @@ -156,7 +156,7 @@ logstash internal variables. The status to send to nagios. Should be 0 = OK, 1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN [[plugins-outputs-nagios_nsca-port]] -===== `port` +===== `port` * Value type is <> * Default value is `5667` @@ -164,7 +164,7 @@ The status to send to nagios. Should be 0 = OK, 1 = WARNING, 2 = CRITICAL, 3 = U The port where the NSCA daemon on the nagios host listens. [[plugins-outputs-nagios_nsca-send_nsca_bin]] -===== `send_nsca_bin` +===== `send_nsca_bin` * Value type is <> * Default value is `"/usr/sbin/send_nsca"` @@ -172,7 +172,7 @@ The port where the NSCA daemon on the nagios host listens. The path to the 'send_nsca' binary on the local host. [[plugins-outputs-nagios_nsca-send_nsca_config]] -===== `send_nsca_config` +===== `send_nsca_config` * Value type is <> * There is no default value for this setting. @@ -181,13 +181,11 @@ The path to the send_nsca config file on the local host. Leave blank if you don't want to provide a config file. [[plugins-outputs-nagios_nsca-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/newrelic.asciidoc b/docs/plugins/outputs/newrelic.asciidoc index d81b553da..4f916e7e2 100644 --- a/docs/plugins/outputs/newrelic.asciidoc +++ b/docs/plugins/outputs/newrelic.asciidoc @@ -55,17 +55,17 @@ Available configuration options:   [[plugins-outputs-newrelic-account_id]] -===== `account_id` +===== `account_id` * This is a required setting. * Value type is <> * There is no default value for this setting. Your New Relic account ID. This is the 5 or 6-digit number found in the URL when you are logged into New Relic: -https://rpm.newrelic.com/accounts/[account_id]/... +https://rpm.newrelic.com/accounts/[account_id]/... [[plugins-outputs-newrelic-batch]] -===== `batch` +===== `batch` * Value type is <> * Default value is `true` @@ -75,7 +75,7 @@ This plugin uses the New Relic Insights REST API to send data. To make efficient REST API calls, we will buffer a certain number of events before flushing that out to Insights. [[plugins-outputs-newrelic-batch_events]] -===== `batch_events` +===== `batch_events` * Value type is <> * Default value is `10` @@ -83,16 +83,16 @@ To make efficient REST API calls, we will buffer a certain number of events befo This setting controls how many events will be buffered before sending a batch of events. [[plugins-outputs-newrelic-batch_timeout]] -===== `batch_timeout` +===== `batch_timeout` * Value type is <> * Default value is `5` -This setting controls how long the output will wait before sending a batch of a events, +This setting controls how long the output will wait before sending a batch of a events, should the minimum specified in batch_events not be met yet. [[plugins-outputs-newrelic-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -100,7 +100,7 @@ should the minimum specified in batch_events not be met yet. The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-newrelic-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -110,7 +110,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-newrelic-event_type]] -===== `event_type` +===== `event_type` * Value type is <> * Default value is `"LogstashEvent"` @@ -119,7 +119,7 @@ The name for your event type. Use alphanumeric characters only. If left out, your events will be stored under "logstashEvent". [[plugins-outputs-newrelic-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -138,7 +138,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-newrelic-insert_key]] -===== `insert_key` +===== `insert_key` * This is a required setting. * Value type is <> @@ -148,7 +148,7 @@ Your Insights Insert Key. You will need to generate one if you haven't already, https://docs.newrelic.com/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-insights-api#register [[plugins-outputs-newrelic-proto]] -===== `proto` +===== `proto` * Value type is <> * Default value is `"https"` @@ -156,7 +156,7 @@ https://docs.newrelic.com/docs/insights/new-relic-insights/adding-querying-data/ Should the log events be sent to Insights over https instead of plain http (typically yes). [[plugins-outputs-newrelic-proxy_host]] -===== `proxy_host` +===== `proxy_host` * Value type is <> * There is no default value for this setting. @@ -165,7 +165,7 @@ Proxy info - all optional If using a proxy, only proxy_host is required. [[plugins-outputs-newrelic-proxy_password]] -===== `proxy_password` +===== `proxy_password` * Value type is <> * Default value is `""` @@ -173,7 +173,7 @@ If using a proxy, only proxy_host is required. Proxy_password should be left out if connecting to your proxy unauthenticated. [[plugins-outputs-newrelic-proxy_port]] -===== `proxy_port` +===== `proxy_port` * Value type is <> * Default value is `80` @@ -181,7 +181,7 @@ Proxy_password should be left out if connecting to your proxy unauthenticated. Proxy_port will default to port 80 if left out. [[plugins-outputs-newrelic-proxy_user]] -===== `proxy_user` +===== `proxy_user` * Value type is <> * There is no default value for this setting. @@ -189,13 +189,11 @@ Proxy_port will default to port 80 if left out. Proxy_user should be left out if connecting to your proxy unauthenticated. [[plugins-outputs-newrelic-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/null.asciidoc b/docs/plugins/outputs/null.asciidoc index 94d774932..723b86e78 100644 --- a/docs/plugins/outputs/null.asciidoc +++ b/docs/plugins/outputs/null.asciidoc @@ -74,7 +74,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -94,8 +94,3 @@ output { * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/opentsdb.asciidoc b/docs/plugins/outputs/opentsdb.asciidoc index 22632ba22..140da0ae1 100644 --- a/docs/plugins/outputs/opentsdb.asciidoc +++ b/docs/plugins/outputs/opentsdb.asciidoc @@ -51,7 +51,7 @@ Available configuration options:   [[plugins-outputs-opentsdb-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -59,7 +59,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-opentsdb-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -69,7 +69,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-opentsdb-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"localhost"` @@ -77,7 +77,7 @@ for a specific plugin. The address of the opentsdb server. [[plugins-outputs-opentsdb-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -96,7 +96,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-opentsdb-metrics]] -===== `metrics` +===== `metrics` * This is a required setting. * Value type is <> @@ -119,7 +119,7 @@ The value will be coerced to a floating point value. Values which cannot be coerced will zero (0) [[plugins-outputs-opentsdb-port]] -===== `port` +===== `port` * Value type is <> * Default value is `4242` @@ -127,13 +127,11 @@ coerced will zero (0) The port to connect on your graphite server. [[plugins-outputs-opentsdb-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/pagerduty.asciidoc b/docs/plugins/outputs/pagerduty.asciidoc index de646b6a6..f27c952fb 100644 --- a/docs/plugins/outputs/pagerduty.asciidoc +++ b/docs/plugins/outputs/pagerduty.asciidoc @@ -110,7 +110,7 @@ Event type * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -156,8 +156,4 @@ The PagerDuty Service API Key * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - diff --git a/docs/plugins/outputs/pipe.asciidoc b/docs/plugins/outputs/pipe.asciidoc index 7ae47c4bf..bb6c19a24 100644 --- a/docs/plugins/outputs/pipe.asciidoc +++ b/docs/plugins/outputs/pipe.asciidoc @@ -90,7 +90,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -131,8 +131,4 @@ Close pipe that hasn't been used for TTL seconds. -1 or 0 means never close. * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - diff --git a/docs/plugins/outputs/rabbitmq.asciidoc b/docs/plugins/outputs/rabbitmq.asciidoc index 4f16e141d..b7f5af767 100644 --- a/docs/plugins/outputs/rabbitmq.asciidoc +++ b/docs/plugins/outputs/rabbitmq.asciidoc @@ -197,7 +197,7 @@ Note that only one host connection is active at a time. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -332,8 +332,3 @@ slash. * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/redis.asciidoc b/docs/plugins/outputs/redis.asciidoc index 84292f8d5..d1a99429d 100644 --- a/docs/plugins/outputs/redis.asciidoc +++ b/docs/plugins/outputs/redis.asciidoc @@ -183,7 +183,7 @@ For example: * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -271,8 +271,3 @@ Redis initial connection timeout in seconds. * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/redmine.asciidoc b/docs/plugins/outputs/redmine.asciidoc index 8b491a02e..53f3ac8c4 100644 --- a/docs/plugins/outputs/redmine.asciidoc +++ b/docs/plugins/outputs/redmine.asciidoc @@ -81,7 +81,7 @@ Available configuration options:   [[plugins-outputs-redmine-assigned_to_id]] -===== `assigned_to_id` +===== `assigned_to_id` * Value type is <> * Default value is `nil` @@ -90,7 +90,7 @@ redmine issue assigned_to not required for post_issue [[plugins-outputs-redmine-categorie_id]] -===== `categorie_id` +===== `categorie_id` * Value type is <> * Default value is `nil` @@ -98,7 +98,7 @@ not required for post_issue not required for post_issue [[plugins-outputs-redmine-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -106,7 +106,7 @@ not required for post_issue The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-redmine-description]] -===== `description` +===== `description` * Value type is <> * Default value is `"%{message}"` @@ -115,7 +115,7 @@ redmine issue description required [[plugins-outputs-redmine-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -125,7 +125,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-redmine-fixed_version_id]] -===== `fixed_version_id` +===== `fixed_version_id` * Value type is <> * Default value is `nil` @@ -133,7 +133,7 @@ for a specific plugin. redmine issue fixed_version_id [[plugins-outputs-redmine-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -152,7 +152,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-redmine-parent_issue_id]] -===== `parent_issue_id` +===== `parent_issue_id` * Value type is <> * Default value is `nil` @@ -161,7 +161,7 @@ redmine issue parent_issue_id not required for post_issue [[plugins-outputs-redmine-priority_id]] -===== `priority_id` +===== `priority_id` * This is a required setting. * Value type is <> @@ -171,7 +171,7 @@ redmine issue priority_id required [[plugins-outputs-redmine-project_id]] -===== `project_id` +===== `project_id` * This is a required setting. * Value type is <> @@ -181,7 +181,7 @@ redmine issue projet_id required [[plugins-outputs-redmine-ssl]] -===== `ssl` +===== `ssl` * Value type is <> * Default value is `false` @@ -189,7 +189,7 @@ required [[plugins-outputs-redmine-status_id]] -===== `status_id` +===== `status_id` * This is a required setting. * Value type is <> @@ -199,7 +199,7 @@ redmine issue status_id required [[plugins-outputs-redmine-subject]] -===== `subject` +===== `subject` * Value type is <> * Default value is `"%{host}"` @@ -208,7 +208,7 @@ redmine issue subject required [[plugins-outputs-redmine-token]] -===== `token` +===== `token` * This is a required setting. * Value type is <> @@ -217,7 +217,7 @@ required redmine token user used for authentication [[plugins-outputs-redmine-tracker_id]] -===== `tracker_id` +===== `tracker_id` * This is a required setting. * Value type is <> @@ -227,7 +227,7 @@ redmine issue tracker_id required [[plugins-outputs-redmine-url]] -===== `url` +===== `url` * This is a required setting. * Value type is <> @@ -237,13 +237,11 @@ host of redmine app value format : 'http://urlofredmine.tld' - Not add '/issues' at end [[plugins-outputs-redmine-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/riak.asciidoc b/docs/plugins/outputs/riak.asciidoc index ddc6e7010..210fff395 100644 --- a/docs/plugins/outputs/riak.asciidoc +++ b/docs/plugins/outputs/riak.asciidoc @@ -55,20 +55,20 @@ Available configuration options:   [[plugins-outputs-riak-bucket]] -===== `bucket` +===== `bucket` * Value type is <> * Default value is `["logstash-%{+YYYY.MM.dd}"]` The bucket name to write events to -Expansion is supported here as values are +Expansion is supported here as values are passed through event.sprintf Multiple buckets can be specified here but any bucket-specific settings defined apply to ALL the buckets. [[plugins-outputs-riak-bucket_props]] -===== `bucket_props` +===== `bucket_props` * Value type is <> * There is no default value for this setting. @@ -88,7 +88,7 @@ or Properties will be passed as-is [[plugins-outputs-riak-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -96,7 +96,7 @@ Properties will be passed as-is The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-riak-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -106,7 +106,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-riak-enable_search]] -===== `enable_search` +===== `enable_search` * Value type is <> * Default value is `false` @@ -115,7 +115,7 @@ Search Enable search on the bucket defined above [[plugins-outputs-riak-enable_ssl]] -===== `enable_ssl` +===== `enable_ssl` * Value type is <> * Default value is `false` @@ -124,7 +124,7 @@ SSL Enable SSL [[plugins-outputs-riak-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -143,7 +143,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-riak-indices]] -===== `indices` +===== `indices` * Value type is <> * There is no default value for this setting. @@ -156,7 +156,7 @@ e.g. Off by default as not everyone runs eleveldb [[plugins-outputs-riak-key_name]] -===== `key_name` +===== `key_name` * Value type is <> * There is no default value for this setting. @@ -167,7 +167,7 @@ variables are valid here. Choose this carefully. Best to let riak decide. [[plugins-outputs-riak-nodes]] -===== `nodes` +===== `nodes` * Value type is <> * Default value is `{"localhost"=>"8098"}` @@ -183,7 +183,7 @@ e.g } [[plugins-outputs-riak-proto]] -===== `proto` +===== `proto` * Value can be any of: `http`, `pb` * Default value is `"http"` @@ -194,7 +194,7 @@ Applies to ALL backends listed above No mix and match [[plugins-outputs-riak-ssl_opts]] -===== `ssl_opts` +===== `ssl_opts` * Value type is <> * There is no default value for this setting. @@ -216,13 +216,11 @@ Per the riak client docs, the above sample options will turn on SSL `VERIFY_PEER` [[plugins-outputs-riak-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/riemann.asciidoc b/docs/plugins/outputs/riemann.asciidoc index 3436e8484..90cc937b1 100644 --- a/docs/plugins/outputs/riemann.asciidoc +++ b/docs/plugins/outputs/riemann.asciidoc @@ -65,7 +65,7 @@ Available configuration options:   [[plugins-outputs-riemann-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -73,7 +73,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-riemann-debug]] -===== `debug` +===== `debug` * Value type is <> * Default value is `false` @@ -82,7 +82,7 @@ The codec used for output data. Output codecs are a convenient method for encodi Enable debugging output? [[plugins-outputs-riemann-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -92,7 +92,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-riemann-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"localhost"` @@ -100,7 +100,7 @@ for a specific plugin. The address of the Riemann server. [[plugins-outputs-riemann-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -119,7 +119,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-riemann-map_fields]] -===== `map_fields` +===== `map_fields` * Value type is <> * Default value is `false` @@ -153,7 +153,7 @@ When used with the riemann_event any duplicate keys receive their value from riemann_event instead of the logstash event itself. [[plugins-outputs-riemann-port]] -===== `port` +===== `port` * Value type is <> * Default value is `5555` @@ -161,7 +161,7 @@ riemann_event instead of the logstash event itself. The port to connect to on your Riemann server. [[plugins-outputs-riemann-protocol]] -===== `protocol` +===== `protocol` * Value can be any of: `tcp`, `udp` * Default value is `"tcp"` @@ -175,7 +175,7 @@ is to never lose events As such, we use tcp as default here [[plugins-outputs-riemann-riemann_event]] -===== `riemann_event` +===== `riemann_event` * Value type is <> * There is no default value for this setting. @@ -207,7 +207,7 @@ Values which cannot be coerced will zero (0.0). but can be overridden here. [[plugins-outputs-riemann-sender]] -===== `sender` +===== `sender` * Value type is <> * Default value is `"%{host}"` @@ -217,13 +217,11 @@ This sets the `host` value in the Riemann event [[plugins-outputs-riemann-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/s3.asciidoc b/docs/plugins/outputs/s3.asciidoc index e19cdbc27..3cd957b7f 100644 --- a/docs/plugins/outputs/s3.asciidoc +++ b/docs/plugins/outputs/s3.asciidoc @@ -201,7 +201,7 @@ Specify the content encoding. Supports ("gzip"). Defaults to "none" * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -347,7 +347,7 @@ Will generate this file: ===== `temporary_directory` * Value type is <> - * Default value is `"/var/folders/_9/x4bq65rs6vd0rrjthct3zxjw0000gn/T/logstash"` + * Default value is `"/var/folders/s9/fp9p03r525d_cgclm9ps2n6r0000gn/T/logstash"` Set the directory where logstash will store the tmp files before sending it to S3 default to the current OS temporary directory in linux /tmp/logstash @@ -394,8 +394,3 @@ In some circonstances you need finer grained permission on subfolder, this allow * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/sns.asciidoc b/docs/plugins/outputs/sns.asciidoc index 0a7110763..86350c38e 100644 --- a/docs/plugins/outputs/sns.asciidoc +++ b/docs/plugins/outputs/sns.asciidoc @@ -147,7 +147,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -212,8 +212,3 @@ The AWS Session token for temporary credential * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/solr_http.asciidoc b/docs/plugins/outputs/solr_http.asciidoc index 17461649e..a16285047 100644 --- a/docs/plugins/outputs/solr_http.asciidoc +++ b/docs/plugins/outputs/solr_http.asciidoc @@ -60,7 +60,7 @@ Available configuration options:   [[plugins-outputs-solr_http-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -68,7 +68,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-solr_http-document_id]] -===== `document_id` +===== `document_id` * Value type is <> * Default value is `nil` @@ -77,7 +77,7 @@ Solr document ID for events. You'd typically have a variable here, like '%{foo}' so you can assign your own IDs [[plugins-outputs-solr_http-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -87,7 +87,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-solr_http-flush_size]] -===== `flush_size` +===== `flush_size` * Value type is <> * Default value is `100` @@ -95,7 +95,7 @@ for a specific plugin. Number of events to queue up before writing to Solr [[plugins-outputs-solr_http-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -114,7 +114,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-solr_http-idle_flush_time]] -===== `idle_flush_time` +===== `idle_flush_time` * Value type is <> * Default value is `1` @@ -123,7 +123,7 @@ Amount of time since the last flush before a flush is done even if the number of buffered events is smaller than flush_size [[plugins-outputs-solr_http-solr_url]] -===== `solr_url` +===== `solr_url` * Value type is <> * Default value is `"http://localhost:8983/solr"` @@ -131,13 +131,11 @@ the number of buffered events is smaller than flush_size URL used to connect to Solr [[plugins-outputs-solr_http-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/sqs.asciidoc b/docs/plugins/outputs/sqs.asciidoc index ff2a25362..a54a9a44d 100644 --- a/docs/plugins/outputs/sqs.asciidoc +++ b/docs/plugins/outputs/sqs.asciidoc @@ -197,7 +197,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -269,8 +269,3 @@ The AWS Session token for temporary credential * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/statsd.asciidoc b/docs/plugins/outputs/statsd.asciidoc index 7de8ca8a4..2818bf928 100644 --- a/docs/plugins/outputs/statsd.asciidoc +++ b/docs/plugins/outputs/statsd.asciidoc @@ -162,7 +162,7 @@ The hostname or IP address of the statsd server. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -243,8 +243,3 @@ are allowed in the metric names. * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/stdout.asciidoc b/docs/plugins/outputs/stdout.asciidoc index a9f5e7819..073dd24f1 100644 --- a/docs/plugins/outputs/stdout.asciidoc +++ b/docs/plugins/outputs/stdout.asciidoc @@ -101,7 +101,7 @@ for a specific plugin. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -121,8 +121,3 @@ output { * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/syslog.asciidoc b/docs/plugins/outputs/syslog.asciidoc index ad9a59e7a..82f8582e2 100644 --- a/docs/plugins/outputs/syslog.asciidoc +++ b/docs/plugins/outputs/syslog.asciidoc @@ -75,7 +75,7 @@ Available configuration options:   [[plugins-outputs-syslog-appname]] -===== `appname` +===== `appname` * Value type is <> * Default value is `"LOGSTASH"` @@ -84,7 +84,7 @@ application name for syslog message. The new value can include `%{foo}` strings to help you build a new value from other parts of the event. [[plugins-outputs-syslog-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -92,7 +92,7 @@ to help you build a new value from other parts of the event. The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-syslog-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -102,7 +102,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-syslog-facility]] -===== `facility` +===== `facility` * Value type is <> * Default value is `"user-level"` @@ -113,7 +113,7 @@ The new value can include `%{foo}` strings to help you build a new value from other parts of the event. [[plugins-outputs-syslog-host]] -===== `host` +===== `host` * This is a required setting. * Value type is <> @@ -122,7 +122,7 @@ to help you build a new value from other parts of the event. syslog server address to connect to [[plugins-outputs-syslog-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -141,7 +141,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-syslog-message]] -===== `message` +===== `message` * Value type is <> * Default value is `"%{message}"` @@ -150,7 +150,7 @@ message text to log. The new value can include `%{foo}` strings to help you build a new value from other parts of the event. [[plugins-outputs-syslog-msgid]] -===== `msgid` +===== `msgid` * Value type is <> * Default value is `"-"` @@ -159,7 +159,7 @@ message id for syslog message. The new value can include `%{foo}` strings to help you build a new value from other parts of the event. [[plugins-outputs-syslog-port]] -===== `port` +===== `port` * This is a required setting. * Value type is <> @@ -168,7 +168,7 @@ to help you build a new value from other parts of the event. syslog server port to connect to [[plugins-outputs-syslog-priority]] -===== `priority` +===== `priority` * Value type is <> * Default value is `"%{syslog_pri}"` @@ -178,7 +178,7 @@ The new value can include `%{foo}` strings to help you build a new value from other parts of the event. [[plugins-outputs-syslog-procid]] -===== `procid` +===== `procid` * Value type is <> * Default value is `"-"` @@ -187,7 +187,7 @@ process id for syslog message. The new value can include `%{foo}` strings to help you build a new value from other parts of the event. [[plugins-outputs-syslog-protocol]] -===== `protocol` +===== `protocol` * Value can be any of: `tcp`, `udp`, `ssl-tcp` * Default value is `"udp"` @@ -195,7 +195,7 @@ to help you build a new value from other parts of the event. syslog server protocol. you can choose between udp, tcp and ssl/tls over tcp [[plugins-outputs-syslog-reconnect_interval]] -===== `reconnect_interval` +===== `reconnect_interval` * Value type is <> * Default value is `1` @@ -203,7 +203,7 @@ syslog server protocol. you can choose between udp, tcp and ssl/tls over tcp when connection fails, retry interval in sec. [[plugins-outputs-syslog-rfc]] -===== `rfc` +===== `rfc` * Value can be any of: `rfc3164`, `rfc5424` * Default value is `"rfc3164"` @@ -211,7 +211,7 @@ when connection fails, retry interval in sec. syslog message format: you can choose between rfc3164 or rfc5424 [[plugins-outputs-syslog-severity]] -===== `severity` +===== `severity` * Value type is <> * Default value is `"notice"` @@ -222,7 +222,7 @@ The new value can include `%{foo}` strings to help you build a new value from other parts of the event. [[plugins-outputs-syslog-sourcehost]] -===== `sourcehost` +===== `sourcehost` * Value type is <> * Default value is `"%{host}"` @@ -231,7 +231,7 @@ source host for syslog message. The new value can include `%{foo}` strings to help you build a new value from other parts of the event. [[plugins-outputs-syslog-ssl_cacert]] -===== `ssl_cacert` +===== `ssl_cacert` * Value type is <> * There is no default value for this setting. @@ -239,7 +239,7 @@ to help you build a new value from other parts of the event. The SSL CA certificate, chainfile or CA path. The system CA path is automatically included. [[plugins-outputs-syslog-ssl_cert]] -===== `ssl_cert` +===== `ssl_cert` * Value type is <> * There is no default value for this setting. @@ -247,7 +247,7 @@ The SSL CA certificate, chainfile or CA path. The system CA path is automaticall SSL certificate path [[plugins-outputs-syslog-ssl_key]] -===== `ssl_key` +===== `ssl_key` * Value type is <> * There is no default value for this setting. @@ -255,7 +255,7 @@ SSL certificate path SSL key path [[plugins-outputs-syslog-ssl_key_passphrase]] -===== `ssl_key_passphrase` +===== `ssl_key_passphrase` * Value type is <> * Default value is `nil` @@ -263,7 +263,7 @@ SSL key path SSL key passphrase [[plugins-outputs-syslog-ssl_verify]] -===== `ssl_verify` +===== `ssl_verify` * Value type is <> * Default value is `false` @@ -271,7 +271,7 @@ SSL key passphrase Verify the identity of the other end of the SSL connection against the CA. [[plugins-outputs-syslog-use_labels]] -===== `use_labels` +===== `use_labels` * Value type is <> * Default value is `true` @@ -280,13 +280,11 @@ use label parsing for severity and facility levels use priority field if set to false [[plugins-outputs-syslog-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/tcp.asciidoc b/docs/plugins/outputs/tcp.asciidoc index b41811be6..9700b10b2 100644 --- a/docs/plugins/outputs/tcp.asciidoc +++ b/docs/plugins/outputs/tcp.asciidoc @@ -100,7 +100,7 @@ When mode is `client`, the address to connect to. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -210,8 +210,3 @@ For input, sets the field `sslsubject` to that of the client certificate. * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/udp.asciidoc b/docs/plugins/outputs/udp.asciidoc index 0ca011cee..1fcaa3508 100644 --- a/docs/plugins/outputs/udp.asciidoc +++ b/docs/plugins/outputs/udp.asciidoc @@ -88,7 +88,7 @@ The address to send messages to * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -117,8 +117,3 @@ The port to send messages on * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/webhdfs.asciidoc b/docs/plugins/outputs/webhdfs.asciidoc index 4a23b0314..7e5fd91af 100644 --- a/docs/plugins/outputs/webhdfs.asciidoc +++ b/docs/plugins/outputs/webhdfs.asciidoc @@ -154,7 +154,7 @@ The server name for webhdfs/httpfs connections. * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -301,8 +301,3 @@ The Username for webhdfs. * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - - diff --git a/docs/plugins/outputs/websocket.asciidoc b/docs/plugins/outputs/websocket.asciidoc index 1c704884a..57e09d71b 100644 --- a/docs/plugins/outputs/websocket.asciidoc +++ b/docs/plugins/outputs/websocket.asciidoc @@ -52,7 +52,7 @@ Available configuration options:   [[plugins-outputs-websocket-codec]] -===== `codec` +===== `codec` * Value type is <> * Default value is `"plain"` @@ -60,7 +60,7 @@ Available configuration options: The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline. [[plugins-outputs-websocket-enable_metric]] -===== `enable_metric` +===== `enable_metric` * Value type is <> * Default value is `true` @@ -70,7 +70,7 @@ by default we record all the metrics we can, but you can disable metrics collect for a specific plugin. [[plugins-outputs-websocket-host]] -===== `host` +===== `host` * Value type is <> * Default value is `"0.0.0.0"` @@ -78,7 +78,7 @@ for a specific plugin. The address to serve websocket data from [[plugins-outputs-websocket-id]] -===== `id` +===== `id` * Value type is <> * There is no default value for this setting. @@ -97,7 +97,7 @@ output { If you don't explicitely set this variable Logstash will generate a unique name. [[plugins-outputs-websocket-port]] -===== `port` +===== `port` * Value type is <> * Default value is `3232` @@ -105,13 +105,11 @@ If you don't explicitely set this variable Logstash will generate a unique name. The port to serve websocket data from [[plugins-outputs-websocket-workers]] -===== `workers` +===== `workers` * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne + diff --git a/docs/plugins/outputs/xmpp.asciidoc b/docs/plugins/outputs/xmpp.asciidoc index dc2a3fc9a..35da65537 100644 --- a/docs/plugins/outputs/xmpp.asciidoc +++ b/docs/plugins/outputs/xmpp.asciidoc @@ -94,7 +94,7 @@ the host on the user/identity is used. (foo.com for user@foo.com) * There is no default value for this setting. Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. -It is strongly recommended to set this ID in your configuration. This is particulary useful +It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs. @@ -158,8 +158,3 @@ The users to send messages to * Value type is <> * Default value is `1` -TODO remove this in Logstash 6.0 -when we no longer support the :legacy type -This is hacky, but it can only be herne - -