Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changed expected datatype of various options to number #309

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+70 −62
Open

Changed expected datatype of various options to number #309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
## 10.0.0
- Changed expected datatype of various options to number:
`auto_commit_interval_ms`, `connections_max_idle_ms`, `fetch_max_bytes`, `fetch_max_wait_ms`,
`fetch_min_bytes`, `heartbeat_interval_ms`, `max_partition_fetch_bytes`, `max_poll_interval_ms`,
`max_poll_records`, `metadata_max_age_ms`, `receive_buffer_bytes`, `reconnect_backoff_ms`,
`request_timeout_ms`, `retry_backoff_ms`, `send_buffer_bytes`, `session_timeout_ms`
[#309](https://github.com/logstash-plugins/logstash-input-kafka/pull/309)

## 9.0.0
- Removed obsolete `ssl` option

Expand Down
66 changes: 33 additions & 33 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,39 +77,39 @@ https://kafka.apache.org/documentation for more details.
[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-auto_commit_interval_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-auto_commit_interval_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-auto_offset_reset>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-bootstrap_servers>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-check_crcs>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-client_id>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-connections_max_idle_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-connections_max_idle_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-consumer_threads>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-decorate_events>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-enable_auto_commit>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-exclude_internal_topics>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-fetch_max_bytes>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-fetch_max_wait_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-fetch_min_bytes>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-fetch_max_bytes>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-fetch_max_wait_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-fetch_min_bytes>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-group_id>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-heartbeat_interval_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-heartbeat_interval_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-jaas_path>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-kerberos_config>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-key_deserializer_class>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-max_partition_fetch_bytes>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-max_poll_interval_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-max_poll_records>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-metadata_max_age_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-max_partition_fetch_bytes>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-max_poll_interval_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-max_poll_records>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-metadata_max_age_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-partition_assignment_strategy>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-poll_timeout_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-receive_buffer_bytes>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-reconnect_backoff_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-request_timeout_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-retry_backoff_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-receive_buffer_bytes>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-reconnect_backoff_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-request_timeout_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-retry_backoff_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-sasl_kerberos_service_name>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_mechanism>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-security_protocol>> |<<string,string>>, one of `["PLAINTEXT", "SSL", "SASL_PLAINTEXT", "SASL_SSL"]`|No
| <<plugins-{type}s-{plugin}-send_buffer_bytes>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-session_timeout_ms>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-send_buffer_bytes>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-session_timeout_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-ssl_endpoint_identification_algorithm>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-ssl_key_password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-ssl_keystore_location>> |a valid filesystem path|No
Expand All @@ -131,8 +131,8 @@ input plugins.
[id="plugins-{type}s-{plugin}-auto_commit_interval_ms"]
===== `auto_commit_interval_ms`

* Value type is <<string,string>>
* Default value is `"5000"`
* Value type is <<number,number>>
* Default value is `5000`

The frequency in milliseconds that the consumer offsets are committed to Kafka.

Expand Down Expand Up @@ -184,7 +184,7 @@ a logical application name to be included.
[id="plugins-{type}s-{plugin}-connections_max_idle_ms"]
===== `connections_max_idle_ms`

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

Close idle connections after the number of milliseconds specified by this config.
Expand Down Expand Up @@ -235,7 +235,7 @@ If set to true the only way to receive records from an internal topic is subscri
[id="plugins-{type}s-{plugin}-fetch_max_bytes"]
===== `fetch_max_bytes`

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

The maximum amount of data the server should return for a fetch request. This is not an
Expand All @@ -245,7 +245,7 @@ than this value, the message will still be returned to ensure that the consumer
[id="plugins-{type}s-{plugin}-fetch_max_wait_ms"]
===== `fetch_max_wait_ms`

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

The maximum amount of time the server will block before answering the fetch request if
Expand All @@ -255,7 +255,7 @@ should be less than or equal to the timeout used in `poll_timeout_ms`
[id="plugins-{type}s-{plugin}-fetch_min_bytes"]
===== `fetch_min_bytes`

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

The minimum amount of data the server should return for a fetch request. If insufficient
Expand All @@ -275,7 +275,7 @@ Logstash instances with the same `group_id`
[id="plugins-{type}s-{plugin}-heartbeat_interval_ms"]
===== `heartbeat_interval_ms`

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

The expected time between heartbeats to the consumer coordinator. Heartbeats are used to ensure
Expand Down Expand Up @@ -326,7 +326,7 @@ Java Class used to deserialize the record's key
[id="plugins-{type}s-{plugin}-max_partition_fetch_bytes"]
===== `max_partition_fetch_bytes`

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

The maximum amount of data per-partition the server will return. The maximum total memory used for a
Expand All @@ -338,7 +338,7 @@ to fetch a large message on a certain partition.
[id="plugins-{type}s-{plugin}-max_poll_interval_ms"]
===== `max_poll_interval_ms`

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

The maximum delay between invocations of poll() when using consumer group management. This places
Expand All @@ -350,15 +350,15 @@ The value of the configuration `request_timeout_ms` must always be larger than m
[id="plugins-{type}s-{plugin}-max_poll_records"]
===== `max_poll_records`

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

The maximum number of records returned in a single call to poll().

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

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

The period of time in milliseconds after which we force a refresh of metadata even if
Expand Down Expand Up @@ -386,15 +386,15 @@ Time kafka consumer will wait to receive new messages from topics
[id="plugins-{type}s-{plugin}-receive_buffer_bytes"]
===== `receive_buffer_bytes`

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

The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.

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

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

The amount of time to wait before attempting to reconnect to a given host.
Expand All @@ -404,7 +404,7 @@ This backoff applies to all requests sent by the consumer to the broker.
[id="plugins-{type}s-{plugin}-request_timeout_ms"]
===== `request_timeout_ms`

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

The configuration controls the maximum amount of time the client will wait
Expand All @@ -415,7 +415,7 @@ retries are exhausted.
[id="plugins-{type}s-{plugin}-retry_backoff_ms"]
===== `retry_backoff_ms`

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

The amount of time to wait before attempting to retry a failed fetch request
Expand Down Expand Up @@ -451,15 +451,15 @@ Security protocol to use, which can be either of PLAINTEXT,SSL,SASL_PLAINTEXT,SA
[id="plugins-{type}s-{plugin}-send_buffer_bytes"]
===== `send_buffer_bytes`

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

The size of the TCP send buffer (SO_SNDBUF) to use when sending data

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

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

The timeout after which, if the `poll_timeout_ms` is not invoked, the consumer is marked dead
Expand Down
Loading