Skip to content

Commit

Permalink
updated docs for main (#1520)
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored Aug 28, 2023
1 parent 8eb7b57 commit cb30e7d
Show file tree
Hide file tree
Showing 46 changed files with 411 additions and 192 deletions.
6 changes: 3 additions & 3 deletions docs/plugins/codecs/cef.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v6.2.6
:release_date: 2022-10-26
:changelog_url: https://github.com/logstash-plugins/logstash-codec-cef/blob/v6.2.6/CHANGELOG.md
:version: v6.2.7
:release_date: 2023-05-12
:changelog_url: https://github.com/logstash-plugins/logstash-codec-cef/blob/v6.2.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/codecs/cloudfront.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.1
:release_date: 2023-04-11
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.1/CHANGELOG.md
:version: v7.1.5
:release_date: 2023-08-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.5/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/codecs/cloudtrail.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.1
:release_date: 2023-04-11
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.1/CHANGELOG.md
:version: v7.1.5
:release_date: 2023-08-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.5/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
8 changes: 5 additions & 3 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: v3.15.0
:release_date: 2023-03-10
:changelog_url: https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v3.15.0/CHANGELOG.md
:version: v3.15.2
:release_date: 2023-07-24
:changelog_url: https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v3.15.2/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -321,6 +321,7 @@ environment variables e.g. `proxy => '${LS_PROXY:}'`.
Elasticsearch query string. More information is available in the
{ref}/query-dsl-query-string-query.html#query-string-syntax[Elasticsearch query
string documentation].
Use either `query` or `query_template`.


[id="plugins-{type}s-{plugin}-query_template"]
Expand All @@ -331,6 +332,7 @@ string documentation].

File path to elasticsearch query in DSL format. More information is available in
the {ref}/query-dsl.html[Elasticsearch query documentation].
Use either `query` or `query_template`.

[id="plugins-{type}s-{plugin}-result_size"]
===== `result_size`
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/filters/fingerprint.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.4.2
:release_date: 2023-01-13
:changelog_url: https://github.com/logstash-plugins/logstash-filter-fingerprint/blob/v3.4.2/CHANGELOG.md
:version: v3.4.3
:release_date: 2023-05-12
:changelog_url: https://github.com/logstash-plugins/logstash-filter-fingerprint/blob/v3.4.3/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
10 changes: 5 additions & 5 deletions docs/plugins/filters/hashid.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v0.1.3
:release_date: 2017-08-21
:changelog_url: https://github.com/logstash-plugins/logstash-filter-hashid/blob/v0.1.3/CHANGELOG.md
:version: v0.1.4
:release_date: 2023-05-30
:changelog_url: https://github.com/logstash-plugins/logstash-filter-hashid/blob/v0.1.4/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -44,7 +44,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-add_timestamp_prefix>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-hash_bytes_used>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-key>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-key>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-method>> |<<string,string>>, one of `["SHA1", "SHA256", "SHA384", "SHA512", "MD5"]`|No
| <<plugins-{type}s-{plugin}-source>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
Expand Down Expand Up @@ -75,7 +75,7 @@ If not specified, the full hash will be used
[id="plugins-{type}s-{plugin}-key"]
===== `key`

* Value type is <<string,string>>
* Value type is <<password,password>>
* Default value is `"hashid"`

Encryption key to be used when generating cryptographic hashes
Expand Down
22 changes: 17 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.4.1
:release_date: 2022-11-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.1/CHANGELOG.md
:version: v5.4.4
:release_date: 2023-06-15
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.4/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -112,10 +112,14 @@ filter {
query => "SELECT firstname, lastname FROM users WHERE userid = ? AND country = ?"
prepared_parameters => ["[loggedin_userid]", "[user_nation]"] <4>
target => "user" <5>
default_hash => { <6>
firstname => nil
lastname => nil
}
}
]
# using add_field here to add & rename values to the event root
add_field => { server_name => "%{[server][0][description]}" } <6>
add_field => { server_name => "%{[server][0][description]}" } <7>
add_field => { user_firstname => "%{[user][0][firstname]}" }
add_field => { user_lastname => "%{[user][0][lastname]}" }
remove_field => ["server", "user"]
Expand All @@ -128,6 +132,13 @@ filter {
jdbc_connection_string => "jdbc:postgresql://remotedb:5432/ls_test_2"
}
}
output {
if "_jdbcstaticdefaultsused" in [tags] {
# Print all the not found users
stdout { }
}
}
-----
<1> Queries an external database to fetch the dataset that will be cached
locally.
Expand All @@ -140,7 +151,8 @@ See <<plugins-{type}s-{plugin}-object_order>>.
follow the positional ordering.
<5> Specifies the event field that will store the looked-up data. If the lookup
returns multiple columns, the data is stored as a JSON object within the field.
<6> Takes data from the JSON object and stores it in top-level event fields for
<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.

Here's a full example:
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.4.1
:release_date: 2022-11-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.1/CHANGELOG.md
:version: v5.4.4
:release_date: 2023-06-15
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.4/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
13 changes: 7 additions & 6 deletions docs/plugins/filters/mutate.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.5.6
:release_date: 2021-12-02
:changelog_url: https://github.com/logstash-plugins/logstash-filter-mutate/blob/v3.5.6/CHANGELOG.md
:version: v3.5.7
:release_date: 2023-05-11
:changelog_url: https://github.com/logstash-plugins/logstash-filter-mutate/blob/v3.5.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -201,7 +201,8 @@ Example:
* Value type is <<hash,hash>>
* There is no default value for this setting.

Join an array with a separator character. Does nothing on non-array fields.
Join an array with a separator character or string.
Does nothing on non-array fields.

Example:
[source,ruby]
Expand Down Expand Up @@ -313,8 +314,8 @@ Example:
* Value type is <<hash,hash>>
* There is no default value for this setting.

Split a field to an array using a separator character. Only works on string
fields.
Split a field to an array using a separator character or string.
Only works on string fields.

Example:
[source,ruby]
Expand Down
17 changes: 14 additions & 3 deletions docs/plugins/filters/translate.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.4.0
:release_date: 2022-06-08
:changelog_url: https://github.com/logstash-plugins/logstash-filter-translate/blob/v3.4.0/CHANGELOG.md
:version: v3.4.2
:release_date: 2023-06-14
:changelog_url: https://github.com/logstash-plugins/logstash-filter-translate/blob/v3.4.2/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -109,6 +109,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
| <<plugins-{type}s-{plugin}-source>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-refresh_behaviour>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-yaml_dictionary_code_point_limit>> |<<number,number>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
Expand Down Expand Up @@ -422,5 +423,15 @@ The target field you wish to populate with the translated code.
If you set this value to the same value as `source` field, the plugin does a substitution, and
the filter will succeed. This will clobber the old value of the source field!


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

* Value type is <<number,number>>
* Default value is 134217728 (128MB for 1 byte code points)

The max amount of code points in the YAML file in `dictionary_path`. Please be aware that byte limit depends on the encoding.
This setting is effective for YAML file only. YAML over the limit throws exception.

[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]
6 changes: 3 additions & 3 deletions docs/plugins/filters/truncate.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v1.0.5
:release_date: 2022-03-18
:changelog_url: https://github.com/logstash-plugins/logstash-filter-truncate/blob/v1.0.5/CHANGELOG.md
:version: v1.0.6
:release_date: 2023-05-10
:changelog_url: https://github.com/logstash-plugins/logstash-filter-truncate/blob/v1.0.6/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/inputs/azure_event_hubs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v1.4.4
:release_date: 2022-06-13
:changelog_url: https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.4.4/CHANGELOG.md
:version: v1.4.5
:release_date: 2023-07-04
:changelog_url: https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.4.5/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
22 changes: 15 additions & 7 deletions docs/plugins/inputs/beats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v6.6.0
:release_date: 2023-04-05
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.6.0/CHANGELOG.md
:version: v6.6.3
:release_date: 2023-07-03
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.6.3/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -287,7 +287,7 @@ Refer to <<plugins-{type}s-{plugin}-ecs_metadata,ECS mapping>> for detailed info
===== `enrich`

* Value type is <<string,string>>
** A <<list,list>> can also be provided
** An <<array,array>> can also be provided
** Configures which enrichments are applied to each event
** Default value is `[codec_metadata, source_metadata]` that may be extended in future versions of this plugin to include additional enrichments.
** Supported values are:
Expand All @@ -297,7 +297,7 @@ Refer to <<plugins-{type}s-{plugin}-ecs_metadata,ECS mapping>> for detailed info
|Enrichment | Description

| codec_metadata | Information about how the codec transformed a sequence of bytes into
this Event, such as _which_ codec was used. Also, if no <<codec>> is
this Event, such as _which_ codec was used. Also, if no codec is
explicitly specified, _excluding_ `codec_metadata` from `enrich` will
disable `ecs_compatibility` for this plugin.
| source_metadata | Information about the _source_ of the event, such as the IP address
Expand All @@ -309,7 +309,7 @@ Refer to <<plugins-{type}s-{plugin}-ecs_metadata,ECS mapping>> for detailed info
| all | _alias_ to include _all_ available enrichments (including additional
enrichments introduced in future versions of this plugin)
| none | _alias_ to _exclude_ all available enrichments. Note that, _explicitly_
defining <<codec>> with this option will not disable the `ecs_compatibility`,
defining codec with this option will not disable the `ecs_compatibility`,
instead it relies on pipeline or codec `ecs_compatibility` configuration.
|=======================================================================

Expand Down Expand Up @@ -437,6 +437,10 @@ Controls the server's behavior in regard to requesting a certificate from client
`required` forces a client to present a certificate, while `optional` requests a client certificate
but the client is not required to present one. Defaults to `none`, which disables the client authentication.

When mutual TLS is enabled (`required` or `optional`), the certificate presented by the client must be signed by trusted
<<plugins-{type}s-{plugin}-ssl_certificate_authorities>> (CAs).
Please note that the server does not validate the client certificate CN (Common Name) or SAN (Subject Alternative Name).

NOTE: This setting can be used only if <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> is set.

[id="plugins-{type}s-{plugin}-ssl_enabled"]
Expand Down Expand Up @@ -525,7 +529,11 @@ If the client provides a certificate, it will be validated.
`force_peer` will make the server ask the client to provide a certificate.
If the client doesn't provide a certificate, the connection will be closed.

This option needs to be used with <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> and a defined list of CAs.
When mutual TLS is enabled (`peer` or `force_peer`), the certificate presented by the client must be signed by trusted
<<plugins-{type}s-{plugin}-ssl_certificate_authorities>> (CAs).
Please note that the server does not validate the client certificate CN (Common Name) or SAN (Subject Alternative Name).

NOTE: This setting can be used only if <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> is set.

[id="plugins-{type}s-{plugin}-tls_max_version"]
===== `tls_max_version`
Expand Down
18 changes: 14 additions & 4 deletions docs/plugins/inputs/cloudwatch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.1
:release_date: 2023-04-11
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.1/CHANGELOG.md
:version: v7.1.5
:release_date: 2023-08-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.5/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -126,6 +126,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
| <<plugins-{type}s-{plugin}-secret_access_key>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-session_token>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-statistics>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-use_aws_bundled_ca>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-use_ssl>> |<<boolean,boolean>>|No
|=======================================================================

Expand Down Expand Up @@ -302,6 +303,16 @@ The AWS Session token for temporary credential

Specify the statistics to fetch for each namespace

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

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

Use bundled CA certificates that ship with AWS SDK to verify SSL peer certificates.
For cases where the default certificates are unavailable, e.g. Windows,
you can set this to `true`.

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

Expand All @@ -314,7 +325,6 @@ Should we require (true) or disable (false) using SSL for communicating with the
The AWS SDK for Ruby defaults to SSL so we preserve that



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

Expand Down
Loading

0 comments on commit cb30e7d

Please sign in to comment.