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
32 changes: 16 additions & 16 deletions docs/plugins/filters/elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v4.1.0
:release_date: 2025-01-23
:changelog_url: https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v4.1.0/CHANGELOG.md
:version: v4.1.1
:release_date: 2025-03-17
:changelog_url: https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v4.1.1/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -172,7 +172,7 @@ filter plugins.
 

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

* Value type is <<hash,hash>>
* Default value is `{}`
Expand Down Expand Up @@ -243,7 +243,7 @@ Pass a set of key value pairs as the headers sent in each request to Elasticsear
These custom headers will override any headers previously set by the plugin such as the User Agent or Authorization headers.

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

* Value type is <<hash,hash>>
* Default value is `{}`
Expand All @@ -262,15 +262,15 @@ Example:
}

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

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

Whether results should be sorted or not

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

* Value type is <<array,array>>
* Default value is `{}`
Expand All @@ -291,15 +291,15 @@ fields => {
--------------------------------------------------

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

* Value type is <<array,array>>
* Default value is `["localhost:9200"]`

List of elasticsearch hosts to use for querying.

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

* Value type is <<string,string>>
* Default value is `""`
Expand All @@ -308,7 +308,7 @@ Comma-delimited list of index names to search; use `_all` or empty string to per
Field substitution (e.g. `index-name-%{date_field}`) is available

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

* Value type is <<password,password>>
* There is no default value for this setting.
Expand All @@ -326,7 +326,7 @@ An empty string is treated as if proxy was not set, and is useful when using
environment variables e.g. `proxy => '${LS_PROXY:}'`.

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

* Value type is <<string,string>>
* There is no default value for this setting.
Expand All @@ -338,7 +338,7 @@ Use either `query` or `query_template`.


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

* Value type is <<string,string>>
* There is no default value for this setting.
Expand All @@ -348,7 +348,7 @@ the {ref}/query-dsl.html[Elasticsearch query documentation].
Use either `query` or `query_template`.

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

* Value type is <<number,number>>
* Default value is `1`
Expand All @@ -375,7 +375,7 @@ Which HTTP Status codes to consider for retries (in addition to connection error


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

* Value type is <<string,string>>
* Default value is `"@timestamp:desc"`
Expand Down Expand Up @@ -517,15 +517,15 @@ has a hostname or IP address that matches the names within the certificate.
WARNING: Setting certificate verification to `none` disables many security benefits of SSL/TLS, which is very dangerous. For more information on disabling certificate verification please read https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf

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

* Value type is <<array,array>>
* Default value is `["_elasticsearch_lookup_failure"]`

Tags the event on failure to look up previous log event information. This can be used in later analysis.

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

* Value type is <<string,string>>
* There is no default value for this setting.
Expand Down
11 changes: 6 additions & 5 deletions docs/plugins/filters/jdbc_static.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v5.5.2
:release_date: 2024-12-23
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md
:version: v5.5.3
:release_date: 2025-03-07
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.3/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -124,7 +124,7 @@ filter {
add_field => { user_lastname => "%{[user][0][lastname]}" }
remove_field => ["server", "user"]
staging_directory => "/tmp/logstash/jdbc_static/import_data"
loader_schedule => "* */2 * * *" # run loaders every 2 hours
loader_schedule => "* */2 * * *" <8>
jdbc_user => "logstash"
jdbc_password => "example"
jdbc_driver_class => "org.postgresql.Driver"
Expand Down Expand Up @@ -154,6 +154,7 @@ returns multiple columns, the data is stored as a JSON object within the field.
<6> When the user is not found in the database, an event is created using data from the <<plugins-{type}s-{plugin}-local_lookups>> `default hash` setting, and the event is tagged with the list set in <<plugins-{type}s-{plugin}-tag_on_default_use>>.
<7> Takes data from the JSON object and stores it in top-level event fields for
easier analysis in Kibana.
<8> Runs loaders every 2 hours.

Here's a full example:

Expand Down Expand Up @@ -280,7 +281,7 @@ order is in place.
[id="plugins-{type}s-{plugin}-ecs"]
==== Compatibility with the Elastic Common Schema (ECS)

This plugin is compatible with the {ecs-ref}[Elastic Common Schema (ECS)].
This plugin is compatible with the {ecs-ref}[Elastic Common Schema (ECS)].
It behaves the same regardless of ECS compatibility, except giving a warning when ECS is enabled and `target` isn't set.

TIP: Set the `target` option to avoid potential schema conflicts.
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/filters/jdbc_streaming.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v5.5.2
:release_date: 2024-12-23
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md
:version: v5.5.3
:release_date: 2025-03-07
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.3/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
16 changes: 13 additions & 3 deletions docs/plugins/inputs/elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v5.0.0
:release_date: 2024-12-18
:changelog_url: https://github.com/logstash-plugins/logstash-input-elasticsearch/blob/v5.0.0/CHANGELOG.md
:version: v5.0.2
:release_date: 2025-03-17
:changelog_url: https://github.com/logstash-plugins/logstash-input-elasticsearch/blob/v5.0.2/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -94,6 +94,16 @@ The plugin logs a warning when ECS is enabled and `target` isn't set.

TIP: Set the `target` option to avoid potential schema conflicts.

[id="plugins-{type}s-{plugin}-failure-handling"]
==== Failure handling

When this input plugin cannot create a structured `Event` from a hit result, it will instead create an `Event` that is tagged with `_elasticsearch_input_failure` whose `[event][original]` is a JSON-encoded string representation of the entire hit.

Common causes are:

- When the hit result contains top-level fields that are {logstash-ref}/processing.html#reserved-fields[reserved in Logstash] but do not have the expected shape. Use the <<plugins-{type}s-{plugin}-target>> directive to avoid conflicts with the top-level namespace.
- When <<plugins-{type}s-{plugin}-docinfo>> is enabled and the docinfo fields cannot be merged into the hit result. Combine <<plugins-{type}s-{plugin}-target>> and <<plugins-{type}s-{plugin}-docinfo_target>> to avoid conflict.

[id="plugins-{type}s-{plugin}-options"]
==== Elasticsearch Input configuration options

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/inputs/jdbc.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v5.5.2
:release_date: 2024-12-23
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md
:version: v5.5.3
:release_date: 2025-03-07
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.3/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
8 changes: 4 additions & 4 deletions docs/plugins/inputs/syslog.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.7.0
:release_date: 2023-10-17
:changelog_url: https://github.com/logstash-plugins/logstash-input-syslog/blob/v3.7.0/CHANGELOG.md
:version: v3.7.1
:release_date: 2025-03-04
:changelog_url: https://github.com/logstash-plugins/logstash-input-syslog/blob/v3.7.1/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -89,7 +89,7 @@ Controls this plugin's compatibility with the
Labels for facility levels defined in RFC3164.

You can use this option to override the integer->label mapping for syslog inputs
that behave differently than the RFCs.
that behave differently than the RFCs.

Provide a zero-indexed array with all of your facility labels _in order_.
If a log message contains a facility number with no corresponding entry,
Expand Down
8 changes: 5 additions & 3 deletions docs/plugins/integrations/jdbc.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v5.5.2
:release_date: 2024-12-23
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md
:version: v5.5.3
:release_date: 2025-03-07
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.3/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -29,3 +29,5 @@ The JDBC Integration Plugin provides integrated plugins for working with databas
- {logstash-ref}/plugins-filters-jdbc_streaming.html[JDBC Streaming Filter Plugin]

:no_codec!:


Loading