mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
Lisa Cawley
GitHub
parent
2f7e46e569
commit
8bd46e6f5b
18 changed files with 81 additions and 85 deletions
|
|
@ -28,8 +28,6 @@ include::monitoring/configuring-monitoring.asciidoc[]
|
|||
|
||||
include::security/securing-kibana.asciidoc[]
|
||||
|
||||
include::settings/settings-xkb.asciidoc[]
|
||||
|
||||
include::getting-started.asciidoc[]
|
||||
|
||||
include::discover.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -20,4 +20,3 @@ To learn about monitoring in general, see
|
|||
include::monitoring-kibana.asciidoc[]
|
||||
include::monitoring-metricbeat.asciidoc[]
|
||||
include::viewing-metrics.asciidoc[]
|
||||
include::{kib-repo-dir}/settings/monitoring-settings.asciidoc[]
|
||||
|
|
@ -12,3 +12,10 @@ The following pages have moved or been deleted.
|
|||
|
||||
See <<monitoring-kibana>>.
|
||||
|
||||
|
||||
[role="exclude",id="settings-xpack-kb"]
|
||||
== {xpack} Settings in {kib}
|
||||
|
||||
include::{asciidoc-dir}/../../shared/settings.asciidoc[]
|
||||
|
||||
For more {kib} configuration settings, see <<settings>>.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
[role="xpack"]
|
||||
[[using-kibana-with-security]]
|
||||
== Configuring Security in {kib}
|
||||
== Configuring security in {kib}
|
||||
++++
|
||||
<titleabbrev>Configuring Security</titleabbrev>
|
||||
<titleabbrev>Configuring security</titleabbrev>
|
||||
++++
|
||||
|
||||
{kib} users have to log in when {security} is enabled on your cluster. You
|
||||
|
|
@ -126,4 +126,3 @@ NOTE: This must be a user who has been assigned the `kibana_user` role.
|
|||
include::authentication/index.asciidoc[]
|
||||
include::securing-communications/index.asciidoc[]
|
||||
include::audit-logging.asciidoc[]
|
||||
include::{kib-repo-dir}/settings/security-settings.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
[role="xpack"]
|
||||
[[apm-settings-kb]]
|
||||
=== APM Settings in Kibana
|
||||
=== APM settings in Kibana
|
||||
++++
|
||||
<titleabbrev>APM Settings</titleabbrev>
|
||||
<titleabbrev>APM settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You do not need to configure any settings to use APM. It is enabled by default.
|
||||
|
|
@ -11,7 +11,7 @@ copy and paste the relevant settings below into your `kibana.yml` configuration
|
|||
|
||||
[float]
|
||||
[[general-apm-settings-kb]]
|
||||
==== General APM Settings
|
||||
==== General APM settings
|
||||
|
||||
xpack.apm.enabled:: Set to `false` to disabled the APM plugin {kib}. Defaults to
|
||||
`true`.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
[role="xpack"]
|
||||
[[dev-settings-kb]]
|
||||
=== Development Tools Settings in Kibana
|
||||
=== Development tools settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Development Tools Settings</titleabbrev>
|
||||
<titleabbrev>Development tools settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You do not need to configure any settings to use the development tools in {kib}.
|
||||
|
|
@ -10,7 +10,7 @@ They are enabled by default.
|
|||
|
||||
[float]
|
||||
[[grok-settings]]
|
||||
==== Grok Debugger Settings
|
||||
==== Grok Debugger settings
|
||||
|
||||
`xpack.grokdebugger.enabled`::
|
||||
Set to `true` (default) to enable the <<xpack-grokdebugger,Grok Debugger>>.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
[role="xpack"]
|
||||
[[graph-settings-kb]]
|
||||
=== Graph Settings in Kibana
|
||||
=== Graph settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Graph Settings</titleabbrev>
|
||||
<titleabbrev>Graph settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You do not need to configure any settings to use {graph}.
|
||||
You do not need to configure any settings to use the {graph-features}.
|
||||
|
||||
[float]
|
||||
[[general-graph-settings]]
|
||||
==== General Graph Settings
|
||||
==== General graph settings
|
||||
`xpack.graph.enabled`::
|
||||
Set to `false` to disable {graph}.
|
||||
Set to `false` to disable the {graph-features}.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
[role="xpack"]
|
||||
[[infrastructure-ui-settings-kb]]
|
||||
=== Infrastructure UI Settings in Kibana
|
||||
=== Infrastructure UI settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Infrastructure UI Settings</titleabbrev>
|
||||
<titleabbrev>Infrastructure UI settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You do not need to configure any settings to use the Infrastructure UI. It is enabled by default.
|
||||
|
||||
[float]
|
||||
[[general-infra-ui-settings-kb]]
|
||||
==== General Infrastructure UI Settings
|
||||
==== General Infrastructure UI settings
|
||||
|
||||
include::general-infra-logs-ui-settings.asciidoc[]
|
||||
|
|
@ -1,14 +1,14 @@
|
|||
[role="xpack"]
|
||||
[[logs-ui-settings-kb]]
|
||||
=== Logs UI Settings in Kibana
|
||||
=== Logs UI settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Logs UI Settings</titleabbrev>
|
||||
<titleabbrev>Logs UI settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You do not need to configure any settings to use the Logs UI. It is enabled by default.
|
||||
|
||||
[float]
|
||||
[[general-logs-ui-settings-kb]]
|
||||
==== General Logs UI Settings
|
||||
==== General Logs UI settings
|
||||
|
||||
include::general-infra-logs-ui-settings.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,20 +1,21 @@
|
|||
[role="xpack"]
|
||||
[[ml-settings-kb]]
|
||||
=== Machine Learning Settings in Kibana
|
||||
=== Machine learning settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Machine Learning Settings</titleabbrev>
|
||||
<titleabbrev>Machine learning settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You do not need to configure any settings to use {ml}. It is enabled by default.
|
||||
You do not need to configure any settings to use {kib} {ml-features}. They are
|
||||
enabled by default.
|
||||
|
||||
[float]
|
||||
[[general-ml-settings-kb]]
|
||||
==== General Machine Learning Settings
|
||||
==== General {ml} settings
|
||||
|
||||
`xpack.ml.enabled`::
|
||||
Set to `true` (default) to enable {ml}. +
|
||||
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} Machine Learning Settings].
|
||||
{ref}/ml-settings.html[{es} {ml} settings].
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
[role="xpack"]
|
||||
[[monitoring-settings-kb]]
|
||||
=== Monitoring Settings in Kibana
|
||||
=== Monitoring settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Monitoring Settings</titleabbrev>
|
||||
<titleabbrev>Monitoring settings</titleabbrev>
|
||||
++++
|
||||
|
||||
By default, the Monitoring application is enabled, but data collection
|
||||
|
|
@ -25,14 +25,14 @@ from Logstash, you configure
|
|||
in `logstash.yml`.
|
||||
|
||||
For more information, see
|
||||
{xpack-ref}/xpack-monitoring.html[Monitoring the Elastic Stack].
|
||||
{stack-ov}/xpack-monitoring.html[Monitoring the Elastic Stack].
|
||||
|
||||
[float]
|
||||
[[monitoring-general-settings]]
|
||||
==== General Monitoring Settings
|
||||
==== General monitoring settings
|
||||
|
||||
`xpack.monitoring.enabled`::
|
||||
Set to `true` (default) to enable {monitoring} in {kib}. Unlike the
|
||||
Set to `true` (default) to enable the {monitor-features} in {kib}. Unlike the
|
||||
`xpack.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.
|
||||
|
|
@ -68,7 +68,7 @@ which has a default value of `30000`.
|
|||
|
||||
[float]
|
||||
[[monitoring-collection-settings]]
|
||||
==== Monitoring Collection Settings
|
||||
==== Monitoring collection settings
|
||||
|
||||
These settings control how data is collected from {kib}.
|
||||
|
||||
|
|
@ -84,7 +84,7 @@ Defaults to `10000` (10 seconds).
|
|||
|
||||
[float]
|
||||
[[monitoring-ui-settings]]
|
||||
==== Monitoring UI Settings
|
||||
==== Monitoring UI settings
|
||||
|
||||
These settings adjust how the {kib} Monitoring page displays monitoring data.
|
||||
However, the defaults work best in most circumstances. For more information
|
||||
|
|
@ -111,7 +111,7 @@ value in this setting.
|
|||
|
||||
[float]
|
||||
[[monitoring-ui-cgroup-settings]]
|
||||
===== Monitoring UI Container Settings
|
||||
===== Monitoring UI container settings
|
||||
|
||||
The Monitoring UI exposes the Cgroup statistics that we collect for you to make
|
||||
better decisions about your container performance, rather than guessing based on
|
||||
|
|
|
|||
|
|
@ -1,21 +1,21 @@
|
|||
[role="xpack"]
|
||||
[[reporting-settings-kb]]
|
||||
=== {reporting} settings in Kibana
|
||||
=== Reporting settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Reporting Settings</titleabbrev>
|
||||
<titleabbrev>Reporting settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You can configure `xpack.reporting` settings in your `kibana.yml` to:
|
||||
|
||||
* <<reporting-kibana-server-settings,Control how {reporting} communicates with the {kib} server>>
|
||||
* <<reporting-kibana-server-settings,Control how the {report-features} communicate with the {kib} server>>
|
||||
* <<reporting-job-queue-settings,Manage background jobs>>
|
||||
* <<reporting-capture-settings,Capture screenshots>>
|
||||
|
||||
[float]
|
||||
[[general-reporting-settings]]
|
||||
==== General Reporting Settings
|
||||
==== General reporting settings
|
||||
[[xpack-enable-reporting]]`xpack.reporting.enabled`::
|
||||
Set to `false` to disable {reporting}.
|
||||
Set to `false` to disable the {report-features}.
|
||||
|
||||
`xpack.reporting.encryptionKey`::
|
||||
Set to any text string. By default, Kibana will generate a random key when it
|
||||
|
|
@ -24,7 +24,7 @@ setting to preserve the same key across multiple restarts and multiple instances
|
|||
|
||||
[float]
|
||||
[[reporting-kibana-server-settings]]
|
||||
==== Kibana Server Settings
|
||||
==== Kibana server settings
|
||||
|
||||
Reporting uses the Kibana interface to generate reports. In most cases, you don't need
|
||||
to configure Reporting to communicate with Kibana. However, if you use a reverse-proxy
|
||||
|
|
@ -44,7 +44,7 @@ proxy host requires that the Kibana server has network access to the proxy.
|
|||
|
||||
[float]
|
||||
[[reporting-job-queue-settings]]
|
||||
==== Background Job Settings
|
||||
==== Background job settings
|
||||
|
||||
Reporting generates reports in the background and jobs are coordinated using documents
|
||||
in Elasticsearch. Depending on how often you generate reports and the overall number of
|
||||
|
|
@ -78,7 +78,7 @@ Defaults to `120000` (two minutes).
|
|||
|
||||
[float]
|
||||
[[reporting-capture-settings]]
|
||||
==== Capture Settings
|
||||
==== Capture settings
|
||||
|
||||
Reporting works by capturing screenshots from Kibana. The following settings
|
||||
control the capturing process.
|
||||
|
|
@ -96,7 +96,7 @@ backward compatibility. The only valid option is `chromium`.
|
|||
|
||||
[float]
|
||||
[[reporting-chromium-settings]]
|
||||
==== Chromium Settings
|
||||
==== Chromium settings
|
||||
|
||||
When `xpack.reporting.capture.browser.type` is set to `chromium` (default) you can also specify the following settings.
|
||||
|
||||
|
|
@ -120,7 +120,7 @@ Examples of valid entries are "elastic.co", "*.elastic.co", ".elastic.co", ".ela
|
|||
|
||||
[float]
|
||||
[[reporting-csv-settings]]
|
||||
==== CSV Settings
|
||||
==== CSV settings
|
||||
[[xpack-reporting-csv]]`xpack.reporting.csv.maxSizeBytes`::
|
||||
The maximum size of a CSV file before being truncated. This setting exists to prevent
|
||||
large exports from causing performance and storage issues.
|
||||
|
|
@ -128,7 +128,7 @@ Defaults to `10485760` (10mB)
|
|||
|
||||
[float]
|
||||
[[reporting-advanced-settings]]
|
||||
==== Advanced Settings
|
||||
==== Advanced settings
|
||||
|
||||
`xpack.reporting.index`::
|
||||
Reporting uses a weekly index in Elasticsearch to store the reporting job and
|
||||
|
|
|
|||
|
|
@ -1,21 +1,22 @@
|
|||
[role="xpack"]
|
||||
[[security-settings-kb]]
|
||||
=== Security Settings in Kibana
|
||||
=== Security settings in Kibana
|
||||
++++
|
||||
<titleabbrev>Security Settings</titleabbrev>
|
||||
<titleabbrev>Security settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You do not need to configure any additional settings to use {security} in {kib}.
|
||||
It is enabled by default.
|
||||
You do not need to configure any additional settings to use the
|
||||
{security-features} in {kib}. They are enabled by default.
|
||||
|
||||
[float]
|
||||
[[general-security-settings]]
|
||||
==== General Security Settings
|
||||
==== General security settings
|
||||
|
||||
`xpack.security.enabled`::
|
||||
Set to `true` (default) to enable {security}. +
|
||||
Set to `true` (default) to enable {security-features}. +
|
||||
+
|
||||
Do not set this to `false`. To disable {security} entirely, see
|
||||
{ref}/security-settings.html[{es} Security Settings]. +
|
||||
Do not set this to `false`. To disable {security-features} entirely, see
|
||||
{ref}/security-settings.html[{es} security settings]. +
|
||||
+
|
||||
If set to `false` in `kibana.yml`, the login form, user and role management screens, and
|
||||
authorization using <<kibana-privileges>> are disabled. +
|
||||
|
|
@ -30,7 +31,7 @@ for more details.
|
|||
|
||||
[float]
|
||||
[[security-ui-settings]]
|
||||
==== User Interface Security Settings
|
||||
==== User interface security settings
|
||||
|
||||
You can configure the following settings in the `kibana.yml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,19 +0,0 @@
|
|||
[role="xpack"]
|
||||
[[settings-xpack-kb]]
|
||||
== {xpack} Settings in {kib}
|
||||
++++
|
||||
<titleabbrev>{xpack} Settings</titleabbrev>
|
||||
++++
|
||||
|
||||
include::{asciidoc-dir}/../../shared/settings.asciidoc[]
|
||||
|
||||
For more {kib} configuration settings, see <<settings>>.
|
||||
|
||||
include::apm-settings.asciidoc[]
|
||||
include::dev-settings.asciidoc[]
|
||||
include::graph-settings.asciidoc[]
|
||||
include::infrastructure-ui-settings.asciidoc[]
|
||||
include::logs-ui-settings.asciidoc[]
|
||||
include::ml-settings.asciidoc[]
|
||||
include::reporting-settings.asciidoc[]
|
||||
include::spaces-settings.asciidoc[]
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
[float]
|
||||
=== {component} TLS/SSL Settings
|
||||
=== {component} TLS/SSL settings
|
||||
You can configure the following TLS/SSL settings. If the settings are not
|
||||
configured, the default values are used. See
|
||||
{stack-ov}/security-settings.html[Default TLS/SSL Settings].
|
||||
|
|
@ -40,7 +40,7 @@ Java Cryptography Architecture documentation]. Defaults to the value of
|
|||
`xpack.ssl.cipher_suites`.
|
||||
|
||||
[float]
|
||||
==== {component} TLS/SSL Key and Trusted Certificate Settings
|
||||
==== {component} TLS/SSL key and trusted certificate settings
|
||||
|
||||
The following settings are used to specify a private key, certificate, and the
|
||||
trusted certificates that should be used when communicating over an SSL/TLS connection.
|
||||
|
|
@ -58,7 +58,7 @@ If none of the settings below are specified, the defaults values are used.
|
|||
See {stack-ov}/security-settings.html[Default TLS/SSL settings].
|
||||
|
||||
[float]
|
||||
===== PEM Encoded Files
|
||||
===== PEM encoded files
|
||||
|
||||
When using PEM encoded files, use the following settings:
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ that will be presented when requested.
|
|||
List of paths to the PEM encoded certificate files that should be trusted.
|
||||
|
||||
[float]
|
||||
===== Java Keystore Files
|
||||
===== Java keystore files
|
||||
|
||||
When using Java keystore files (JKS), which contain the private key, certificate
|
||||
and certificates that should be trusted, use the following settings:
|
||||
|
|
|
|||
|
|
@ -52,8 +52,6 @@ include::setup/start-stop.asciidoc[]
|
|||
|
||||
include::setup/settings.asciidoc[]
|
||||
|
||||
include::setup/secure-settings.asciidoc[]
|
||||
|
||||
include::setup/docker.asciidoc[]
|
||||
|
||||
include::setup/access.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[secure-settings]]
|
||||
=== Secure Settings
|
||||
=== Secure settings
|
||||
|
||||
Some settings are sensitive, and relying on filesystem permissions to protect
|
||||
their values is not sufficient. For this use case, Kibana provides a
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ The default settings configure Kibana to run
|
|||
on `localhost:5601`. To change the host or port number, or connect to Elasticsearch running on a different machine,
|
||||
you'll need to update your `kibana.yml` file. You can also enable SSL and set a variety of other options. Finally, environment variables can be injected into configuration using `${MY_ENV_VAR}` syntax.
|
||||
|
||||
.Kibana Configuration Settings
|
||||
.Kibana configuration settings
|
||||
|
||||
`console.enabled:`:: *Default: true* Set to false to disable Console. Toggling this will cause the server to regenerate assets on the next startup, which may cause a delay before pages start being served.
|
||||
|
||||
|
|
@ -181,4 +181,16 @@ unauthenticated users to access the Kibana server status API and status page.
|
|||
|
||||
`xpack.rollup.enabled:`:: *Default: true* Set this value to false to disable the Rollup user interface.
|
||||
|
||||
`xpack.license_management.enabled`:: *Default: true* Set this value to false to disable the License Management user interface.
|
||||
`xpack.license_management.enabled`:: *Default: true* Set this value to false to disable the License Management user interface.
|
||||
|
||||
include::{docdir}/settings/apm-settings.asciidoc[]
|
||||
include::{docdir}/settings/dev-settings.asciidoc[]
|
||||
include::{docdir}/settings/graph-settings.asciidoc[]
|
||||
include::{docdir}/settings/infrastructure-ui-settings.asciidoc[]
|
||||
include::{docdir}/settings/logs-ui-settings.asciidoc[]
|
||||
include::{docdir}/settings/ml-settings.asciidoc[]
|
||||
include::{docdir}/settings/monitoring-settings.asciidoc[]
|
||||
include::{docdir}/settings/reporting-settings.asciidoc[]
|
||||
include::secure-settings.asciidoc[]
|
||||
include::{docdir}/settings/security-settings.asciidoc[]
|
||||
include::{docdir}/settings/spaces-settings.asciidoc[]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue