Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
docs/html_docs
html_docs
.idea
10 changes: 5 additions & 5 deletions docs/plugins/codecs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[codec-plugins]]
== Codec plugins

A codec plugin changes the data representation of an event. Codecs are essentially stream filters that can operate as part
A codec plugin changes the data representation of an event. Codecs are essentially stream filters that can operate as part
of an input or output.

The following codec plugins are available below. For a list of Elastic supported plugins, please consult the https://www.elastic.co/support/matrix#show_logstash_plugins[Support Matrix].
Expand Down Expand Up @@ -76,13 +76,13 @@ include::codecs/graphite.asciidoc[]
include::codecs/gzip_lines.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/main/docs/static/core-plugins/codecs/java_dots.asciidoc
include::../../../logstash/docs/static/core-plugins/codecs/java_dots.asciidoc[]
include::./static/core-plugins/codecs/java_dots.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/main/docs/static/core-plugins/codecs/java_line.asciidoc
include::../../../logstash/docs/static/core-plugins/codecs/java_line.asciidoc[]
include::./static/core-plugins/codecs/java_line.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/main/docs/static/core-plugins/codecs/java_plain.asciidoc
include::../../../logstash/docs/static/core-plugins/codecs/java_plain.asciidoc[]
include::./static/core-plugins/codecs/java_plain.asciidoc[]

:edit_url: https://github.com/logstash-plugins/logstash-codec-json/edit/main/docs/index.asciidoc
include::codecs/json.asciidoc[]
Expand Down Expand Up @@ -115,4 +115,4 @@ include::codecs/protobuf.asciidoc[]
include::codecs/rubydebug.asciidoc[]


:edit_url:
:edit_url:
18 changes: 9 additions & 9 deletions docs/plugins/codecs/avro.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
:version: v3.4.1
:release_date: 2023-10-16
:changelog_url: https://github.com/logstash-plugins/logstash-codec-avro/blob/v3.4.1/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
Expand All @@ -23,8 +23,8 @@ include::{include_path}/plugin_header.asciidoc[]

Read serialized Avro records as Logstash events

This plugin is used to serialize Logstash events as
Avro datums, as well as deserializing Avro datums into
This plugin is used to serialize Logstash events as
Avro datums, as well as deserializing Avro datums into
Logstash events.

[id="plugins-{type}s-{plugin}-ecs_metadata"]
Expand All @@ -34,8 +34,8 @@ The plugin behaves the same regardless of ECS compatibility, except adding the o

==== Encoding

This codec is for serializing individual Logstash events
as Avro datums that are Avro binary blobs. It does not encode
This codec is for serializing individual Logstash events
as Avro datums that are Avro binary blobs. It does not encode
Logstash events into an Avro file.


Expand All @@ -52,7 +52,7 @@ providing a schema containing a subset of the schema which was used to serialize
the data.
This codec *doesn't support partial deserialization of arbitrary fields*.
Partial deserialization _might_ work only when providing a schema which contains
the first `N` fields of the schema used to serialize the data (and
the first `N` fields of the schema used to serialize the data (and
in the same order).
================================================================================

Expand Down Expand Up @@ -107,14 +107,14 @@ Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (E
* Value can be any of: `binary`, `base64`
* Default value is `base64`

Set encoding for Avro's payload.
Set encoding for Avro's payload.
Use `base64` (default) to indicate that this codec sends or expects to receive base64-encoded bytes.

Set this option to `binary` to indicate that this codec sends or expects to receive binary Avro data.


[id="plugins-{type}s-{plugin}-schema_uri"]
===== `schema_uri`
===== `schema_uri`

* This is a required setting.
* Value type is <<string,string>>
Expand All @@ -128,7 +128,7 @@ example:
* file - `/path/to/schema.avsc`

[id="plugins-{type}s-{plugin}-tag_on_failure"]
===== `tag_on_failure`
===== `tag_on_failure`

* Value type is <<boolean,boolean>>
* Default value is `false`
Expand Down
20 changes: 10 additions & 10 deletions docs/plugins/codecs/cef.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
:version: v6.2.8
:release_date: 2024-10-22
:changelog_url: https://github.com/logstash-plugins/logstash-codec-cef/blob/v6.2.8/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
Expand Down Expand Up @@ -434,7 +434,7 @@ from the CEF payload is used to interpret the given time. If the event does
not include timezone information, this `default_timezone` is used instead.

[id="plugins-{type}s-{plugin}-delimiter"]
===== `delimiter`
===== `delimiter`

* Value type is <<string,string>>
* There is no default value for this setting.
Expand Down Expand Up @@ -493,7 +493,7 @@ If the codec handles data from a variety of sources, the ECS recommendation is t
Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].

[id="plugins-{type}s-{plugin}-fields"]
===== `fields`
===== `fields`

* Value type is <<array,array>>
* Default value is `[]`
Expand All @@ -516,7 +516,7 @@ a localized format, this `locale` is used to interpret locale-specific strings
such as month abbreviations.

[id="plugins-{type}s-{plugin}-name"]
===== `name`
===== `name`

* Value type is <<string,string>>
* Default value is `"Logstash"`
Expand All @@ -527,7 +527,7 @@ value of the name field in the CEF header. The new value can include `%{foo}` st
to help you build a new value from other parts of the event.

[id="plugins-{type}s-{plugin}-product"]
===== `product`
===== `product`

* Value type is <<string,string>>
* Default value is `"Logstash"`
Expand All @@ -538,7 +538,7 @@ value of the device product field in CEF header. The new value can include `%{fo
to help you build a new value from other parts of the event.

[id="plugins-{type}s-{plugin}-raw_data_field"]
===== `raw_data_field`
===== `raw_data_field`

* Value type is <<string,string>>
* There is no default value for this setting
Expand All @@ -555,7 +555,7 @@ Store the raw data to the field, for example `[event][original]`. Existing targe
Set to true to adhere to the specifications and encode using the CEF key name (short name) for the CEF field names.

[id="plugins-{type}s-{plugin}-severity"]
===== `severity`
===== `severity`

* Value type is <<string,string>>
* Default value is `"6"`
Expand All @@ -570,7 +570,7 @@ to be an integer in the range from 0 to 10 (including).
All invalid values will be mapped to the default of 6.

[id="plugins-{type}s-{plugin}-signature"]
===== `signature`
===== `signature`

* Value type is <<string,string>>
* Default value is `"Logstash"`
Expand All @@ -581,7 +581,7 @@ value of the signature ID field in CEF header. The new value can include `%{foo}
to help you build a new value from other parts of the event.

[id="plugins-{type}s-{plugin}-vendor"]
===== `vendor`
===== `vendor`

* Value type is <<string,string>>
* Default value is `"Elasticsearch"`
Expand All @@ -592,7 +592,7 @@ value of the device vendor field in CEF header. The new value can include `%{foo
to help you build a new value from other parts of the event.

[id="plugins-{type}s-{plugin}-version"]
===== `version`
===== `version`

* Value type is <<string,string>>
* Default value is `"1.0"`
Expand Down
6 changes: 2 additions & 4 deletions docs/plugins/codecs/cloudfront.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
:version: v7.2.1
:release_date: 2025-02-13
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.2.1/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
Expand All @@ -36,7 +36,7 @@ This codec will read cloudfront encoded content
&nbsp;

[id="plugins-{type}s-{plugin}-charset"]
===== `charset`
===== `charset`

* Value can be any 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`
* Default value is `"UTF-8"`
Expand All @@ -50,5 +50,3 @@ weird cases like this, you can set the charset setting to the
actual encoding of the text and logstash will convert it for you.

For nxlog users, you'll want to set this to "CP1252"


8 changes: 2 additions & 6 deletions docs/plugins/codecs/cloudtrail.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
:version: v7.2.1
:release_date: 2025-02-13
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.2.1/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
Expand All @@ -36,11 +36,7 @@ This is the base class for logstash codecs.
&nbsp;

[id="plugins-{type}s-{plugin}-charset"]
===== `charset`
===== `charset`

* Value can be any 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`
* Default value is `"UTF-8"`




18 changes: 8 additions & 10 deletions docs/plugins/codecs/collectd.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
:version: v3.1.0
:release_date: 2021-08-04
:changelog_url: https://github.com/logstash-plugins/logstash-codec-collectd/blob/v3.1.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
Expand Down Expand Up @@ -71,7 +71,7 @@ Be sure to replace `10.0.0.1` with the IP of your Logstash instance.
&nbsp;

[id="plugins-{type}s-{plugin}-authfile"]
===== `authfile`
===== `authfile`

* Value type is <<string,string>>
* There is no default value for this setting.
Expand All @@ -82,7 +82,7 @@ in collectd. You only need to set this option if the `security_level` is set to
`Sign` or `Encrypt`

[id="plugins-{type}s-{plugin}-nan_handling"]
===== `nan_handling`
===== `nan_handling`

* Value can be any of: `change_value`, `warn`, `drop`
* Default value is `"change_value"`
Expand All @@ -94,7 +94,7 @@ What to do when a value in the event is `NaN` (Not a Number)
- drop: Drop the event containing the `NaN` (this only drops the single event, not the whole packet)

[id="plugins-{type}s-{plugin}-nan_tag"]
===== `nan_tag`
===== `nan_tag`

* Value type is <<string,string>>
* Default value is `"_collectdNaN"`
Expand All @@ -103,7 +103,7 @@ The tag to add to the event if a `NaN` value was found
Set this to an empty string ('') if you don't want to tag

[id="plugins-{type}s-{plugin}-nan_value"]
===== `nan_value`
===== `nan_value`

* Value type is <<number,number>>
* Default value is `0`
Expand All @@ -112,15 +112,15 @@ Only relevant when `nan_handeling` is set to `change_value`
Change NaN to this configured value

[id="plugins-{type}s-{plugin}-prune_intervals"]
===== `prune_intervals`
===== `prune_intervals`

* Value type is <<boolean,boolean>>
* Default value is `true`

Prune interval records. Defaults to `true`.

[id="plugins-{type}s-{plugin}-security_level"]
===== `security_level`
===== `security_level`

* Value can be any of: `None`, `Sign`, `Encrypt`
* Default value is `"None"`
Expand Down Expand Up @@ -149,13 +149,11 @@ For example, if you want data to be put under the `document` field:
}

[id="plugins-{type}s-{plugin}-typesdb"]
===== `typesdb`
===== `typesdb`

* Value type is <<array,array>>
* There is no default value for this setting.

File path(s) to collectd `types.db` to use.
The last matching pattern wins if you have identical pattern names in multiple files.
If no types.db is provided the included `types.db` will be used (currently 5.4.0).


Loading
Loading