Skip to content

Commit

Permalink
Merge branch '7.x' into backport/7.x/pr-64978
Browse files Browse the repository at this point in the history
  • Loading branch information
elasticmachine authored May 4, 2020
2 parents a539a0d + 4cdd065 commit 9cfc2ff
Show file tree
Hide file tree
Showing 39 changed files with 1,131 additions and 677 deletions.
39 changes: 24 additions & 15 deletions docs/settings/alert-action-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<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:
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}>>.
Expand All @@ -18,27 +18,36 @@ You can configure the following settings in the `kibana.yml` file.
[[general-alert-action-settings]]
==== General settings

`xpack.encryptedSavedObjects.encryptionKey`::
[cols="2*<"]
|===

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 &mdash; such as the username and password used to connect to an SMTP service &mdash; 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>>.
| `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 &mdash; such as the username and password used to connect to an SMTP service &mdash; 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

`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.
[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.

`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]]
Expand Down
39 changes: 27 additions & 12 deletions docs/settings/apm-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,27 +43,42 @@ If you'd like to change any of the default values,
copy and paste the relevant settings into your `kibana.yml` configuration file.
Changing these settings may disable features of the APM App.

xpack.apm.enabled:: Set to `false` to disable the APM app. Defaults to `true`.
[cols="2*<"]
|===
| `xpack.apm.enabled`
| Set to `false` to disable the APM app. Defaults to `true`.

xpack.apm.ui.enabled:: Set to `false` to hide the APM app from the menu. Defaults to `true`.
| `xpack.apm.ui.enabled`
| Set to `false` to hide the APM app from the menu. Defaults to `true`.

xpack.apm.ui.transactionGroupBucketSize:: Number of top transaction groups displayed in the APM app. Defaults to `100`.
| `xpack.apm.ui.transactionGroupBucketSize`
| Number of top transaction groups displayed in the APM app. Defaults to `100`.

xpack.apm.ui.maxTraceItems:: Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
| `xpack.apm.ui.maxTraceItems`
| Maximum number of child items displayed when viewing trace details. Defaults to `1000`.

apm_oss.indexPattern:: The index pattern used for integrations with Machine Learning and Query Bar.
It must match all apm indices. Defaults to `apm-*`.
| `apm_oss.indexPattern`
| The index pattern used for integrations with Machine Learning and Query Bar.
It must match all apm indices. Defaults to `apm-*`.

apm_oss.errorIndices:: Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
| `apm_oss.errorIndices`
| Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.

apm_oss.onboardingIndices:: Matcher for all onboarding indices. Defaults to `apm-*`.
| `apm_oss.onboardingIndices`
| Matcher for all onboarding indices. Defaults to `apm-*`.

apm_oss.spanIndices:: Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
| `apm_oss.spanIndices`
| Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.

apm_oss.transactionIndices:: Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
| `apm_oss.transactionIndices`
| Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.

apm_oss.metricsIndices:: Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
| `apm_oss.metricsIndices`
| Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.

apm_oss.sourcemapIndices:: Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.
| `apm_oss.sourcemapIndices`
| Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.

|===

// end::general-apm-settings[]
16 changes: 12 additions & 4 deletions docs/settings/dev-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,20 @@ They are enabled by default.
[[grok-settings]]
==== Grok Debugger settings

`xpack.grokdebugger.enabled`::
Set to `true` (default) to enable the <<xpack-grokdebugger,Grok Debugger>>.
[cols="2*<"]
|===
| `xpack.grokdebugger.enabled`
| Set to `true` to enable the <<xpack-grokdebugger,Grok Debugger>>. Defaults to `true`.

|===

[float]
[[profiler-settings]]
==== {searchprofiler} Settings

`xpack.searchprofiler.enabled`::
Set to `true` (default) to enable the <<xpack-profiler,{searchprofiler}>>.
[cols="2*<"]
|===
| `xpack.searchprofiler.enabled`
| Set to `true` to enable the <<xpack-profiler,{searchprofiler}>>. Defaults to `true`.

|===
31 changes: 22 additions & 9 deletions docs/settings/general-infra-logs-ui-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,30 @@
`xpack.infra.enabled`:: Set to `false` to disable the Logs and Metrics app plugin {kib}. Defaults to `true`.
[cols="2*<"]
|===
| `xpack.infra.enabled`
| Set to `false` to disable the Logs and Metrics app plugin {kib}. Defaults to `true`.

`xpack.infra.sources.default.logAlias`:: Index pattern for matching indices that contain log data. Defaults to `filebeat-*,kibana_sample_data_logs*`.
| `xpack.infra.sources.default.logAlias`
| Index pattern for matching indices that contain log data. Defaults to `filebeat-*,kibana_sample_data_logs*`. To match multiple wildcard patterns, use a comma to separate the names, with no space after the comma. For example, `logstash-app1-*,default-logs-*`.

`xpack.infra.sources.default.metricAlias`:: Index pattern for matching indices that contain Metricbeat data. Defaults to `metricbeat-*`.
| `xpack.infra.sources.default.metricAlias`
| Index pattern for matching indices that contain Metricbeat data. Defaults to `metricbeat-*`. To match multiple wildcard patterns, use a comma to separate the names, with no space after the comma. For example, `logstash-app1-*,default-logs-*`.

`xpack.infra.sources.default.fields.timestamp`:: Timestamp used to sort log entries. Defaults to `@timestamp`.
| `xpack.infra.sources.default.fields.timestamp`
| Timestamp used to sort log entries. Defaults to `@timestamp`.

`xpack.infra.sources.default.fields.message`:: Fields used to display messages in the Logs app. Defaults to `['message', '@message']`.
| `xpack.infra.sources.default.fields.message`
| Fields used to display messages in the Logs app. Defaults to `['message', '@message']`.

`xpack.infra.sources.default.fields.tiebreaker`:: Field used to break ties between two entries with the same timestamp. Defaults to `_doc`.
| `xpack.infra.sources.default.fields.tiebreaker`
| Field used to break ties between two entries with the same timestamp. Defaults to `_doc`.

`xpack.infra.sources.default.fields.host`:: Field used to identify hosts. Defaults to `host.name`.
| `xpack.infra.sources.default.fields.host`
| Field used to identify hosts. Defaults to `host.name`.

`xpack.infra.sources.default.fields.container`:: Field used to identify Docker containers. Defaults to `container.id`.
| `xpack.infra.sources.default.fields.container`
| Field used to identify Docker containers. Defaults to `container.id`.

`xpack.infra.sources.default.fields.pod`:: Field used to identify Kubernetes pods. Defaults to `kubernetes.pod.uid`.
| `xpack.infra.sources.default.fields.pod`
| Field used to identify Kubernetes pods. Defaults to `kubernetes.pod.uid`.

|===
9 changes: 7 additions & 2 deletions docs/settings/graph-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,10 @@ You do not need to configure any settings to use the {graph-features}.
[float]
[[general-graph-settings]]
==== General graph settings
`xpack.graph.enabled`::
Set to `false` to disable the {graph-features}.

[cols="2*<"]
|===
| `xpack.graph.enabled`
| Set to `false` to disable the {graph-features}.

|===
11 changes: 4 additions & 7 deletions docs/settings/i18n-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@ You do not need to configure any settings to run Kibana in English.
==== General i18n Settings

`i18n.locale`::
Kibana currently supports the following locales:
+
- English - `en` (default)
- Chinese - `zh-CN`
- Japanese - `ja-JP`


{kib} supports the following locales:
* English - `en` (default)
* Chinese - `zh-CN`
* Japanese - `ja-JP`
27 changes: 20 additions & 7 deletions docs/settings/ml-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,25 @@ enabled by default.
[[general-ml-settings-kb]]
==== General {ml} settings

`xpack.ml.enabled`::
Set to `true` (default) to enable {kib} {ml-features}. +
+
If set to `false` in `kibana.yml`, the {ml} icon is hidden in this {kib}
instance. If `xpack.ml.enabled` is set to `true` in `elasticsearch.yml`, however,
you can still use the {ml} APIs. To disable {ml} entirely, see the
{ref}/ml-settings.html[{es} {ml} settings].
[cols="2*<"]
|===
| `xpack.ml.enabled`
| Set to `true` (default) to enable {kib} {ml-features}. +
+
If set to `false` in `kibana.yml`, the {ml} icon is hidden in this {kib}
instance. If `xpack.ml.enabled` is set to `true` in `elasticsearch.yml`, however,
you can still use the {ml} APIs. To disable {ml} entirely, see the
{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`.

|===
Loading

0 comments on commit 9cfc2ff

Please sign in to comment.