Update default kibana.yml #117597

TinaHeiligers · 2021-11-04T20:53:29Z

Summary

With a new major release, we needed to audit the default kibana.yml template to ensure any deprecated settings have been updated and/or removed. Fortunately, the configurations already provided are all still valid and up to date but could be rearranged into logical groupings to make it easier to read.

This PR enhances the config template:

Regroups configurations into general categories to improve readability (with a heading for each).
Adds a link to elastic docs with a comment on where to find more config options. Since our docs are versioned, I chose to give a link that doesn't reference a branch in particular and rather added a comment about what someone would look for.
Adds important and frequently used configurations for non-subscription level features, inspired by the configurations we use within a stackpack and those allow-listed in cloud.
Fixes minor typo's and language

elasticmachine · 2021-11-04T21:53:13Z

Pinging @elastic/kibana-core (Team:Core)

kibanamachine · 2021-11-04T22:53:23Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

rudolf · 2021-11-05T07:39:17Z

config/kibana.yml


-# Set the value of this setting to off to suppress all logging output, or to debug to log everything.
+# =================== System: Logging ===================
+# Set the value of this setting to off to suppress all logging output, or to debug to log everything. Defaults to 'error'


Suggested change

# Set the value of this setting to off to suppress all logging output, or to debug to log everything. Defaults to 'error'

# Set the value of this setting to off to suppress all logging output, or to debug to log everything. Defaults to 'info'

mshustov · 2021-11-05T08:54:06Z

config/kibana.yml

+# The number of documents migrated at a time.
+# If Kibana can't start up or upgrade due to an Elasticsearch `circuit_breaking_exception`,
+# use a smaller batchSize value to reduce the memory pressure. Defaults to 1000
+# migrations.batchSize: 1000


Suggested change

# migrations.batchSize: 1000

#migrations.batchSize: 1000

mshustov · 2021-11-05T08:54:20Z

config/kibana.yml

+# To avoid migrations failing due to a 413 Request Entity Too Large response from Elasticsearch.
+# This value should be lower than or equal to your Elasticsearch cluster’s `http.max_content_length`
+# configuration option. Default: 100mb
+# migrations.maxBatchSizeBytes: 100mb


Suggested change

# migrations.maxBatchSizeBytes: 100mb

#migrations.maxBatchSizeBytes: 100mb

mshustov · 2021-11-05T08:54:28Z

config/kibana.yml

+# The number of times to retry temporary migration failures. Increase the setting
+# if migrations fail frequently with a message such as `Unable to complete the [...] step after
+# 15 attempts, terminating`. Defaults to 15
+# migrations.retryAttempts: 15


Suggested change

# migrations.retryAttempts: 15

#migrations.retryAttempts: 15

mshustov · 2021-11-05T08:54:40Z

config/kibana.yml

+# =================== Search Autocomplete ===================
+# Time in milliseconds to wait for autocomplete suggestions from Elasticsearch.
+# This value must be a whole number greater than zero. Defaults to 1000
+# data.autocomplete.valueSuggestions.timeout: 1000


Suggested change

# data.autocomplete.valueSuggestions.timeout: 1000

#data.autocomplete.valueSuggestions.timeout: 1000

mshustov · 2021-11-05T08:55:03Z

config/kibana.yml

+
+# Maximum number of documents loaded by each shard to generate autocomplete suggestions.
+# This value must be a whole number greater than zero. Defaults to 100000
+# data.autocomplete.valueSuggestions.terminateAfter: 100000


Suggested change

# data.autocomplete.valueSuggestions.terminateAfter: 100000

#data.autocomplete.valueSuggestions.terminateAfter: 100000

mshustov · 2021-11-05T08:57:54Z

config/kibana.yml

+
+# Specifies the path where Kibana creates the process ID file.
+#pid.file: /run/kibana/kibana.pid
+
 # Set the interval in milliseconds to sample system and process performance
 # metrics. Minimum is 100ms. Defaults to 5000.


Suggested change

# metrics. Minimum is 100ms. Defaults to 5000.

# metrics. Minimum is 100ms. Defaults to 5000ms.

mshustov · 2021-11-05T08:58:33Z

config/kibana.yml

+
+# The number of documents migrated at a time.
+# If Kibana can't start up or upgrade due to an Elasticsearch `circuit_breaking_exception`,
+# use a smaller batchSize value to reduce the memory pressure. Defaults to 1000


Suggested change

# use a smaller batchSize value to reduce the memory pressure. Defaults to 1000

# use a smaller batchSize value to reduce the memory pressure. Defaults to 1000 objects per batch.

mshustov · 2021-11-05T08:59:27Z

config/kibana.yml

+
+# =================== Search Autocomplete ===================
+# Time in milliseconds to wait for autocomplete suggestions from Elasticsearch.
+# This value must be a whole number greater than zero. Defaults to 1000


Suggested change

# This value must be a whole number greater than zero. Defaults to 1000

# This value must be a whole number greater than zero. Defaults to 1000ms

mshustov · 2021-11-05T09:01:10Z

config/kibana.yml

+# data.autocomplete.valueSuggestions.timeout: 1000
+
+# Maximum number of documents loaded by each shard to generate autocomplete suggestions.
+# This value must be a whole number greater than zero. Defaults to 100000


Suggested change

# This value must be a whole number greater than zero. Defaults to 100000

# This value must be a whole number greater than zero. Defaults to 100_000

This reverts commit ff7e77a.

kibanamachine · 2021-11-09T14:29:51Z