mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[DOCS] Fixes backported settings tables (#67387)
This commit is contained in:
Kaarina Tungseth
GitHub
parent
626f2e2710
commit
ab1330df6b
6 changed files with 35 additions and 177 deletions
|
|
@ -1,56 +0,0 @@
|
|||
[role="xpack"]
|
||||
[[alert-action-settings-kb]]
|
||||
=== Alerting and action settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Alerting and action settings</titleabbrev>
|
||||
++++
|
||||
|
||||
Alerts and actions are enabled by default in {kib}, but require you configure the following in order to use them:
|
||||
|
||||
. <<using-kibana-with-security,Set up {kib} to work with {stack} {security-features}>>.
|
||||
. <<configuring-tls-kib-es,Set up TLS encryption between {kib} and {es}>>.
|
||||
. <<general-alert-action-settings,Specify a value for `xpack.encryptedSavedObjects.encryptionKey`>>.
|
||||
|
||||
You can configure the following settings in the `kibana.yml` file.
|
||||
|
||||
|
||||
[float]
|
||||
[[general-alert-action-settings]]
|
||||
==== General settings
|
||||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
|
||||
| `xpack.encryptedSavedObjects.encryptionKey`
|
||||
| A string of 32 or more characters used to encrypt sensitive properties on alerts and actions before they're stored in {es}. Third party credentials — such as the username and password used to connect to an SMTP service — are an example of encrypted properties. +
|
||||
+
|
||||
If not set, {kib} will generate a random key on startup, but all alert and action functions will be blocked. Generated keys are not allowed for alerts and actions because when a new key is generated on restart, existing encrypted data becomes inaccessible. For the same reason, alerts and actions in high-availability deployments of {kib} will behave unexpectedly if the key isn't the same on all instances of {kib}. +
|
||||
+
|
||||
Although the key can be specified in clear text in `kibana.yml`, it's recommended to store this key securely in the <<secure-settings,{kib} Keystore>>.
|
||||
|
||||
|===
|
||||
|
||||
[float]
|
||||
[[action-settings]]
|
||||
==== Action settings
|
||||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
|
||||
| `xpack.actions.whitelistedHosts`
|
||||
| A list of hostnames that {kib} is allowed to connect to when built-in actions are triggered. It defaults to `[*]`, allowing any host, but keep in mind the potential for SSRF attacks when hosts are not explicitly whitelisted. An empty list `[]` can be used to block built-in actions from making any external connections. +
|
||||
+
|
||||
Note that hosts associated with built-in actions, such as Slack and PagerDuty, are not automatically whitelisted. If you are not using the default `[*]` setting, you must ensure that the corresponding endpoints are whitelisted as well.
|
||||
|
||||
| `xpack.actions.enabledActionTypes`
|
||||
| A list of action types that are enabled. It defaults to `[*]`, enabling all types. The names for built-in {kib} action types are prefixed with a `.` and include: `.server-log`, `.slack`, `.email`, `.index`, `.pagerduty`, and `.webhook`. An empty list `[]` will disable all action types. +
|
||||
+
|
||||
Disabled action types will not appear as an option when creating new connectors, but existing connectors and actions of that type will remain in {kib} and will not function.
|
||||
|
||||
|===
|
||||
|
||||
[float]
|
||||
[[alert-settings]]
|
||||
==== Alert settings
|
||||
|
||||
You do not need to configure any additional settings to use alerting in {kib}.
|
||||
|
|
@ -23,14 +23,3 @@ enabled by default.
|
|||
{ref}/ml-settings.html[{es} {ml} settings].
|
||||
|
||||
|===
|
||||
|
||||
[[data-visualizer-settings]]
|
||||
==== {data-viz} settings
|
||||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `xpack.ml.file_data_visualizer.max_file_size`
|
||||
| Sets the file size limit when importing data in the {data-viz}. The default
|
||||
value is `100MB`. The highest supported value for this setting is `1GB`.
|
||||
|
||||
|===
|
||||
|
|
|
|||
|
|
@ -33,42 +33,28 @@ For more information, see
|
|||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `monitoring.enabled`
|
||||
| `xpack.monitoring.enabled`
|
||||
| Set to `true` (default) to enable the {monitor-features} in {kib}. Unlike the
|
||||
`monitoring.ui.enabled` setting, when this setting is `false`, the
|
||||
monitoring back-end does not run and {kib} stats are not sent to the monitoring
|
||||
cluster.
|
||||
|
||||
| `monitoring.ui.elasticsearch.hosts`
|
||||
| `xpack.monitoring.elasticsearch.hosts`
|
||||
| Specifies the location of the {es} cluster where your monitoring data is stored.
|
||||
By default, this is the same as `elasticsearch.hosts`. This setting enables
|
||||
you to use a single {kib} instance to search and visualize data in your
|
||||
production cluster as well as monitor data sent to a dedicated monitoring
|
||||
cluster.
|
||||
|
||||
| `monitoring.ui.elasticsearch.username`
|
||||
| Specifies the username used by {kib} monitoring to establish a persistent connection
|
||||
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
|
||||
monitoring cluster. +
|
||||
+
|
||||
Every other request performed by the Stack Monitoring UI to the monitoring {es}
|
||||
cluster uses the authenticated user's credentials, which must be the same on
|
||||
both the {es} monitoring cluster and the {es} production cluster. +
|
||||
+
|
||||
If not set, {kib} uses the value of the `elasticsearch.username` setting.
|
||||
| `xpack.monitoring.elasticsearch.username`
|
||||
| Specifies the user ID that {kib} uses for authentication when it retrieves data
|
||||
from the monitorning cluster. If not set, {kib} uses the value of the `elasticsearch.username` setting.
|
||||
|
||||
| `monitoring.ui.elasticsearch.password`
|
||||
| Specifies the password used by {kib} monitoring to establish a persistent connection
|
||||
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
|
||||
monitoring cluster. +
|
||||
+
|
||||
Every other request performed by the Stack Monitoring UI to the monitoring {es}
|
||||
cluster uses the authenticated user's credentials, which must be the same on
|
||||
both the {es} monitoring cluster and the {es} production cluster. +
|
||||
+
|
||||
If not set, {kib} uses the value of the `elasticsearch.password` setting.
|
||||
| `xpack.monitoring.elasticsearch.password`
|
||||
| Specifies the password that {kib} uses for authentication when it retrieves data
|
||||
from the monitoring cluster. If not set, {kib} uses the value of the `elasticsearch.password` setting.
|
||||
|
||||
| `monitoring.ui.elasticsearch.pingTimeout`
|
||||
| `xpack.monitoring.elasticsearch.pingTimeout`
|
||||
| Specifies the time in milliseconds to wait for {es} to respond to internal
|
||||
health checks. By default, it matches the `elasticsearch.pingTimeout` setting,
|
||||
which has a default value of `30000`.
|
||||
|
|
@ -83,11 +69,11 @@ These settings control how data is collected from {kib}.
|
|||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `monitoring.kibana.collection.enabled`
|
||||
| `xpack.monitoring.kibana.collection.enabled`
|
||||
| Set to `true` (default) to enable data collection from the {kib} NodeJS server
|
||||
for {kib} Dashboards to be featured in the Monitoring.
|
||||
|
||||
| `monitoring.kibana.collection.interval`
|
||||
| `xpack.monitoring.kibana.collection.interval`
|
||||
| Specifies the number of milliseconds to wait in between data sampling on the
|
||||
{kib} NodeJS server for the metrics that are displayed in the {kib} dashboards.
|
||||
Defaults to `10000` (10 seconds).
|
||||
|
|
@ -105,24 +91,24 @@ about configuring {kib}, see
|
|||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `monitoring.ui.elasticsearch.logFetchCount`
|
||||
| `xpack.monitoring.elasticsearch.logFetchCount`
|
||||
| Specifies the number of log entries to display in the Monitoring UI. Defaults to
|
||||
`10`. The maximum value is `50`.
|
||||
|
||||
| `monitoring.ui.max_bucket_size`
|
||||
| `xpack.monitoring.max_bucket_size`
|
||||
| Specifies the number of term buckets to return out of the overall terms list when
|
||||
performing terms aggregations to retrieve index and node metrics. For more
|
||||
information about the `size` parameter, see
|
||||
{ref}/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-size[Terms Aggregation].
|
||||
Defaults to `10000`.
|
||||
|
||||
| `monitoring.ui.min_interval_seconds`
|
||||
| `xpack.monitoring.min_interval_seconds`
|
||||
| Specifies the minimum number of seconds that a time bucket in a chart can
|
||||
represent. Defaults to 10. If you modify the
|
||||
`monitoring.ui.collection.interval` in `elasticsearch.yml`, use the same
|
||||
value in this setting.
|
||||
|
||||
| `monitoring.ui.enabled`
|
||||
| `xpack.monitoring.ui.enabled`
|
||||
| Set to `false` to hide the Monitoring UI in {kib}. The monitoring back-end
|
||||
continues to run as an agent for sending {kib} stats to the monitoring
|
||||
cluster. Defaults to `true`.
|
||||
|
|
@ -140,14 +126,14 @@ container, then Cgroup statistics are not useful.
|
|||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `monitoring.ui.container.elasticsearch.enabled`
|
||||
| `xpack.monitoring.ui.container.elasticsearch.enabled`
|
||||
| For {es} clusters that are running in containers, this setting changes the
|
||||
*Node Listing* to display the CPU utilization based on the reported Cgroup
|
||||
statistics. It also adds the calculated Cgroup CPU utilization to the
|
||||
*Node Overview* page instead of the overall operating system's CPU
|
||||
utilization. Defaults to `false`.
|
||||
|
||||
| `monitoring.ui.container.logstash.enabled`
|
||||
| `xpack.monitoring.ui.container.logstash.enabled`
|
||||
| For {ls} nodes that are running in containers, this setting
|
||||
changes the {ls} *Node Listing* to display the CPU utilization
|
||||
based on the reported Cgroup statistics. It also adds the
|
||||
|
|
|
|||
|
|
@ -110,8 +110,6 @@ security is enabled, `xpack.security.encryptionKey`.
|
|||
| [[xpack-reporting-q-timeout]] `xpack.reporting.queue.timeout`
|
||||
| How long each worker has to produce a report. If your machine is slow or under
|
||||
heavy load, you might need to increase this timeout. Specified in milliseconds.
|
||||
If a Reporting job execution time goes over this time limit, the job will be
|
||||
marked as a failure and there will not be a download available.
|
||||
Defaults to `120000` (two minutes).
|
||||
|
||||
|===
|
||||
|
|
@ -123,30 +121,6 @@ security is enabled, `xpack.security.encryptionKey`.
|
|||
Reporting works by capturing screenshots from {kib}. The following settings
|
||||
control the capturing process.
|
||||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `xpack.reporting.capture.timeouts.openUrl`
|
||||
| How long to allow the Reporting browser to wait for the initial data of the
|
||||
{kib} page to load. Defaults to `30000` (30 seconds).
|
||||
|
||||
| `xpack.reporting.capture.timeouts.waitForElements`
|
||||
| How long to allow the Reporting browser to wait for the visualization panels to
|
||||
load on the {kib} page. Defaults to `30000` (30 seconds).
|
||||
|
||||
| `xpack.reporting.capture.timeouts.renderComplete`
|
||||
| How long to allow the Reporting browser to wait for each visualization to
|
||||
signal that it is done renderings. Defaults to `30000` (30 seconds).
|
||||
|
||||
|===
|
||||
|
||||
[NOTE]
|
||||
============
|
||||
If any timeouts from `xpack.reporting.capture.timeouts.*` settings occur when
|
||||
running a report job, Reporting will log the error and try to continue
|
||||
capturing the page with a screenshot. As a result, a download will be
|
||||
available, but there will likely be errors in the visualizations in the report.
|
||||
============
|
||||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `xpack.reporting.capture.maxAttempts`
|
||||
|
|
|
|||
|
|
@ -1,46 +0,0 @@
|
|||
[[telemetry-settings-kbn]]
|
||||
=== Telemetry settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Telemetry settings</titleabbrev>
|
||||
++++
|
||||
|
||||
By default, Usage Collection (also known as Telemetry) is enabled. This
|
||||
helps us learn about the {kib} features that our users are most interested in, so we
|
||||
can focus our efforts on making them even better.
|
||||
|
||||
You can control whether this data is sent from the {kib} servers, or if it should be sent
|
||||
from the user's browser, in case a firewall is blocking the connections from the server. Additionally, you can decide to completely disable this feature either in the config file or in {kib} via *Management > Kibana > Advanced Settings > Usage Data*.
|
||||
|
||||
See our https://www.elastic.co/legal/privacy-statement[Privacy Statement] to learn more.
|
||||
|
||||
[float]
|
||||
[[telemetry-general-settings]]
|
||||
==== General telemetry settings
|
||||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `telemetry.enabled`
|
||||
| Set to `true` to send cluster statistics to Elastic. Reporting your
|
||||
cluster statistics helps us improve your user experience. Your data is never
|
||||
shared with anyone. Set to `false` to disable statistics reporting from any
|
||||
browser connected to the {kib} instance. Defaults to `true`.
|
||||
|
||||
| `telemetry.sendUsageFrom`
|
||||
| Set to `'server'` to report the cluster statistics from the {kib} server.
|
||||
If the server fails to connect to our endpoint at https://telemetry.elastic.co/, it assumes
|
||||
it is behind a firewall and falls back to `'browser'` to send it from users' browsers
|
||||
when they are navigating through {kib}. Defaults to 'browser'.
|
||||
|
||||
| `telemetry.optIn`
|
||||
| Set to `true` to automatically opt into reporting cluster statistics. You can also opt out through
|
||||
*Advanced Settings* in {kib}. Defaults to `true`.
|
||||
|
||||
| `telemetry.allowChangingOptInStatus`
|
||||
| Set to `true` to allow overwriting the `telemetry.optIn` setting via the {kib} UI. Defaults to `true`. +
|
||||
|
||||
|===
|
||||
|
||||
[NOTE]
|
||||
============
|
||||
When `false`, `telemetry.optIn` must be `true`. To disable telemetry and not allow users to change that parameter, use `telemetry.enabled`.
|
||||
============
|
||||
|
|
@ -343,11 +343,11 @@ map.regionmap:
|
|||
[cols="2*<"]
|
||||
|===
|
||||
|
||||
| [[regionmap-ES-map]] `map.includeElasticMapsService:` {ece-icon}
|
||||
| Turns on or off whether layers from the Elastic Maps Service should be included in the vector
|
||||
layer option list. By turning this off,
|
||||
only the layers that are configured here will be included. The default is `true`.
|
||||
This also affects whether tile-service from the Elastic Maps Service will be available.
|
||||
| [[regionmap-ES-map]] `map.regionmap.includeElasticMapsService:` {ece-icon}
|
||||
| Specifies the option to include layers from the Elastic Maps Service in the vector
|
||||
layer option list. When off, only the configured layers are included.
|
||||
The default is `true`.
|
||||
This option also specifies if the tile-service from the Elastic Maps Service is available.
|
||||
|
||||
| [[regionmap-attribution]] `map.regionmap.layers[].attribution:` {ess-icon} {ece-icon}
|
||||
| Optional. References the originating source of the geojson file.
|
||||
|
|
@ -609,7 +609,7 @@ us improve your user experience. Your data is never shared with anyone. Set to
|
|||
`false` to disable telemetry capabilities entirely. You can alternatively opt
|
||||
out through *Advanced Settings*. *Default: `true`*
|
||||
|
||||
| `vis_type_vega.enableExternalUrls:` {ess-icon}
|
||||
| `vega.enableExternalUrls:` {ess-icon}
|
||||
| Set this value to true to allow Vega to use any URL to access external data
|
||||
sources and images. When false, Vega can only get data from {es}. *Default: `false`*
|
||||
|
||||
|
|
@ -625,6 +625,18 @@ Rollup UI. *Default: true*
|
|||
| Set this value to change the {kib} interface language.
|
||||
Valid locales are: `en`, `zh-CN`, `ja-JP`. *Default: `en`*
|
||||
|
||||
| `xpack.actions.enabledActionTypes:`
|
||||
| Set this value to an array of action types that are enabled. An element of `*` indicates all
|
||||
action types registered are enabled. The action types provided by {kib} are
|
||||
`.server-log`, `.slack`, `.email`, `.index`, `.pagerduty`, `.webhook`.
|
||||
*Default: +[ {asterisk} ]+*
|
||||
|
||||
| `xpack.actions.whitelistedHosts:`
|
||||
| Set this value to an array of host names, with actions such as email, slack, pagerduty, and
|
||||
webhook, can connect to. An element of `*` indicates any host can be connected.
|
||||
An empty array indicates no hosts can be connected.
|
||||
*Default: +[ {asterisk} ]+*
|
||||
|
||||
|===
|
||||
|
||||
include::{docdir}/settings/apm-settings.asciidoc[]
|
||||
|
|
@ -639,4 +651,3 @@ include::{docdir}/settings/reporting-settings.asciidoc[]
|
|||
include::secure-settings.asciidoc[]
|
||||
include::{docdir}/settings/security-settings.asciidoc[]
|
||||
include::{docdir}/settings/spaces-settings.asciidoc[]
|
||||
include::{docdir}/settings/telemetry-settings.asciidoc[]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue