mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
docs: Update docs with latest from 5.0
We've been maintaining the 5.0 docs separately for awhile, but now it is time to get the changes synced up with the repo itself.
This commit is contained in:
Court Ewing
parent
d2aff6c944
commit
69ba6ae09c
6 changed files with 43 additions and 73 deletions
|
|
@ -11,8 +11,8 @@ compatible with other configuration settings. Deleting a custom setting removes
|
|||
`dateFormat`:: The format to use for displaying pretty-formatted dates.
|
||||
`dateFormat:tz`:: The timezone that Kibana uses. The default value of `Browser` uses the timezone detected by the browser.
|
||||
`dateFormat:scaled`:: These values define the format used to render ordered time-based data. Formatted timestamps must
|
||||
`dateFormat:dow`:: This property defines what day weeks should start on.
|
||||
adapt to the interval between measurements. Keys are http://en.wikipedia.org/wiki/ISO_8601#Time_intervals[ISO8601 intervals].
|
||||
`dateFormat:dow`:: This property defines what day weeks should start on.
|
||||
`defaultIndex`:: Default is `null`. This property specifies the default index.
|
||||
`defaultColumns`:: Default is `_source`. Defines the columns that appear by default on the Discover page.
|
||||
`metaFields`:: An array of fields outside of `_source`. Kibana merges these fields into the document when displaying the
|
||||
|
|
@ -58,4 +58,4 @@ Markdown.
|
|||
`notifications:lifetime:banner`:: Specifies the duration in milliseconds for banner notification displays. The default value is 3000000. Set this field to `Infinity` to disable banner notifications.
|
||||
`notifications:lifetime:error`:: Specifies the duration in milliseconds for error notification displays. The default value is 300000. Set this field to `Infinity` to disable error notifications.
|
||||
`notifications:lifetime:warning`:: Specifies the duration in milliseconds for warning notification displays. The default value is 10000. Set this field to `Infinity` to disable warning notifications.
|
||||
`notifications:lifetime:info`:: Specifies the duration in milliseconds for information notification displays. The default value is 5000. Set this field to `Infinity` to disable information notifications.
|
||||
`notifications:lifetime:info`:: Specifies the duration in milliseconds for information notification displays. The default value is 5000. Set this field to `Infinity` to disable information notifications.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ key Kibana functionality. By the end of this tutorial, you will have:
|
|||
|
||||
* Loaded a sample data set into your Elasticsearch installation
|
||||
* Defined at least one index pattern
|
||||
* Used the <<discover, Discover>> functionality to explore your data
|
||||
* Use the <<discover, Discover>> functionality to explore your data
|
||||
* Set up some <<visualize,_visualizations_>> to graphically represent your data
|
||||
* Assembled visualizations into a <<dashboard,Dashboard>>
|
||||
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@ When you specify a plugin name without a URL, the plugin tool attempts to downlo
|
|||
You can specify a URL to a specific plugin, as in the following example:
|
||||
|
||||
[source,shell]
|
||||
$ bin/kibana-plugin install https://download.elastic.co/kibana/x-pack/x-pack-5.0.0-snapshot.zip
|
||||
Attempting to transfer from https://download.elastic.co/kibana/x-pack//x-pack-5.0.0-snapshot.zip
|
||||
$ bin/kibana-plugin install https://download.elastic.co/kibana/x-pack/x-pack-{version}.zip
|
||||
Attempting to transfer from https://download.elastic.co/kibana/x-pack/x-pack-{version}.zip
|
||||
Transferring <some number> bytes....................
|
||||
Transfer complete
|
||||
Retrieving metadata from plugin archive
|
||||
|
|
|
|||
|
|
@ -235,37 +235,6 @@ NOTE: This must be a user who has been assigned a role derived from the example
|
|||
`true`.
|
||||
|======
|
||||
|
||||
////
|
||||
|
||||
[float]
|
||||
[[configuring-kibana-shield]]
|
||||
=== Configuring Kibana to Work with {scyld}
|
||||
If you are using {scyld} to authenticate Elasticsearch users, you need to provide
|
||||
the Kibana server with credentials to enable access to the `.kibana` index and monitor
|
||||
the cluster.
|
||||
|
||||
To configure credentials for the Kibana server:
|
||||
|
||||
. Assign the `kibana4_server` role to a user in {scyld}. For more information, see
|
||||
{shield}/kibana.html#kibana4-server-role[Configuring a Role for the Kibana Server]
|
||||
in the {scyld} documentation.
|
||||
|
||||
. Set the `kibana_elasticsearch_username` and
|
||||
`kibana_elasticsearch_password` properties in `kibana.yml` to specify the credentials
|
||||
of the user you assigned the `kibana4_server` role:
|
||||
+
|
||||
[source,text]
|
||||
----
|
||||
kibana_elasticsearch_username: kibana-user
|
||||
kibana_elasticsearch_password: kibana-password
|
||||
----
|
||||
|
||||
Users on release 4.0 and later of Kibana also need access to the `.kibana` index so they can save and load searches, visualizations, and
|
||||
dashboards. For more information, see {shield}/kibana.html[Using Kibana with {scyld}].
|
||||
|
||||
TIP: See <<kibana-dynamic-mapping, Kibana and Elasticsearch Dynamic Mapping>> for important information on Kibana and
|
||||
the dynamic mapping feature in Elasticsearch.
|
||||
////
|
||||
|
||||
[float]
|
||||
[[enabling-ssl]]
|
||||
|
|
@ -314,7 +283,8 @@ the query that populates a Kibana visualization, the user just sees an empty
|
|||
visualization.
|
||||
|
||||
To configure access to Kibana using {scyld}, you create roles
|
||||
for Kibana using the `my_kibana_user` default role as a starting point.
|
||||
for Kibana using the `my_kibana_user` default role as a starting point. For more
|
||||
information, see {shield}/kibana.html#using-kibana4-with-shield[Using Kibana with {scyld}].
|
||||
|
||||
[float]
|
||||
[[load-balancing]]
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ The {version} release of Kibana requires Elasticsearch {esversion} or later.
|
|||
* {k4issue}6531[Issue 6531]: Improved warning for URL lengths that approach browser limits.
|
||||
* {k4issue}6602[Issue 6602]: Improves dark theme support.
|
||||
* {k4issue}6791[Issue 6791]: Enables composition of custom user toast notifications in Advanced Settings.
|
||||
* {k4pull}8014[Pull Request 8014]: Changes the UUID config setting from `uuid` to `server.uuid`, and puts UUID storage into data file instead of Elasticsearch.
|
||||
* {k4pull}8014[Pull Request 8014]: Changes the UUID config setting from `uuid` to `server.uuid`, and puts UUID storage into data file instead of Elasticsearch. added[5.0.0-beta1]
|
||||
|
||||
[float]
|
||||
[[bugfixes]]
|
||||
|
|
|
|||
|
|
@ -22,56 +22,56 @@ To install and start Kibana:
|
|||
|
||||
That's it! Kibana is now running on port 5601.
|
||||
|
||||
On Unix, you can also install Kibana using the package manager suited for your distribution. For more
|
||||
On Unix, you can also install Kibana using the package manager suited for your distribution. For more
|
||||
information, see <<setup-repositories, Installing Kibana with apt and yum>>.
|
||||
|
||||
IMPORTANT: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[Shield]
|
||||
see {shield}/kibana.html#using-kibana4-with-shield[Using Kibana with Shield] for additional setup
|
||||
IMPORTANT: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[Shield]
|
||||
see {shield}/kibana.html#using-kibana4-with-shield[Using Kibana with Shield] for additional setup
|
||||
instructions.
|
||||
|
||||
[float]
|
||||
[[connect]]
|
||||
=== Connect Kibana with Elasticsearch
|
||||
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
|
||||
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
|
||||
add index patterns at any time from the <<settings-create-pattern,Settings tab>>.
|
||||
|
||||
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
|
||||
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
|
||||
restart Kibana. Forninformation about using Kibana with your production nodes, see <<production>>.
|
||||
|
||||
To configure the Elasticsearch indices you want to access with Kibana:
|
||||
|
||||
. Point your browser at port 5601 to access the Kibana UI. For example, `localhost:5601` or
|
||||
. Point your browser at port 5601 to access the Kibana UI. For example, `localhost:5601` or
|
||||
`http://YOURDOMAIN.com:5601`.
|
||||
+
|
||||
image:images/Start-Page.png[Kibana start page]
|
||||
+
|
||||
. 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
|
||||
. 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
|
||||
an appropriate pattern. The "pattern" can also simply be the name of a single index.
|
||||
. 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
|
||||
. 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
|
||||
index doesn't have time-based data, disable the *Index contains time-based events* option.
|
||||
+
|
||||
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
|
||||
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
|
||||
specify dates in the index pattern name.
|
||||
+
|
||||
. Click *Create* to add the index pattern. This first pattern is automatically configured as the default.
|
||||
When you have more than one index pattern, you can designate which one to use as the default from
|
||||
When you have more than one index pattern, you can designate which one to use as the default from
|
||||
*Settings > Indices*.
|
||||
|
||||
All done! Kibana is now connected to your Elasticsearch data. Kibana displays a read-only list of fields
|
||||
All done! Kibana is now connected to your Elasticsearch data. Kibana displays a read-only list of fields
|
||||
configured for the matching index.
|
||||
|
||||
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
|
||||
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
|
||||
<<kibana-dynamic-mapping, Kibana and Elasticsearch Dynamic Mapping>>.
|
||||
|
||||
[float]
|
||||
|
|
@ -83,21 +83,21 @@ You're ready to dive in to your data:
|
|||
* Chart and map your data from the <<visualize, Visualize>> page.
|
||||
* Create and view custom dashboards from the <<dashboard, Dashboard>> page.
|
||||
|
||||
For a step-by-step introduction to these core Kibana concepts, see the <<getting-started,
|
||||
For a step-by-step introduction to these core Kibana concepts, see the <<getting-started,
|
||||
Getting Started>> tutorial.
|
||||
|
||||
[float]
|
||||
[[kibana-dynamic-mapping]]
|
||||
=== Kibana and Elasticsearch Dynamic Mapping
|
||||
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
|
||||
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
|
||||
where saved searches, visualizations, and dashboards are stored.
|
||||
|
||||
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
|
||||
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
|
||||
mapping for the `.kibana` index.
|
||||
|
||||
The following procedure assumes that the `.kibana` index does not already exist in Elasticsearch and
|
||||
The following procedure assumes that the `.kibana` index does not already exist in Elasticsearch and
|
||||
that the `index.mapper.dynamic` setting in `elasticsearch.yml` is set to `false`:
|
||||
|
||||
. Start Elasticsearch.
|
||||
|
|
@ -109,7 +109,7 @@ PUT .kibana
|
|||
"index.mapper.dynamic": true
|
||||
}
|
||||
+
|
||||
. Start Kibana and navigate to the web UI and verify that there are no error messages related to dynamic
|
||||
. Start Kibana and navigate to the web UI and verify that there are no error messages related to dynamic
|
||||
mapping.
|
||||
|
||||
include::kibana-repositories.asciidoc[]
|
||||
|
|
@ -119,12 +119,12 @@ include::kibana-repositories.asciidoc[]
|
|||
|
||||
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.
|
||||
We cannot guarantee compatibility between major version releases so in those cases both Elasticsearch and
|
||||
We cannot guarantee compatibility between major version releases so in those cases both Elasticsearch and
|
||||
Kibana must be upgraded together.
|
||||
|
||||
To upgrade Kibana:
|
||||
|
||||
. Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot]
|
||||
. Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot]
|
||||
of the existing `.kibana` index.
|
||||
. Back up the `kibana.yml` configuration file.
|
||||
. Take note of the Kibana plugins that are installed:
|
||||
|
|
@ -134,9 +134,9 @@ of the existing `.kibana` index.
|
|||
.. 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.
|
||||
.. Once the new version is fully configured and working with required plugins, remove the previous version
|
||||
.. Once the new version is fully configured and working with required plugins, remove the previous version
|
||||
of Kibana
|
||||
. To upgrade using a Linux Package Manager:
|
||||
.. Uninstall the existing Kibana package: `apt-get remove kibana` or `yum remove kibana`
|
||||
.. 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.
|
||||
.. 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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue