2015-01-23 18:54:40 +01:00
|
|
|
[[setup]]
|
2016-08-31 22:03:54 +02:00
|
|
|
== Setting Up Kibana
|
|
|
|
You can install Kibana and start exploring your Elasticsearch indices in minutes.
|
2015-01-23 23:37:26 +01:00
|
|
|
All you need is:
|
|
|
|
|
2016-04-02 20:36:04 +02:00
|
|
|
* Elasticsearch {esversion}
|
2016-07-22 20:25:11 +02:00
|
|
|
* A modern web browser - https://www.elastic.co/support/matrix#show_browsers[Supported Browsers].
|
2015-04-02 00:22:48 +02:00
|
|
|
* Information about your Elasticsearch installation:
|
2015-01-28 23:50:31 +01:00
|
|
|
** URL of the Elasticsearch instance you want to connect to.
|
2015-04-02 00:22:48 +02:00
|
|
|
** Which Elasticsearch indices you want to search.
|
2015-02-17 21:06:32 +01:00
|
|
|
|
2015-02-14 20:20:30 +01:00
|
|
|
[float]
|
|
|
|
[[install]]
|
2016-08-31 22:03:54 +02:00
|
|
|
=== Install Kibana
|
|
|
|
To install and start Kibana:
|
2015-01-23 23:37:26 +01:00
|
|
|
|
2016-08-31 22:03:54 +02:00
|
|
|
. Download the https://www.elastic.co/downloads/kibana[Kibana 4 binary package] for your platform.
|
2015-01-23 23:37:26 +01:00
|
|
|
. Extract the `.zip` or `tar.gz` archive file.
|
2016-08-03 18:27:32 +02:00
|
|
|
. If you're upgrading, migrate any configuration changes from the previous `kibana.yml` to the new version.
|
2016-07-25 17:52:16 +02:00
|
|
|
. Install Kibana plugins (optional).
|
2016-07-22 20:25:11 +02:00
|
|
|
. Run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows).
|
2015-05-21 08:13:38 +02:00
|
|
|
|
2015-04-02 00:22:48 +02:00
|
|
|
That's it! Kibana is now running on port 5601.
|
2015-01-28 23:50:31 +01:00
|
|
|
|
2016-09-08 15:53:09 +02:00
|
|
|
On Unix, you can also install Kibana using the package manager suited for your distribution. For more
|
2016-08-31 22:03:54 +02:00
|
|
|
information, see <<setup-repositories, Installing Kibana with apt and yum>>.
|
2015-05-28 20:26:02 +02:00
|
|
|
|
2016-10-17 14:01:59 +02:00
|
|
|
IMPORTANT: If your Elasticsearch installation is protected by {xpack}/xpack-security.html[{scyld}]
|
|
|
|
see {xpack}/kibana.html[Using Kibana with X-Pack Security] for additional setup
|
2016-08-31 22:03:54 +02:00
|
|
|
instructions.
|
2015-05-28 20:26:02 +02:00
|
|
|
|
2015-02-14 20:20:30 +01:00
|
|
|
[float]
|
|
|
|
[[connect]]
|
2015-04-02 00:22:48 +02:00
|
|
|
=== Connect Kibana with Elasticsearch
|
2016-09-08 15:53:09 +02:00
|
|
|
Before you can start using Kibana, you need to tell it which Elasticsearch indices you want to explore.
|
|
|
|
The first time you access Kibana, you are prompted to define an _index pattern_ that matches the name of
|
|
|
|
one or more of your indices. That's it. That's all you need to configure to start using Kibana. You can
|
2016-08-31 22:03:54 +02:00
|
|
|
add index patterns at any time from the <<settings-create-pattern,Settings tab>>.
|
2015-01-23 23:37:26 +01:00
|
|
|
|
2016-09-08 15:53:09 +02:00
|
|
|
TIP: By default, Kibana connects to the Elasticsearch instance running on `localhost`. To connect to a
|
|
|
|
different Elasticsearch instance, modify the Elasticsearch URL in the `kibana.yml` configuration file and
|
2016-09-09 18:37:16 +02:00
|
|
|
restart Kibana. For information about using Kibana with your production nodes, see <<production>>.
|
2015-01-23 23:37:26 +01:00
|
|
|
|
2015-02-18 21:24:06 +01:00
|
|
|
To configure the Elasticsearch indices you want to access with Kibana:
|
2015-01-23 23:37:26 +01:00
|
|
|
|
2016-09-08 15:53:09 +02:00
|
|
|
. Point your browser at port 5601 to access the Kibana UI. For example, `localhost:5601` or
|
2016-08-31 22:03:54 +02:00
|
|
|
`http://YOURDOMAIN.com:5601`.
|
2015-02-14 20:20:30 +01:00
|
|
|
+
|
2015-11-24 17:25:14 +01:00
|
|
|
image:images/Start-Page.png[Kibana start page]
|
2015-02-14 20:20:30 +01:00
|
|
|
+
|
2016-09-08 15:53:09 +02:00
|
|
|
. Specify an index pattern that matches the name of one or more of your Elasticsearch indices. By default,
|
|
|
|
Kibana guesses that you're working with data being fed into Elasticsearch by Logstash. If that's the case,
|
|
|
|
you can use the default `logstash-*` as your index pattern. The asterisk (*) matches zero or more
|
|
|
|
characters in an index's name. If your Elasticsearch indices follow some other naming convention, enter
|
2016-08-31 22:03:54 +02:00
|
|
|
an appropriate pattern. The "pattern" can also simply be the name of a single index.
|
2016-09-08 15:53:09 +02:00
|
|
|
. Select the index field that contains the timestamp that you want to use to perform time-based
|
|
|
|
comparisons. Kibana reads the index mapping to list all of the fields that contain a timestamp. If your
|
2016-08-31 22:03:54 +02:00
|
|
|
index doesn't have time-based data, disable the *Index contains time-based events* option.
|
2015-11-24 17:25:14 +01:00
|
|
|
+
|
2016-09-08 15:53:09 +02:00
|
|
|
WARNING: Using event times to create index names is *deprecated* in this release of Kibana. Support for
|
|
|
|
this functionality will be removed entirely in the next major Kibana release. Elasticsearch 2.1 includes
|
|
|
|
sophisticated date parsing APIs that Kibana uses to determine date information, removing the need to
|
2016-08-31 22:03:54 +02:00
|
|
|
specify dates in the index pattern name.
|
2015-11-24 17:25:14 +01:00
|
|
|
+
|
2015-06-10 21:58:29 +02:00
|
|
|
. Click *Create* to add the index pattern. This first pattern is automatically configured as the default.
|
2016-09-08 15:53:09 +02:00
|
|
|
When you have more than one index pattern, you can designate which one to use as the default from
|
2016-08-31 22:03:54 +02:00
|
|
|
*Settings > Indices*.
|
|
|
|
|
2016-09-08 15:53:09 +02:00
|
|
|
All done! Kibana is now connected to your Elasticsearch data. Kibana displays a read-only list of fields
|
2016-08-31 22:03:54 +02:00
|
|
|
configured for the matching index.
|
2015-01-23 23:37:26 +01:00
|
|
|
|
2016-09-08 15:53:09 +02:00
|
|
|
NOTE: Kibana relies on dynamic mapping to use fields in visualizations and manage the
|
|
|
|
`.kibana` index. If you have disabled dynamic mapping, you need to manually provide
|
|
|
|
mappings for the fields that Kibana uses to create visualizations. For more information, see
|
2016-08-31 22:03:54 +02:00
|
|
|
<<kibana-dynamic-mapping, Kibana and Elasticsearch Dynamic Mapping>>.
|
2015-01-23 23:37:26 +01:00
|
|
|
|
2015-02-14 20:20:30 +01:00
|
|
|
[float]
|
|
|
|
[[explore]]
|
2015-01-23 23:37:26 +01:00
|
|
|
=== Start Exploring your Data!
|
|
|
|
You're ready to dive in to your data:
|
|
|
|
|
2015-05-18 04:31:43 +02:00
|
|
|
* Search and browse your data interactively from the <<discover, Discover>> page.
|
2015-04-02 00:22:48 +02:00
|
|
|
* Chart and map your data from the <<visualize, Visualize>> page.
|
2015-05-18 04:31:43 +02:00
|
|
|
* Create and view custom dashboards from the <<dashboard, Dashboard>> page.
|
|
|
|
|
2016-09-08 15:53:09 +02:00
|
|
|
For a step-by-step introduction to these core Kibana concepts, see the <<getting-started,
|
2016-08-31 22:03:54 +02:00
|
|
|
Getting Started>> tutorial.
|
|
|
|
|
|
|
|
[float]
|
|
|
|
[[kibana-dynamic-mapping]]
|
|
|
|
=== Kibana and Elasticsearch Dynamic Mapping
|
2016-09-08 15:53:09 +02:00
|
|
|
By default, Elasticsearch enables {ref}dynamic-mapping.html[dynamic mapping] for fields. Kibana needs
|
|
|
|
dynamic mapping to use fields in visualizations correctly, as well as to manage the `.kibana` index
|
2016-08-31 22:03:54 +02:00
|
|
|
where saved searches, visualizations, and dashboards are stored.
|
|
|
|
|
2016-09-08 15:53:09 +02:00
|
|
|
If your Elasticsearch use case requires you to disable dynamic mapping, you need to manually provide
|
|
|
|
mappings for fields that Kibana uses to create visualizations. You also need to manually enable dynamic
|
2016-08-31 22:03:54 +02:00
|
|
|
mapping for the `.kibana` index.
|
|
|
|
|
2016-09-08 15:53:09 +02:00
|
|
|
The following procedure assumes that the `.kibana` index does not already exist in Elasticsearch and
|
2016-08-31 22:03:54 +02:00
|
|
|
that the `index.mapper.dynamic` setting in `elasticsearch.yml` is set to `false`:
|
|
|
|
|
|
|
|
. Start Elasticsearch.
|
|
|
|
. Create the `.kibana` index with dynamic mapping enabled just for that index:
|
|
|
|
+
|
|
|
|
[source,shell]
|
|
|
|
PUT .kibana
|
|
|
|
{
|
|
|
|
"index.mapper.dynamic": true
|
|
|
|
}
|
|
|
|
+
|
2016-09-08 15:53:09 +02:00
|
|
|
. Start Kibana and navigate to the web UI and verify that there are no error messages related to dynamic
|
2016-08-31 22:03:54 +02:00
|
|
|
mapping.
|
|
|
|
|
|
|
|
include::kibana-repositories.asciidoc[]
|
|
|
|
|
|
|
|
[[upgrading-kibana]]
|
|
|
|
=== Upgrading Kibana
|
|
|
|
|
|
|
|
Your existing Kibana version is generally compatible with the next minor version release of Elasticsearch.
|
|
|
|
This means you should upgrade your Elasticsearch cluster(s) before or at the same time as Kibana.
|
2016-09-08 15:53:09 +02:00
|
|
|
We cannot guarantee compatibility between major version releases so in those cases both Elasticsearch and
|
2016-08-31 22:03:54 +02:00
|
|
|
Kibana must be upgraded together.
|
|
|
|
|
|
|
|
To upgrade Kibana:
|
|
|
|
|
2016-10-17 13:38:44 +02:00
|
|
|
. Create a {ref}/modules-snapshots.html[snapshot]
|
2016-08-31 22:03:54 +02:00
|
|
|
of the existing `.kibana` index.
|
|
|
|
. Back up the `kibana.yml` configuration file.
|
|
|
|
. Take note of the Kibana plugins that are installed:
|
|
|
|
* `bin/kibana plugin --list` on 4.x versions of Kibana.
|
|
|
|
* `bin/kibana-plugin list` on 5.x versions of Kibana.
|
|
|
|
. To upgrade from an Archive File:
|
|
|
|
.. Extract the new version of Kibana into a different directory. See steps below.
|
|
|
|
.. Migrate any custom configuration from your old kibana.yml to your new one
|
|
|
|
.. Follow other steps below to complete the new installation.
|
2016-09-08 15:53:09 +02:00
|
|
|
.. Once the new version is fully configured and working with required plugins, remove the previous version
|
2016-08-31 22:03:54 +02:00
|
|
|
of Kibana
|
|
|
|
. To upgrade using a Linux Package Manager:
|
|
|
|
.. Uninstall the existing Kibana package: `apt-get remove kibana` or `yum remove kibana`
|
2016-09-08 15:53:09 +02:00
|
|
|
.. Install the new Kibana package. There have been some installer issues between various version of
|
|
|
|
Kibana so the uninstall and install process is safer than an upgrade.
|