mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[DOCS] Edits titles in Setup section for consistency (#68451)
* [DOCS] Fixes titles in Setup section for consistency * [DOCS] Fixes to titles and orders of docs in Set up
This commit is contained in:
gchaps
GitHub
parent
de62abbd4e
commit
56ed61e303
41 changed files with 255 additions and 256 deletions
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[alert-action-settings-kb]]
|
||||
=== Alerting and action settings in Kibana
|
||||
=== Alerting and action settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Alerting and action settings</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ It is enabled by default.
|
|||
|
||||
[float]
|
||||
[[apm-indices-settings-kb]]
|
||||
==== APM Indices
|
||||
==== APM indices
|
||||
|
||||
// This content is reused in the APM app documentation.
|
||||
// Any changes made in this file will be seen there as well.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[dev-settings-kb]]
|
||||
=== Development tools settings in Kibana
|
||||
=== Development tools settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Development tools settings</titleabbrev>
|
||||
++++
|
||||
|
|
@ -21,7 +21,7 @@ They are enabled by default.
|
|||
|
||||
[float]
|
||||
[[profiler-settings]]
|
||||
==== {searchprofiler} Settings
|
||||
==== {searchprofiler} settings
|
||||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[graph-settings-kb]]
|
||||
=== Graph settings in Kibana
|
||||
=== Graph settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Graph settings</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -1,12 +1,15 @@
|
|||
[role="xpack"]
|
||||
[[i18n-settings-kb]]
|
||||
=== i18n settings in Kibana
|
||||
=== i18n settings in {kib}
|
||||
++++
|
||||
<titleabbrev>i18n settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You do not need to configure any settings to run Kibana in English.
|
||||
|
||||
[float]
|
||||
[[general-i18n-settings-kb]]
|
||||
==== General i18n Settings
|
||||
==== General i18n settings
|
||||
|
||||
`i18n.locale`::
|
||||
{kib} supports the following locales:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[infrastructure-ui-settings-kb]]
|
||||
=== Metrics settings in Kibana
|
||||
=== Metrics settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Metrics settings</titleabbrev>
|
||||
++++
|
||||
|
|
@ -11,4 +11,4 @@ You do not need to configure any settings to use the Metrics app in {kib}. It is
|
|||
[[general-infra-ui-settings-kb]]
|
||||
==== General Metrics settings
|
||||
|
||||
include::general-infra-logs-ui-settings.asciidoc[]
|
||||
include::general-infra-logs-ui-settings.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[logs-ui-settings-kb]]
|
||||
=== Logs app settings in Kibana
|
||||
=== Logs settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Logs settings</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
[role="xpack"]
|
||||
[[ml-settings-kb]]
|
||||
=== Machine learning settings in Kibana
|
||||
=== Machine learning settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Machine learning settings</titleabbrev>
|
||||
++++
|
||||
|
||||
You do not need to configure any settings to use {kib} {ml-features}. They are
|
||||
enabled by default.
|
||||
enabled by default.
|
||||
|
||||
[[general-ml-settings-kb]]
|
||||
==== General {ml} settings
|
||||
|
|
@ -26,4 +26,4 @@ enabled by default.
|
|||
[[advanced-ml-settings-kb]]
|
||||
==== Advanced {ml} settings
|
||||
|
||||
Refer to <<kibana-ml-settings,Advanced {ml} settings in {kib}>>.
|
||||
Refer to <<kibana-ml-settings,Advanced {ml} settings in {kib}>>.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[monitoring-settings-kb]]
|
||||
=== Monitoring settings in Kibana
|
||||
=== Monitoring settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Monitoring settings</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[reporting-settings-kb]]
|
||||
=== Reporting settings in Kibana
|
||||
=== Reporting settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Reporting settings</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[security-settings-kb]]
|
||||
=== Security settings in Kibana
|
||||
=== Security settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Security settings</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[settings-xpack-kb]]
|
||||
== {xpack} Settings in {kib}
|
||||
== {xpack} settings in {kib}
|
||||
[subs="attributes"]
|
||||
++++
|
||||
<titleabbrev>{xpack} Settings</titleabbrev>
|
||||
<titleabbrev>{xpack} settings</titleabbrev>
|
||||
++++
|
||||
|
||||
include::{asciidoc-dir}/../../shared/settings.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[telemetry-settings-kbn]]
|
||||
=== Telemetry settings in Kibana
|
||||
=== Telemetry settings in {kib}
|
||||
++++
|
||||
<titleabbrev>Telemetry settings</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[access]]
|
||||
== Accessing Kibana
|
||||
== Access {kib}
|
||||
|
||||
Kibana is a web application that you access through port 5601. All you need to do is point your web browser at the
|
||||
machine where Kibana is running and specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com:5601`.
|
||||
|
|
@ -13,7 +13,7 @@ If you still don't see any results, it's possible that you don't *have* any docu
|
|||
|
||||
[float]
|
||||
[[status]]
|
||||
=== Checking Kibana Status
|
||||
=== Check {kib} status
|
||||
|
||||
You can reach the Kibana server's status page by navigating to the status endpoint, for example, `localhost:5601/status`. The status page displays
|
||||
information about the server's resource usage and lists the installed plugins.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[connect-to-elasticsearch]]
|
||||
== Adding data
|
||||
== Add data to {kib}
|
||||
|
||||
To start working with your data in {kib}, you can:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[docker]]
|
||||
== Running Kibana on Docker
|
||||
=== Install Kibana with Docker
|
||||
Docker images for Kibana are available from the Elastic Docker registry. The
|
||||
base image is https://hub.docker.com/_/centos/[centos:7].
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ Elastic license levels.
|
|||
|
||||
[float]
|
||||
[[pull-image]]
|
||||
=== Pulling the image
|
||||
=== Pull the image
|
||||
|
||||
Obtaining Kibana for Docker is as simple as issuing a +docker pull+ command
|
||||
against the Elastic Docker registry.
|
||||
|
|
@ -40,7 +40,7 @@ available under the Apache 2.0 license. To download the images, go to
|
|||
https://www.docker.elastic.co[www.docker.elastic.co].
|
||||
|
||||
[float]
|
||||
=== Running Kibana on Docker for development
|
||||
=== Run Kibana on Docker for development
|
||||
Kibana can be quickly started and connected to a local Elasticsearch container for development
|
||||
or testing use with the following command:
|
||||
--------------------------------------------
|
||||
|
|
@ -50,7 +50,7 @@ endif::[]
|
|||
|
||||
[float]
|
||||
[[configuring-kibana-docker]]
|
||||
=== Configuring Kibana on Docker
|
||||
=== Configure Kibana on Docker
|
||||
|
||||
The Docker images provide several methods for configuring Kibana. The
|
||||
conventional approach is to provide a `kibana.yml` file as described in
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
[[install]]
|
||||
== Installing Kibana
|
||||
== Install {kib}
|
||||
|
||||
[float]
|
||||
=== Hosted Kibana
|
||||
=== Hosted {kib}
|
||||
|
||||
If you are running our hosted Elasticsearch Service on Elastic Cloud, you access Kibana with a single click. (You can {ess-trial}[sign up for a free trial] and start exploring data in minutes.)
|
||||
|
||||
[float]
|
||||
=== Installing Kibana Yourself
|
||||
=== Install {kib} yourself
|
||||
|
||||
NOTE: Starting with version 6.0.0, Kibana only supports 64 bit operating systems.
|
||||
|
||||
|
|
@ -59,10 +59,12 @@ additional setup instructions.
|
|||
|
||||
include::install/targz.asciidoc[]
|
||||
|
||||
include::install/windows.asciidoc[]
|
||||
|
||||
include::install/deb.asciidoc[]
|
||||
|
||||
include::install/rpm.asciidoc[]
|
||||
|
||||
include::install/windows.asciidoc[]
|
||||
include::{kib-repo-dir}/setup/docker.asciidoc[]
|
||||
|
||||
include::install/brew.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
==== Running Kibana with `brew services`
|
||||
==== Run {kib} with `brew services`
|
||||
|
||||
With Homebrew, Kibana can be started and stopped as follows:
|
||||
With Homebrew, Kibana can be started and stopped as follows:
|
||||
|
||||
[source,sh]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
==== Running Kibana with SysV `init`
|
||||
==== Run {kib} with SysV `init`
|
||||
|
||||
Use the `update-rc.d` command to configure Kibana to start automatically
|
||||
when the system boots up:
|
||||
|
|
@ -18,4 +18,3 @@ sudo -i service kibana stop
|
|||
|
||||
If Kibana fails to start for any reason, it will print the reason for
|
||||
failure to `STDOUT`. Log files can be found in `/var/log/kibana/`.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
[[deb]]
|
||||
=== Install Kibana with Debian Package
|
||||
=== Install {kib} with Debian package
|
||||
|
||||
The Debian package for Kibana can be <<install-deb,downloaded from our website>>
|
||||
or from our <<deb-repo,APT repository>>. It can be used to install
|
||||
Kibana on any Debian-based system such as Debian and Ubuntu.
|
||||
|
||||
This package is free to use under the Elastic license. It contains open source
|
||||
and free commercial features and access to paid commercial features.
|
||||
{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the
|
||||
paid commercial features. See the
|
||||
https://www.elastic.co/subscriptions[Subscriptions] page for information about
|
||||
This package is free to use under the Elastic license. It contains open source
|
||||
and free commercial features and access to paid commercial features.
|
||||
{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the
|
||||
paid commercial features. See the
|
||||
https://www.elastic.co/subscriptions[Subscriptions] page for information about
|
||||
Elastic license levels.
|
||||
|
||||
The latest stable version of Kibana can be found on the
|
||||
|
|
@ -17,7 +17,7 @@ link:/downloads/kibana[Download Kibana] page. Other versions can
|
|||
be found on the link:/downloads/past-releases[Past Releases page].
|
||||
|
||||
[[deb-key]]
|
||||
==== Import the Elastic PGP Key
|
||||
==== Import the Elastic PGP key
|
||||
|
||||
include::key.asciidoc[]
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add
|
|||
-------------------------
|
||||
|
||||
[[deb-repo]]
|
||||
==== Installing from the APT repository
|
||||
==== Install from the APT repository
|
||||
|
||||
ifeval::["{release-state}"=="unreleased"]
|
||||
|
||||
|
|
@ -151,9 +151,9 @@ sudo dpkg -i kibana-{version}-amd64.deb
|
|||
<1> Compare the SHA produced by `shasum` with the
|
||||
https://artifacts.elastic.co/downloads/kibana/kibana-{version}-amd64.deb.sha512[published SHA].
|
||||
|
||||
Alternatively, you can download the following package, which contains only
|
||||
features that are available under the Apache 2.0 license:
|
||||
https://artifacts.elastic.co/downloads/kibana/kibana-oss-{version}-amd64.deb
|
||||
Alternatively, you can download the following package, which contains only
|
||||
features that are available under the Apache 2.0 license:
|
||||
https://artifacts.elastic.co/downloads/kibana/kibana-oss-{version}-amd64.deb
|
||||
|
||||
endif::[]
|
||||
|
||||
|
|
@ -169,7 +169,7 @@ include::deb-init.asciidoc[]
|
|||
include::systemd.asciidoc[]
|
||||
|
||||
[[deb-configuring]]
|
||||
==== Configuring Kibana via config file
|
||||
==== Configure {kib} via the config file
|
||||
|
||||
Kibana loads its configuration from the `/etc/kibana/kibana.yml`
|
||||
file by default. The format of this config file is explained in
|
||||
|
|
@ -205,7 +205,7 @@ locations for a Debian-based system:
|
|||
| The location of the data files written to disk by Kibana and its plugins
|
||||
| /var/lib/kibana
|
||||
| path.data
|
||||
|
||||
|
||||
| logs
|
||||
| Logs files location
|
||||
| /var/log/kibana
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
==== Running Kibana with SysV `init`
|
||||
==== Run {kib} with SysV `init`
|
||||
|
||||
Use the `chkconfig` command to configure Kibana to start automatically
|
||||
when the system boots up:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[rpm]]
|
||||
=== Install Kibana with RPM
|
||||
=== Install {kib} with RPM
|
||||
|
||||
The RPM for Kibana can be <<install-rpm,downloaded from our website>>
|
||||
or from our <<rpm-repo,RPM repository>>. It can be used to install
|
||||
|
|
@ -9,11 +9,11 @@ and Oracle Enterprise.
|
|||
NOTE: RPM install is not supported on distributions with old versions of RPM,
|
||||
such as SLES 11 and CentOS 5. Please see <<targz>> instead.
|
||||
|
||||
This package is free to use under the Elastic license. It contains open source
|
||||
and free commercial features and access to paid commercial features.
|
||||
{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the
|
||||
paid commercial features. See the
|
||||
https://www.elastic.co/subscriptions[Subscriptions] page for information about
|
||||
This package is free to use under the Elastic license. It contains open source
|
||||
and free commercial features and access to paid commercial features.
|
||||
{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the
|
||||
paid commercial features. See the
|
||||
https://www.elastic.co/subscriptions[Subscriptions] page for information about
|
||||
Elastic license levels.
|
||||
|
||||
The latest stable version of Kibana can be found on the
|
||||
|
|
@ -21,7 +21,7 @@ link:/downloads/kibana[Download Kibana] page. Other versions can
|
|||
be found on the link:/downloads/past-releases[Past Releases page].
|
||||
|
||||
[[rpm-key]]
|
||||
==== Import the Elastic PGP Key
|
||||
==== Import the Elastic PGP key
|
||||
|
||||
include::key.asciidoc[]
|
||||
|
||||
|
|
@ -143,9 +143,9 @@ sudo rpm --install kibana-{version}-x86_64.rpm
|
|||
<1> Compare the SHA produced by `shasum` with the
|
||||
https://artifacts.elastic.co/downloads/kibana/kibana-{version}-x86_64.rpm.sha512[published SHA].
|
||||
|
||||
Alternatively, you can download the following package, which contains only
|
||||
Alternatively, you can download the following package, which contains only
|
||||
features that are available under the Apache 2.0 license:
|
||||
https://artifacts.elastic.co/downloads/kibana/kibana-oss-{version}-x86_64.rpm
|
||||
https://artifacts.elastic.co/downloads/kibana/kibana-oss-{version}-x86_64.rpm
|
||||
|
||||
endif::[]
|
||||
|
||||
|
|
@ -160,7 +160,7 @@ include::rpm-init.asciidoc[]
|
|||
include::systemd.asciidoc[]
|
||||
|
||||
[[rpm-configuring]]
|
||||
==== Configuring Kibana via config file
|
||||
==== Configure {kib} via the config file
|
||||
|
||||
Kibana loads its configuration from the `/etc/kibana/kibana.yml`
|
||||
file by default. The format of this config file is explained in
|
||||
|
|
@ -196,7 +196,7 @@ locations for an RPM-based system:
|
|||
| The location of the data files written to disk by Kibana and its plugins
|
||||
| /var/lib/kibana
|
||||
| path.data
|
||||
|
||||
|
||||
| logs
|
||||
| Logs files location
|
||||
| /var/log/kibana
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
==== Running Kibana with `systemd`
|
||||
==== Run {kib} with `systemd`
|
||||
|
||||
To configure Kibana to start automatically when the system boots up,
|
||||
run the following commands:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
==== Running Kibana from the command line
|
||||
==== Run {kib} from the command line
|
||||
|
||||
Kibana can be started from the command line as follows:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[targz]]
|
||||
=== Install {kib} from archive on Linux or MacOS
|
||||
=== Install {kib} from archive on Linux or macOS
|
||||
|
||||
Kibana is provided for Linux and Darwin as a `.tar.gz` package. These packages
|
||||
are the easiest formats to use when trying out Kibana.
|
||||
|
|
@ -101,7 +101,7 @@ include::targz-running.asciidoc[]
|
|||
|
||||
|
||||
[[targz-configuring]]
|
||||
==== Configuring Kibana via config file
|
||||
==== Configure {kib} via the config file
|
||||
|
||||
Kibana loads its configuration from the `$KIBANA_HOME/config/kibana.yml`
|
||||
file by default. The format of this config file is explained in
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
==== Running Kibana from the command line
|
||||
==== Run {kib} from the command line
|
||||
|
||||
Kibana can be started from the command line as follows:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
[[windows]]
|
||||
=== Install Kibana on Windows
|
||||
=== Install {kib} on Windows
|
||||
|
||||
Kibana can be installed on Windows using the `.zip` package.
|
||||
|
||||
This package is free to use under the Elastic license. It contains open source
|
||||
and free commercial features and access to paid commercial features.
|
||||
{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the
|
||||
paid commercial features. See the
|
||||
https://www.elastic.co/subscriptions[Subscriptions] page for information about
|
||||
This package is free to use under the Elastic license. It contains open source
|
||||
and free commercial features and access to paid commercial features.
|
||||
{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the
|
||||
paid commercial features. See the
|
||||
https://www.elastic.co/subscriptions[Subscriptions] page for information about
|
||||
Elastic license levels.
|
||||
|
||||
The latest stable version of Kibana can be found on the
|
||||
|
|
@ -39,9 +39,9 @@ terminal window, `CD` to the `$KIBANA_HOME` directory, for instance:
|
|||
CD c:\kibana-{version}-windows-x86_64
|
||||
----------------------------
|
||||
|
||||
Alternatively, you can download the following package, which contains only
|
||||
Alternatively, you can download the following package, which contains only
|
||||
features that are available under the Apache 2.0 license:
|
||||
https://artifacts.elastic.co/downloads/kibana/kibana-oss-{version}-windows-x86_64.zip
|
||||
https://artifacts.elastic.co/downloads/kibana/kibana-oss-{version}-windows-x86_64.zip
|
||||
|
||||
endif::[]
|
||||
|
||||
|
|
@ -49,7 +49,7 @@ endif::[]
|
|||
include::windows-running.asciidoc[]
|
||||
|
||||
[[windows-configuring]]
|
||||
==== Configuring Kibana via config file
|
||||
==== Configure {kib} via the config file
|
||||
|
||||
Kibana loads its configuration from the `$KIBANA_HOME/config/kibana.yml`
|
||||
file by default. The format of this config file is explained in
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[production]]
|
||||
== Using Kibana in a production environment
|
||||
== Use {kib} in a production environment
|
||||
|
||||
* <<configuring-kibana-shield>>
|
||||
* <<csp-strict-mode>>
|
||||
|
|
@ -23,7 +23,7 @@ and an Elasticsearch client node on the same machine. For more information, see
|
|||
|
||||
[float]
|
||||
[[configuring-kibana-shield]]
|
||||
=== Using {stack} {security-features}
|
||||
=== Use {stack} {security-features}
|
||||
|
||||
You can use {stack} {security-features} to control what {es} data users can
|
||||
access through Kibana.
|
||||
|
|
@ -59,13 +59,13 @@ csp.strict: true
|
|||
|
||||
[float]
|
||||
[[enabling-ssl]]
|
||||
=== Enabling SSL
|
||||
=== Enable SSL
|
||||
|
||||
See <<configuring-tls>>.
|
||||
|
||||
[float]
|
||||
[[load-balancing-es]]
|
||||
=== Load Balancing Across Multiple Elasticsearch Nodes
|
||||
=== Load Balancing across multiple {es} nodes
|
||||
If you have multiple nodes in your Elasticsearch cluster, the easiest way to distribute Kibana requests
|
||||
across the nodes is to run an Elasticsearch _Coordinating only_ node on the same machine as Kibana.
|
||||
Elasticsearch Coordinating only nodes are essentially smart load balancers that are part of the cluster. They
|
||||
|
|
@ -145,7 +145,7 @@ bin/kibana -c config/instance2.yml
|
|||
|
||||
[float]
|
||||
[[high-availability]]
|
||||
=== High availability across multiple Elasticsearch nodes
|
||||
=== High availability across multiple {es} nodes
|
||||
Kibana can be configured to connect to multiple Elasticsearch nodes in the same cluster. In situations where a node becomes unavailable,
|
||||
Kibana will transparently connect to an available node and continue operating. Requests to available hosts will be routed in a round robin fashion.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ NOTE: All commands here should be run as the user which will run Kibana.
|
|||
|
||||
[float]
|
||||
[[creating-keystore]]
|
||||
=== Creating the keystore
|
||||
=== Create the keystore
|
||||
|
||||
To create the `kibana.keystore`, use the `create` command:
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ The file `kibana.keystore` will be created in the directory defined by the
|
|||
|
||||
[float]
|
||||
[[list-settings]]
|
||||
=== Listing settings in the keystore
|
||||
=== List settings in the keystore
|
||||
|
||||
A list of the settings in the keystore is available with the `list` command:
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ bin/kibana-keystore list
|
|||
|
||||
[float]
|
||||
[[add-string-to-keystore]]
|
||||
=== Adding string settings
|
||||
=== Add string settings
|
||||
|
||||
Sensitive string settings, like authentication credentials for Elasticsearch
|
||||
can be added using the `add` command:
|
||||
|
|
@ -65,7 +65,7 @@ cat /file/containing/setting/value | bin/kibana-keystore add the.setting.name.to
|
|||
|
||||
[float]
|
||||
[[remove-settings]]
|
||||
=== Removing settings
|
||||
=== Remove settings
|
||||
|
||||
To remove a setting from the keystore, use the `remove` command:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[settings]]
|
||||
== Configuring {kib}
|
||||
== Configure {kib}
|
||||
|
||||
The {kib} server reads properties from the `kibana.yml` file on startup. The
|
||||
location of this file differs depending on how you installed {kib}. For example,
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
[[start-stop]]
|
||||
== Starting and stopping Kibana
|
||||
== Start and stop {kib}
|
||||
|
||||
The method for starting and stopping {kib} varies depending on how you installed
|
||||
it.
|
||||
The method for starting and stopping {kib} varies depending on how you installed
|
||||
it.
|
||||
|
||||
[float]
|
||||
[[start-start-targz]]
|
||||
=== Archive packages (`.tar.gz`)
|
||||
|
||||
If you installed {kib} on Linux or Darwin with a `.tar.gz` package, you can
|
||||
start and stop {kib} from the command line.
|
||||
If you installed {kib} on Linux or Darwin with a `.tar.gz` package, you can
|
||||
start and stop {kib} from the command line.
|
||||
|
||||
[float]
|
||||
include::install/targz-running.asciidoc[]
|
||||
|
|
@ -18,8 +18,8 @@ include::install/targz-running.asciidoc[]
|
|||
[[start-stop-zip]]
|
||||
=== Archive packages (`.zip`)
|
||||
|
||||
If you installed {kib} on Windows with a `.zip` package, you can
|
||||
stop and start {kib} from the command line.
|
||||
If you installed {kib} on Windows with a `.zip` package, you can
|
||||
stop and start {kib} from the command line.
|
||||
|
||||
[float]
|
||||
include::install/windows-running.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
[[upgrade]]
|
||||
== Upgrading {kib}
|
||||
== Upgrade {kib}
|
||||
|
||||
Depending on the {kib} version you're upgrading from, the upgrade process to 7.0
|
||||
varies.
|
||||
varies.
|
||||
|
||||
NOTE: {kib} upgrades automatically when starting a new version, as described in
|
||||
NOTE: {kib} upgrades automatically when starting a new version, as described in
|
||||
<<upgrade-migrations, this document>>.
|
||||
Although you do not need to manually back up {kib} before upgrading, we recommend
|
||||
that you have a backup on hand. You can use
|
||||
that you have a backup on hand. You can use
|
||||
<<snapshot-repositories, Snapshot and Restore>> to back up {kib}
|
||||
data by targeting `.kibana*` indices. If you are using the Reporting plugin,
|
||||
data by targeting `.kibana*` indices. If you are using the Reporting plugin,
|
||||
you can also target `.reporting*` indices.
|
||||
|
||||
[float]
|
||||
|
|
@ -23,44 +23,44 @@ Before you upgrade {kib}:
|
|||
* Back up your data with {es} {ref}/modules-snapshots.html[snapshots].
|
||||
To roll back to an earlier version, you **must** have a backup of your data.
|
||||
* If you are using custom plugins, check that a compatible version is
|
||||
available.
|
||||
* Shut down all {kib} nodes. Running more than one {kib} version against the
|
||||
same Elasticseach index is unsupported. If you upgrade while older {kib} nodes are
|
||||
available.
|
||||
* Shut down all {kib} nodes. Running more than one {kib} version against the
|
||||
same Elasticseach index is unsupported. If you upgrade while older {kib} nodes are
|
||||
running, the upgrade can fail.
|
||||
|
||||
To identify the changes you need to make to upgrade, and to enable you to
|
||||
perform an Elasticsearch rolling upgrade with no downtime, you must upgrade to
|
||||
To identify the changes you need to make to upgrade, and to enable you to
|
||||
perform an Elasticsearch rolling upgrade with no downtime, you must upgrade to
|
||||
6.7 before you upgrade to 7.0.
|
||||
|
||||
For a comprehensive overview of the upgrade process, refer to
|
||||
For a comprehensive overview of the upgrade process, refer to
|
||||
*{stack-ref}/upgrading-elastic-stack.html[Upgrading the Elastic Stack]*.
|
||||
|
||||
[float]
|
||||
[[upgrade-5x-earlier]]
|
||||
=== Upgrading from 5.x or earlier
|
||||
{es} can read indices created in the previous major version. Before you upgrade
|
||||
to 7.0.0, you must reindex or delete any indices created in 5.x or earlier.
|
||||
For more information, refer to
|
||||
=== Upgrade from 5.x or earlier
|
||||
{es} can read indices created in the previous major version. Before you upgrade
|
||||
to 7.0.0, you must reindex or delete any indices created in 5.x or earlier.
|
||||
For more information, refer to
|
||||
{stack-ref}/upgrading-elastic-stack.html#oss-stack-upgrade[Upgrading the Elastic Stack].
|
||||
|
||||
When your reindex is complete, follow the <<upgrade-standard, Standard upgrade>>
|
||||
instructions.
|
||||
When your reindex is complete, follow the <<upgrade-standard, Standard upgrade>>
|
||||
instructions.
|
||||
|
||||
[float]
|
||||
[[upgrade-6x]]
|
||||
=== Upgrading from 6.x
|
||||
=== Upgrade from 6.x
|
||||
|
||||
The recommended path is to upgrade to 6.8 before upgrading to 7.0. This makes it
|
||||
easier to identify the required changes, and enables you to use the Upgrade
|
||||
The recommended path is to upgrade to 6.8 before upgrading to 7.0. This makes it
|
||||
easier to identify the required changes, and enables you to use the Upgrade
|
||||
Assistant to prepare for your upgrade to 7.0.
|
||||
|
||||
TIP: The ability to import {kib} 6.x saved searches, visualizations, and
|
||||
TIP: The ability to import {kib} 6.x saved searches, visualizations, and
|
||||
dashboards is supported.
|
||||
|
||||
[float]
|
||||
[[upgrade-67]]
|
||||
=== Upgrading from 6.8
|
||||
To help you prepare for your upgrade to 7.0, 6.8 includes an https://www.elastic.co/guide/en/kibana/6.8/upgrade-assistant.html[Upgrade Assistant]
|
||||
=== Upgrade from 6.8
|
||||
To help you prepare for your upgrade to 7.0, 6.8 includes an https://www.elastic.co/guide/en/kibana/6.8/upgrade-assistant.html[Upgrade Assistant]
|
||||
To access the assistant, go to *Management > 7.0 Upgrade Assistant*.
|
||||
|
||||
After you have addressed any issues that were identified by the Upgrade
|
||||
|
|
@ -70,4 +70,3 @@ Assistant, <<upgrade-standard,upgrade to 7.0>>.
|
|||
include::upgrade/upgrade-standard.asciidoc[]
|
||||
|
||||
include::upgrade/upgrade-migrations.asciidoc[]
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
[[upgrade-migrations]]
|
||||
=== Troubleshooting saved object migrations
|
||||
=== Migrate saved objects
|
||||
|
||||
Every time {kib} is upgraded it checks to see if all saved objects, such as dashboards, visualizations, and index patterns, are compatible with the new version. If any objects need to be updated, then the automatic saved object migration process is kicked off.
|
||||
|
||||
NOTE: 6.7 includes an https://www.elastic.co/guide/en/kibana/6.7/upgrade-assistant.html[Upgrade Assistant]
|
||||
to help you prepare for your upgrade to 7.0. To access the assistant, go to *Management > 7.0 Upgrade Assistant*.
|
||||
NOTE: 6.7 includes an https://www.elastic.co/guide/en/kibana/6.7/upgrade-assistant.html[Upgrade Assistant]
|
||||
to help you prepare for your upgrade to 7.0. To access the assistant, go to *Management > 7.0 Upgrade Assistant*.
|
||||
|
||||
[float]
|
||||
[[upgrade-migrations-process]]
|
||||
|
|
@ -46,11 +46,9 @@ The first instance that triggers saved object migrations will run the entire pro
|
|||
[[upgrade-migrations-rolling-back]]
|
||||
==== Rolling back to a previous version of {kib}
|
||||
|
||||
When rolling {kib} back to a previous version, point the `.kibana` alias to
|
||||
the appropriate {kib} index. When you have the previous version running again,
|
||||
delete the more recent `.kibana_N` index or indices so that future upgrades are
|
||||
When rolling {kib} back to a previous version, point the `.kibana` alias to
|
||||
the appropriate {kib} index. When you have the previous version running again,
|
||||
delete the more recent `.kibana_N` index or indices so that future upgrades are
|
||||
based on the current {kib} index. You must restart {kib} to re-trigger the migration.
|
||||
|
||||
WARNING: Rolling back to a previous {kib} version can result in saved object data loss if you had successfully upgraded and made changes to saved objects before rolling back.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
[[upgrade-standard]]
|
||||
=== Standard upgrade
|
||||
|
||||
NOTE: 6.7 includes an https://www.elastic.co/guide/en/kibana/6.7/upgrade-assistant.html[Upgrade Assistant]
|
||||
to help you prepare for your upgrade to 7.0. To access the assistant, go to *Management > 7.0 Upgrade Assistant*.
|
||||
NOTE: 6.7 includes an https://www.elastic.co/guide/en/kibana/6.7/upgrade-assistant.html[Upgrade Assistant]
|
||||
to help you prepare for your upgrade to 7.0. To access the assistant, go to *Management > 7.0 Upgrade Assistant*.
|
||||
|
||||
[IMPORTANT]
|
||||
===========================================
|
||||
|
|
@ -13,7 +13,7 @@ necessary remediation steps as per those instructions.
|
|||
===========================================
|
||||
|
||||
[float]
|
||||
==== Upgrading using a `deb` or `rpm` package
|
||||
==== Upgrade using a `deb` or `rpm` package
|
||||
|
||||
. Stop the existing {kib} process using the appropriate command for your
|
||||
system.
|
||||
|
|
@ -37,7 +37,7 @@ otherwise {kib} will fail to start.
|
|||
. Start the new {kib} process using the appropriate command for your system.
|
||||
|
||||
[float]
|
||||
==== Upgrading using a `zip` or `tar.gz` archive
|
||||
==== Upgrade using a `zip` or `tar.gz` archive
|
||||
|
||||
. Extract the `zip` or `tar.gz` archive to a new directory to be sure that you
|
||||
don't overwrite the `config` or `data` directories. +
|
||||
|
|
|
|||
|
|
@ -1,20 +1,20 @@
|
|||
[role="xpack"]
|
||||
[[configuring-monitoring]]
|
||||
== Configuring monitoring in {kib}
|
||||
== Configure monitoring in {kib}
|
||||
++++
|
||||
<titleabbrev>Configuring monitoring</titleabbrev>
|
||||
<titleabbrev>Configure monitoring</titleabbrev>
|
||||
++++
|
||||
|
||||
If you enable the {monitor-features} in your cluster, there are two methods to
|
||||
If you enable the {monitor-features} in your cluster, there are two methods to
|
||||
collect metrics about {kib}:
|
||||
|
||||
* <<monitoring-metricbeat,{metricbeat} collection methods>>
|
||||
* <<monitoring-kibana,Legacy collection methods>>
|
||||
|
||||
You can also use {kib} to
|
||||
You can also use {kib} to
|
||||
<<monitoring-data,visualize monitoring data from across the {stack}>>.
|
||||
|
||||
To learn about monitoring in general, see
|
||||
To learn about monitoring in general, see
|
||||
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
|
||||
|
||||
include::monitoring-metricbeat.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,45 +1,45 @@
|
|||
[role="xpack"]
|
||||
[[monitoring-kibana]]
|
||||
=== Collecting monitoring data using legacy collectors
|
||||
=== Collect monitoring data using legacy collectors
|
||||
++++
|
||||
<titleabbrev>Legacy collection methods</titleabbrev>
|
||||
++++
|
||||
|
||||
If you enable the Elastic {monitor-features} in your cluster, you can
|
||||
optionally collect metrics about {kib}.
|
||||
If you enable the Elastic {monitor-features} in your cluster, you can
|
||||
optionally collect metrics about {kib}.
|
||||
|
||||
The following method involves sending the metrics to the production cluster,
|
||||
which ultimately routes them to the monitoring cluster. For the recommended
|
||||
method, see <<monitoring-metricbeat>>.
|
||||
The following method involves sending the metrics to the production cluster,
|
||||
which ultimately routes them to the monitoring cluster. For the recommended
|
||||
method, see <<monitoring-metricbeat>>.
|
||||
|
||||
To learn about monitoring in general, see
|
||||
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
|
||||
To learn about monitoring in general, see
|
||||
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
|
||||
|
||||
. Set the `xpack.monitoring.collection.enabled` setting to `true` on each
|
||||
node in the production cluster. By default, it is is disabled (`false`).
|
||||
+
|
||||
node in the production cluster. By default, it is is disabled (`false`).
|
||||
+
|
||||
--
|
||||
NOTE: You can specify this setting in either the `elasticsearch.yml` on each
|
||||
node or across the cluster as a dynamic cluster setting. If {es}
|
||||
{security-features} are enabled, you must have `monitor` cluster privileges to
|
||||
NOTE: You can specify this setting in either the `elasticsearch.yml` on each
|
||||
node or across the cluster as a dynamic cluster setting. If {es}
|
||||
{security-features} are enabled, you must have `monitor` cluster privileges to
|
||||
view the cluster settings and `manage` cluster privileges to change them.
|
||||
|
||||
--
|
||||
|
||||
** To update the cluster settings in {kib}:
|
||||
|
||||
... Open {kib} in your web browser.
|
||||
... Open {kib} in your web browser.
|
||||
+
|
||||
--
|
||||
By default, if you are running {kib} locally, go to `http://localhost:5601/`.
|
||||
By default, if you are running {kib} locally, go to `http://localhost:5601/`.
|
||||
|
||||
If {es} {security-features} are enabled, log in.
|
||||
If {es} {security-features} are enabled, log in.
|
||||
--
|
||||
|
||||
... In the side navigation, click *Stack Monitoring*. If data collection is
|
||||
disabled, you are prompted to turn it on.
|
||||
disabled, you are prompted to turn it on.
|
||||
|
||||
** From the Console or command line, set `xpack.monitoring.collection.enabled`
|
||||
** From the Console or command line, set `xpack.monitoring.collection.enabled`
|
||||
to `true` on the production cluster. +
|
||||
+
|
||||
--
|
||||
|
|
@ -57,13 +57,13 @@ PUT _cluster/settings
|
|||
}
|
||||
----------------------------------
|
||||
|
||||
For more information, see {ref}/monitoring-settings.html[Monitoring settings in {es}]
|
||||
For more information, see {ref}/monitoring-settings.html[Monitoring settings in {es}]
|
||||
and {ref}/cluster-update-settings.html[Cluster update settings].
|
||||
--
|
||||
|
||||
. Verify that `monitoring.enabled` and
|
||||
`monitoring.kibana.collection.enabled` are set to `true` in the
|
||||
`kibana.yml` file. These are the default values. For
|
||||
`monitoring.kibana.collection.enabled` are set to `true` in the
|
||||
`kibana.yml` file. These are the default values. For
|
||||
more information, see <<monitoring-settings-kb,Monitoring settings in {kib}>>.
|
||||
|
||||
. Identify where to send monitoring data. {kib} automatically
|
||||
|
|
@ -72,13 +72,13 @@ in the `kibana.yml` file. This property has a default value of
|
|||
`http://localhost:9200`. +
|
||||
+
|
||||
--
|
||||
[TIP]
|
||||
[TIP]
|
||||
===============================
|
||||
In production environments, we strongly recommend using a separate cluster
|
||||
(referred to as the _monitoring cluster_) to store the data. Using a separate
|
||||
monitoring cluster prevents production cluster outages from impacting your
|
||||
ability to access your monitoring data. It also prevents monitoring activities
|
||||
from impacting the performance of your production cluster.
|
||||
In production environments, we strongly recommend using a separate cluster
|
||||
(referred to as the _monitoring cluster_) to store the data. Using a separate
|
||||
monitoring cluster prevents production cluster outages from impacting your
|
||||
ability to access your monitoring data. It also prevents monitoring activities
|
||||
from impacting the performance of your production cluster.
|
||||
|
||||
If {security} is enabled on the production cluster, use an HTTPS URL such
|
||||
as `https://<your_production_cluster>:9200` in this setting.
|
||||
|
|
@ -97,4 +97,4 @@ used when {kib} sends monitoring data to the production cluster.
|
|||
|
||||
. <<start-stop,Start {kib}>>.
|
||||
|
||||
. <<monitoring-data,View the monitoring data in {kib}>>.
|
||||
. <<monitoring-data,View the monitoring data in {kib}>>.
|
||||
|
|
|
|||
|
|
@ -1,19 +1,19 @@
|
|||
[role="xpack"]
|
||||
[[monitoring-metricbeat]]
|
||||
=== Collecting {kib} monitoring data with {metricbeat}
|
||||
=== Collect {kib} monitoring data with {metricbeat}
|
||||
[subs="attributes"]
|
||||
++++
|
||||
<titleabbrev>Collecting monitoring data with {metricbeat}</titleabbrev>
|
||||
<titleabbrev>Collect monitoring data with {metricbeat}</titleabbrev>
|
||||
++++
|
||||
|
||||
In 6.4 and later, you can use {metricbeat} to collect data about {kib}
|
||||
and ship it to the monitoring cluster, rather than routing it through the
|
||||
production cluster as described in <<monitoring-kibana>>.
|
||||
In 6.4 and later, you can use {metricbeat} to collect data about {kib}
|
||||
and ship it to the monitoring cluster, rather than routing it through the
|
||||
production cluster as described in <<monitoring-kibana>>.
|
||||
|
||||
image::user/monitoring/images/metricbeat.png[Example monitoring architecture]
|
||||
|
||||
To learn about monitoring in general, see
|
||||
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
|
||||
To learn about monitoring in general, see
|
||||
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
|
||||
|
||||
//NOTE: The tagged regions are re-used in the Stack Overview.
|
||||
|
||||
|
|
@ -21,46 +21,46 @@ To learn about monitoring in general, see
|
|||
+
|
||||
--
|
||||
// tag::disable-kibana-collection[]
|
||||
Add the following setting in the {kib} configuration file (`kibana.yml`):
|
||||
Add the following setting in the {kib} configuration file (`kibana.yml`):
|
||||
|
||||
[source,yaml]
|
||||
----------------------------------
|
||||
monitoring.kibana.collection.enabled: false
|
||||
----------------------------------
|
||||
|
||||
Leave the `monitoring.enabled` set to its default value (`true`).
|
||||
Leave the `monitoring.enabled` set to its default value (`true`).
|
||||
// end::disable-kibana-collection[]
|
||||
For more information, see
|
||||
For more information, see
|
||||
<<monitoring-settings-kb,Monitoring settings in {kib}>>.
|
||||
--
|
||||
|
||||
. <<start-stop,Start {kib}>>.
|
||||
|
||||
. Set the `xpack.monitoring.collection.enabled` setting to `true` on
|
||||
. Set the `xpack.monitoring.collection.enabled` setting to `true` on
|
||||
each node in the production cluster. By default, it is disabled (`false`).
|
||||
+
|
||||
--
|
||||
NOTE: You can specify this setting in either the `elasticsearch.yml` on each
|
||||
node or across the cluster as a dynamic cluster setting. If {es}
|
||||
{security-features} are enabled, you must have `monitor` cluster privileges to
|
||||
NOTE: You can specify this setting in either the `elasticsearch.yml` on each
|
||||
node or across the cluster as a dynamic cluster setting. If {es}
|
||||
{security-features} are enabled, you must have `monitor` cluster privileges to
|
||||
view the cluster settings and `manage` cluster privileges to change them.
|
||||
|
||||
--
|
||||
|
||||
** In {kib}:
|
||||
|
||||
... Open {kib} in your web browser.
|
||||
... Open {kib} in your web browser.
|
||||
+
|
||||
--
|
||||
If you are running {kib} locally, go to `http://localhost:5601/`.
|
||||
If you are running {kib} locally, go to `http://localhost:5601/`.
|
||||
|
||||
If the Elastic {security-features} are enabled, log in.
|
||||
If the Elastic {security-features} are enabled, log in.
|
||||
--
|
||||
|
||||
... In the side navigation, click *Stack Monitoring*. If data collection is
|
||||
disabled, you are prompted to turn it on.
|
||||
disabled, you are prompted to turn it on.
|
||||
|
||||
** From the Console or command line, set `xpack.monitoring.collection.enabled`
|
||||
** From the Console or command line, set `xpack.monitoring.collection.enabled`
|
||||
to `true` on the production cluster. +
|
||||
+
|
||||
--
|
||||
|
|
@ -78,7 +78,7 @@ PUT _cluster/settings
|
|||
}
|
||||
----------------------------------
|
||||
|
||||
For more information, see {ref}/monitoring-settings.html[Monitoring settings in {es}]
|
||||
For more information, see {ref}/monitoring-settings.html[Monitoring settings in {es}]
|
||||
and {ref}/cluster-update-settings.html[Cluster update settings].
|
||||
--
|
||||
|
||||
|
|
@ -89,7 +89,7 @@ same server as {kib}.
|
|||
+
|
||||
--
|
||||
// tag::enable-kibana-module[]
|
||||
For example, to enable the default configuration in the `modules.d` directory,
|
||||
For example, to enable the default configuration in the `modules.d` directory,
|
||||
run the following command:
|
||||
|
||||
["source","sh",subs="attributes,callouts"]
|
||||
|
|
@ -97,9 +97,9 @@ run the following command:
|
|||
metricbeat modules enable kibana-xpack
|
||||
----------------------------------------------------------------------
|
||||
|
||||
For more information, see
|
||||
{metricbeat-ref}/configuration-metricbeat.html[Specify which modules to run] and
|
||||
{metricbeat-ref}/metricbeat-module-kibana.html[{kib} module].
|
||||
For more information, see
|
||||
{metricbeat-ref}/configuration-metricbeat.html[Specify which modules to run] and
|
||||
{metricbeat-ref}/metricbeat-module-kibana.html[{kib} module].
|
||||
// end::enable-kibana-module[]
|
||||
--
|
||||
|
||||
|
|
@ -130,15 +130,15 @@ access it via HTTPS. For example, use a `hosts` setting like
|
|||
// end::configure-kibana-module[]
|
||||
|
||||
// tag::remote-monitoring-user[]
|
||||
If the Elastic {security-features} are enabled, you must also provide a user
|
||||
ID and password so that {metricbeat} can collect metrics successfully:
|
||||
If the Elastic {security-features} are enabled, you must also provide a user
|
||||
ID and password so that {metricbeat} can collect metrics successfully:
|
||||
|
||||
.. Create a user on the production cluster that has the
|
||||
`remote_monitoring_collector` {ref}/built-in-roles.html[built-in role].
|
||||
Alternatively, use the `remote_monitoring_user`
|
||||
.. Create a user on the production cluster that has the
|
||||
`remote_monitoring_collector` {ref}/built-in-roles.html[built-in role].
|
||||
Alternatively, use the `remote_monitoring_user`
|
||||
{ref}/built-in-users.html[built-in user].
|
||||
|
||||
.. Add the `username` and `password` settings to the {kib} module configuration
|
||||
.. Add the `username` and `password` settings to the {kib} module configuration
|
||||
file.
|
||||
// end::remote-monitoring-user[]
|
||||
--
|
||||
|
|
@ -156,19 +156,19 @@ the following command:
|
|||
----------------------------------------------------------------------
|
||||
metricbeat modules disable system
|
||||
----------------------------------------------------------------------
|
||||
// end::disable-system-module[]
|
||||
// end::disable-system-module[]
|
||||
--
|
||||
|
||||
. Identify where to send the monitoring data. +
|
||||
+
|
||||
--
|
||||
TIP: In production environments, we strongly recommend using a separate cluster
|
||||
(referred to as the _monitoring cluster_) to store the data. Using a separate
|
||||
monitoring cluster prevents production cluster outages from impacting your
|
||||
ability to access your monitoring data. It also prevents monitoring activities
|
||||
TIP: In production environments, we strongly recommend using a separate cluster
|
||||
(referred to as the _monitoring cluster_) to store the data. Using a separate
|
||||
monitoring cluster prevents production cluster outages from impacting your
|
||||
ability to access your monitoring data. It also prevents monitoring activities
|
||||
from impacting the performance of your production cluster.
|
||||
|
||||
For example, specify the {es} output information in the {metricbeat}
|
||||
For example, specify the {es} output information in the {metricbeat}
|
||||
configuration file (`metricbeat.yml`):
|
||||
|
||||
[source,yaml]
|
||||
|
|
@ -176,13 +176,13 @@ configuration file (`metricbeat.yml`):
|
|||
output.elasticsearch:
|
||||
# Array of hosts to connect to.
|
||||
hosts: ["http://es-mon-1:9200", "http://es-mon2:9200"] <1>
|
||||
|
||||
|
||||
# Optional protocol and basic auth credentials.
|
||||
#protocol: "https"
|
||||
#username: "elastic"
|
||||
#password: "changeme"
|
||||
----------------------------------
|
||||
<1> In this example, the data is stored on a monitoring cluster with nodes
|
||||
<1> In this example, the data is stored on a monitoring cluster with nodes
|
||||
`es-mon-1` and `es-mon-2`.
|
||||
|
||||
If you configured the monitoring cluster to use encrypted communications, you
|
||||
|
|
@ -192,22 +192,22 @@ must access it via HTTPS. For example, use a `hosts` setting like
|
|||
IMPORTANT: The {es} {monitor-features} use ingest pipelines, therefore the
|
||||
cluster that stores the monitoring data must have at least one ingest node.
|
||||
|
||||
If the {es} {security-features} are enabled on the monitoring cluster, you
|
||||
must provide a valid user ID and password so that {metricbeat} can send metrics
|
||||
successfully:
|
||||
If the {es} {security-features} are enabled on the monitoring cluster, you
|
||||
must provide a valid user ID and password so that {metricbeat} can send metrics
|
||||
successfully:
|
||||
|
||||
.. Create a user on the monitoring cluster that has the
|
||||
`remote_monitoring_agent` {ref}/built-in-roles.html[built-in role].
|
||||
Alternatively, use the `remote_monitoring_user`
|
||||
.. Create a user on the monitoring cluster that has the
|
||||
`remote_monitoring_agent` {ref}/built-in-roles.html[built-in role].
|
||||
Alternatively, use the `remote_monitoring_user`
|
||||
{ref}/built-in-users.html[built-in user].
|
||||
|
||||
.. Add the `username` and `password` settings to the {es} output information in
|
||||
.. Add the `username` and `password` settings to the {es} output information in
|
||||
the {metricbeat} configuration file.
|
||||
|
||||
For more information about these configuration options, see
|
||||
For more information about these configuration options, see
|
||||
{metricbeat-ref}/elasticsearch-output.html[Configure the {es} output].
|
||||
--
|
||||
|
||||
. {metricbeat-ref}/metricbeat-starting.html[Start {metricbeat}].
|
||||
. {metricbeat-ref}/metricbeat-starting.html[Start {metricbeat}].
|
||||
|
||||
. <<monitoring-data,View the monitoring data in {kib}>>.
|
||||
. <<monitoring-data,View the monitoring data in {kib}>>.
|
||||
|
|
|
|||
|
|
@ -1,96 +1,96 @@
|
|||
[role="xpack"]
|
||||
[[monitoring-data]]
|
||||
=== Viewing monitoring data in {kib}
|
||||
=== View monitoring data in {kib}
|
||||
++++
|
||||
<titleabbrev>Viewing monitoring data</titleabbrev>
|
||||
<titleabbrev>View monitoring data</titleabbrev>
|
||||
++++
|
||||
|
||||
After you collect monitoring data for one or more products in the {stack}, you
|
||||
can configure {kib} to retrieve that information and display it in on the
|
||||
After you collect monitoring data for one or more products in the {stack}, you
|
||||
can configure {kib} to retrieve that information and display it in on the
|
||||
*Stack Monitoring* page.
|
||||
|
||||
At a minimum, you must have monitoring data for the {es} production cluster.
|
||||
Once that data exists, {kib} can display monitoring data for other products in
|
||||
the cluster.
|
||||
|
||||
. Identify where to retrieve monitoring data from.
|
||||
. Identify where to retrieve monitoring data from.
|
||||
+
|
||||
--
|
||||
The cluster that contains the monitoring data is referred to
|
||||
as the _monitoring cluster_.
|
||||
The cluster that contains the monitoring data is referred to
|
||||
as the _monitoring cluster_.
|
||||
|
||||
TIP: If the monitoring data is stored on a *dedicated* monitoring cluster, it is
|
||||
accessible even when the cluster you're monitoring is not. If you have at least
|
||||
a gold license, you can send data from multiple clusters to the same monitoring
|
||||
cluster and view them all through the same instance of {kib}.
|
||||
TIP: If the monitoring data is stored on a *dedicated* monitoring cluster, it is
|
||||
accessible even when the cluster you're monitoring is not. If you have at least
|
||||
a gold license, you can send data from multiple clusters to the same monitoring
|
||||
cluster and view them all through the same instance of {kib}.
|
||||
|
||||
By default, data is retrieved from the cluster specified in the
|
||||
By default, data is retrieved from the cluster specified in the
|
||||
`elasticsearch.hosts` value in the `kibana.yml` file. If you want to retrieve it
|
||||
from a different cluster, set `monitoring.ui.elasticsearch.hosts`.
|
||||
|
||||
To learn more about typical monitoring architectures,
|
||||
see {ref}/how-monitoring-works.html[How monitoring works] and
|
||||
To learn more about typical monitoring architectures,
|
||||
see {ref}/how-monitoring-works.html[How monitoring works] and
|
||||
{ref}/monitoring-production.html[Monitoring in a production environment].
|
||||
--
|
||||
|
||||
. Verify that `monitoring.ui.enabled` is set to `true`, which is the
|
||||
default value, in the `kibana.yml` file. For more information, see
|
||||
default value, in the `kibana.yml` file. For more information, see
|
||||
<<monitoring-settings-kb>>.
|
||||
|
||||
. If the Elastic {security-features} are enabled on the monitoring cluster, you
|
||||
must provide a user ID and password so {kib} can retrieve the data.
|
||||
. If the Elastic {security-features} are enabled on the monitoring cluster, you
|
||||
must provide a user ID and password so {kib} can retrieve the data.
|
||||
|
||||
.. Create a user that has the `monitoring_user`
|
||||
.. Create a user that has the `monitoring_user`
|
||||
{ref}/built-in-roles.html[built-in role] on the monitoring cluster.
|
||||
|
||||
.. Add the `monitoring.ui.elasticsearch.username` and
|
||||
.. Add the `monitoring.ui.elasticsearch.username` and
|
||||
`monitoring.ui.elasticsearch.password` settings in the `kibana.yml` file.
|
||||
If these settings are omitted, {kib} uses the `elasticsearch.username` and
|
||||
`elasticsearch.password` setting values. For more
|
||||
`elasticsearch.password` setting values. For more
|
||||
information, see {kibana-ref}/using-kibana-with-security.html[Configuring security in {kib}].
|
||||
|
||||
. (Optional) Configure {kib} to encrypt communications between the {kib} server
|
||||
and the monitoring cluster. See <<configuring-tls>>.
|
||||
. (Optional) Configure {kib} to encrypt communications between the {kib} server
|
||||
and the monitoring cluster. See <<configuring-tls>>.
|
||||
|
||||
. If the Elastic {security-features} are enabled on the {kib} server, only users
|
||||
that have the authority to access {kib} indices and to read the monitoring indices
|
||||
can use the monitoring dashboards.
|
||||
. If the Elastic {security-features} are enabled on the {kib} server, only users
|
||||
that have the authority to access {kib} indices and to read the monitoring indices
|
||||
can use the monitoring dashboards.
|
||||
+
|
||||
--
|
||||
NOTE: These users must exist on the monitoring cluster. If you are accessing a
|
||||
remote monitoring cluster, you must use credentials that are valid on both the
|
||||
NOTE: These users must exist on the monitoring cluster. If you are accessing a
|
||||
remote monitoring cluster, you must use credentials that are valid on both the
|
||||
{kib} server and the monitoring cluster.
|
||||
|
||||
--
|
||||
|
||||
.. Create users that have the `monitoring_user` and `kibana_admin`
|
||||
.. Create users that have the `monitoring_user` and `kibana_admin`
|
||||
{ref}/built-in-roles.html[built-in roles].
|
||||
|
||||
. Open {kib} in your web browser.
|
||||
. Open {kib} in your web browser.
|
||||
+
|
||||
--
|
||||
By default, if you are running {kib} locally, go to `http://localhost:5601/`.
|
||||
By default, if you are running {kib} locally, go to `http://localhost:5601/`.
|
||||
|
||||
If the Elastic {security-features} are enabled, log in.
|
||||
If the Elastic {security-features} are enabled, log in.
|
||||
--
|
||||
|
||||
. In the side navigation, click *Stack Monitoring*.
|
||||
. In the side navigation, click *Stack Monitoring*.
|
||||
+
|
||||
--
|
||||
If data collection is disabled, you are prompted to turn on data collection.
|
||||
If {es} {security-features} are enabled, you must have `manage` cluster
|
||||
privileges to turn on data collection.
|
||||
If data collection is disabled, you are prompted to turn on data collection.
|
||||
If {es} {security-features} are enabled, you must have `manage` cluster
|
||||
privileges to turn on data collection.
|
||||
|
||||
NOTE: If you are using a separate monitoring cluster, you do not need to turn on
|
||||
data collection. The dashboards appear when there is data in the monitoring
|
||||
cluster.
|
||||
NOTE: If you are using a separate monitoring cluster, you do not need to turn on
|
||||
data collection. The dashboards appear when there is data in the monitoring
|
||||
cluster.
|
||||
|
||||
--
|
||||
|
||||
You'll see cluster alerts
|
||||
that require your attention and a summary of the available monitoring metrics
|
||||
for {es}, Logstash, {kib}, and Beats. To view additional information, click the
|
||||
Overview, Nodes, Indices, or Instances links. See <<xpack-monitoring>>.
|
||||
Overview, Nodes, Indices, or Instances links. See <<xpack-monitoring>>.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/monitoring-dashboard.png[Monitoring dashboard]
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
[[configuring-tls]]
|
||||
=== Encrypting communications in {kib}
|
||||
=== Encrypt communications in {kib}
|
||||
++++
|
||||
<titleabbrev>Encrypting communications</titleabbrev>
|
||||
<titleabbrev>Encrypt communications</titleabbrev>
|
||||
++++
|
||||
|
||||
Secure Sockets Layer (SSL) and Transport Layer Security (TLS) provide encryption for data-in-transit. While these terms are often used
|
||||
|
|
@ -14,7 +14,7 @@ contains a public key and has an associated -- but separate -- private key; thes
|
|||
supports certificates and private keys in PEM or PKCS#12 format.
|
||||
|
||||
[[configuring-tls-browser-kib]]
|
||||
==== Encrypting traffic between the browser and {kib}
|
||||
==== Encrypt traffic between the browser and {kib}
|
||||
|
||||
NOTE: You do not need to enable the {es} {security-features} for this type of encryption.
|
||||
|
||||
|
|
@ -106,7 +106,7 @@ server.ssl.enabled: true
|
|||
After making these changes, you must always access {kib} via HTTPS. For example, https://<your_kibana_host>.com.
|
||||
|
||||
[[configuring-tls-kib-es]]
|
||||
==== Encrypting traffic between {kib} and {es}
|
||||
==== Encrypt traffic between {kib} and {es}
|
||||
|
||||
NOTE: To perform this step, you must {ref}/configuring-security.html[enable the {es} {security-features}] or you must have a proxy that
|
||||
provides an HTTPS endpoint for {es}.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
[role="xpack"]
|
||||
[[using-kibana-with-security]]
|
||||
== Configuring security in {kib}
|
||||
== Configure security in {kib}
|
||||
++++
|
||||
<titleabbrev>Configuring security</titleabbrev>
|
||||
<titleabbrev>Configure security</titleabbrev>
|
||||
++++
|
||||
|
||||
{kib} users have to log in when {security} is enabled on your cluster. You
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[setup]]
|
||||
= Set Up Kibana
|
||||
= Set up Kibana
|
||||
|
||||
[partintro]
|
||||
--
|
||||
|
|
@ -48,11 +48,9 @@ the patch version.
|
|||
|
||||
include::{kib-repo-dir}/setup/install.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/setup/start-stop.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/setup/settings.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/setup/docker.asciidoc[]
|
||||
include::{kib-repo-dir}/setup/start-stop.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/setup/access.asciidoc[]
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue