mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
parent
511124cc97
commit
9f70670d33
10 changed files with 53 additions and 51 deletions
|
@ -1,5 +1,5 @@
|
|||
[[kibana-apps]]
|
||||
== Kibana Apps added[4.2]
|
||||
== Kibana Apps
|
||||
|
||||
The Kibana UI serves as a framework that can contain several different applications. You can switch between these
|
||||
applications by clicking the image:images/app-button.png[App Picker] *App picker* button to display the app bar:
|
||||
|
|
|
@ -14,10 +14,10 @@ The material in this section assumes you have a working Kibana install connected
|
|||
|
||||
Video tutorials are also available:
|
||||
|
||||
* https://www.elastic.co/blog/kibana-4-video-tutorials-part-1[High-level Kibana 4 introduction, pie charts]
|
||||
* https://www.elastic.co/blog/kibana-4-video-tutorials-part-1[High-level Kibana introduction, pie charts]
|
||||
* https://www.elastic.co/blog/kibana-4-video-tutorials-part-2[Data discovery, bar charts, and line charts]
|
||||
* https://www.elastic.co/blog/kibana-4-video-tutorials-part-3[Tile maps]
|
||||
* https://www.elastic.co/blog/kibana-4-video-tutorials-part-4[Embedding Kibana 4 visualizations]
|
||||
* https://www.elastic.co/blog/kibana-4-video-tutorials-part-4[Embedding Kibana visualizations]
|
||||
|
||||
[float]
|
||||
[[tutorial-load-dataset]]
|
||||
|
@ -76,7 +76,7 @@ The schema for the logs data set has dozens of different fields, but the notable
|
|||
"@timestamp": "date"
|
||||
}
|
||||
|
||||
Before we load the Shakespeare and logs data sets, we need to set up {ref}/mapping.html[_mappings_] for the fields.
|
||||
Before we load the Shakespeare and logs data sets, we need to set up {ref}mapping.html[_mappings_] for the fields.
|
||||
Mapping divides the documents in the index into logical groups and specifies a field's characteristics, such as the
|
||||
field's searchability or whether or not it's _tokenized_, or broken up into separate words.
|
||||
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 73 KiB After Width: | Height: | Size: 32 KiB |
|
@ -3,6 +3,7 @@
|
|||
|
||||
:ref: http://www.elastic.co/guide/en/elasticsearch/reference/current/
|
||||
:shield: https://www.elastic.co/guide/en/shield/current
|
||||
:scyld: X-Pack Security
|
||||
:k4issue: https://github.com/elastic/kibana/issues/
|
||||
:k4pull: https://github.com/elastic/kibana/pull/
|
||||
:version: 5.0-alpha
|
||||
|
|
|
@ -24,9 +24,9 @@ wget -qO - https://packages.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add
|
|||
+
|
||||
. Add the repository definition to your `/etc/apt/sources.list.d/kibana.list` file:
|
||||
+
|
||||
[source, sh]
|
||||
["source","sh",subs="attributes"]
|
||||
--------------------------------------------------
|
||||
echo "deb http://packages.elastic.co/kibana/{branch}/debian stable main" | sudo tee -a /etc/apt/sources.list.d/kibana.list
|
||||
echo "deb http://packages.elastic.co/kibana/{version}/debian stable main" | sudo tee -a /etc/apt/sources.list.d/kibana.list
|
||||
--------------------------------------------------
|
||||
+
|
||||
[WARNING]
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
[[kibana-plugins]]
|
||||
== Kibana Plugins added[4.2]
|
||||
== Kibana Plugins
|
||||
|
||||
Add-on functionality for Kibana is implemented with plug-in modules. You can use the `bin/kibana-plugin`
|
||||
command to manage these modules. You can also install a plugin manually by moving the plugin file to the
|
||||
|
@ -13,21 +13,22 @@ A list of existing Kibana plugins is available on https://github.com/elastic/kib
|
|||
Use the following command to install a plugin:
|
||||
|
||||
[source,shell]
|
||||
bin/kibana-plugin install <package> (optional URL)
|
||||
bin/kibana-plugin install <package name or URL>
|
||||
|
||||
When you use `elasticsearch` as the organization name, the plugin management tool downloads the plugin from
|
||||
`download.elastic.co`.
|
||||
When you specify a plugin name without a URL, the plugin tool attempts to download the plugin from `download.elastic.co`.
|
||||
|
||||
[float]
|
||||
==== Installing Plugins from an Arbitrary URL
|
||||
|
||||
You can specify the URL to a plugin after the plugin name, as in the following example:
|
||||
You can specify a URL to a specific plugin, as in the following example:
|
||||
|
||||
[source,shell]
|
||||
$ bin/kibana-plugin install sample-plugin https://some.sample.url/directory
|
||||
Installing sample-plugin
|
||||
Attempting to extract from https://some.sample.url/directory
|
||||
Downloading <some number> bytes....................
|
||||
$ 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
|
||||
Transferring <some number> bytes....................
|
||||
Transfer complete
|
||||
Retrieving metadata from plugin archive
|
||||
Extracting plugin archive
|
||||
Extraction complete
|
||||
Optimizing and caching browser bundles...
|
||||
Plugin installation complete
|
||||
|
@ -41,10 +42,13 @@ Use the `-d` or `--plugin-dir` option after the `install` command to specify a d
|
|||
example:
|
||||
|
||||
[source,shell]
|
||||
$ bin/kibana-plugin install elasticsearch/sample-plugin/latest -d <path/to/directory>
|
||||
$ bin/kibana-plugin install file:///some/local/path/x-pack.zip -d path/to/directory
|
||||
Installing sample-plugin
|
||||
Attempting to extract from https://download.elastic.co/elasticsearch/sample-plugin/sample-plugin-latest.tar.gz
|
||||
Downloading <some number> bytes....................
|
||||
Attempting to transfer from file:///some/local/path/x-pack.zip
|
||||
Transferring <some number> bytes....................
|
||||
Transfer complete
|
||||
Retrieving metadata from plugin archive
|
||||
Extracting plugin archive
|
||||
Extraction complete
|
||||
Optimizing and caching browser bundles...
|
||||
Plugin installation complete
|
||||
|
@ -57,7 +61,7 @@ NOTE: This command creates the specified directory if it does not already exist.
|
|||
Use the `remove` command to remove a plugin, including any configuration information, as in the following example:
|
||||
|
||||
[source,shell]
|
||||
$ bin/kibana-plugin remove marvel
|
||||
$ bin/kibana-plugin remove timelion
|
||||
|
||||
You can also remove a plugin manually by deleting the plugin's subdirectory under the `installedPlugins/` directory.
|
||||
|
||||
|
@ -84,19 +88,19 @@ change this behavior, as in the following examples:
|
|||
|
||||
[source,shell]
|
||||
.Waits for 30 seconds before failing
|
||||
bin/kibana-plugin install --timeout 30s username/sample-plugin
|
||||
bin/kibana-plugin install --timeout 30s sample-plugin
|
||||
|
||||
[source,shell]
|
||||
.Waits for 1 minute before failing
|
||||
bin/kibana-plugin install --timeout 1m username/sample-plugin
|
||||
bin/kibana-plugin install --timeout 1m sample-plugin
|
||||
|
||||
[float]
|
||||
==== Plugins and Custom Kibana Configurations
|
||||
|
||||
Use the `-c` or `--config` options with the `install` and `remove` commands to specify the path to the configuration file
|
||||
used to start Kibana. By default, Kibana uses the configuration file `config/kibana.yml`. When you change your installed
|
||||
plugins, the `bin/kibana plugin` command restarts the Kibana server. When you are using a customized configuration file,
|
||||
you must specify the path to that configuration file each time you use the `bin/kibana plugin` command.
|
||||
plugins, the `bin/kibana-plugin` command restarts the Kibana server. When you are using a customized configuration file,
|
||||
you must specify the path to that configuration file each time you use the `bin/kibana-plugin` command.
|
||||
|
||||
[float]
|
||||
=== Plugin Manager Exit Codes
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
[[production]]
|
||||
== Using Kibana in a Production Environment
|
||||
* <<configuring-kibana-shield, Configuring Kibana to Work with Shield>>
|
||||
* <<configuring-kibana-shield, Configuring Kibana to Work with {scyld}>>
|
||||
* <<enabling-ssl, Enabling SSL>>
|
||||
* <<controlling-access, Controlling Access>>
|
||||
* <<load-balancing, Load Balancing Across Multiple Elasticsearch Nodes>>
|
||||
|
@ -19,31 +19,29 @@ and an Elasticsearch client node on the same machine. For more information, see
|
|||
|
||||
[float]
|
||||
[[configuring-kibana-shield]]
|
||||
=== Configuring Kibana to Work with Shield
|
||||
If you are using Shield to authenticate Elasticsearch users, you need to provide
|
||||
=== Configuring Kibana to Work with {scyld}
|
||||
If you are using {scyld} to authenticate Elasticsearch users, you need to provide
|
||||
the Kibana server with credentials so it can access the `.kibana` index and monitor
|
||||
the cluster.
|
||||
|
||||
To configure credentials for the Kibana server:
|
||||
|
||||
. Assign the `kibana4_server` role to a user in Shield. For more information, see
|
||||
{shield}/kibana.html#kibana4-server-role[Configuring a Role for the Kibana 4 Server]
|
||||
in the Shield documentation.
|
||||
. 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:
|
||||
of the user you assigned the `kibana4_server` role:
|
||||
+
|
||||
[source,text]
|
||||
----
|
||||
kibana_elasticsearch_username: kibana4-user
|
||||
kibana_elasticsearch_password: kibana4-password
|
||||
kibana_elasticsearch_username: kibana-user
|
||||
kibana_elasticsearch_password: kibana-password
|
||||
----
|
||||
|
||||
Kibana 4 users 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 Shield] in
|
||||
the Shield documentation.
|
||||
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.
|
||||
|
@ -64,7 +62,7 @@ server.ssl.key: /path/to/your/server.key
|
|||
server.ssl.cert: /path/to/your/server.crt
|
||||
----
|
||||
|
||||
If you are using Shield or a proxy that provides an HTTPS endpoint for Elasticsearch,
|
||||
If you are using {scyld} or a proxy that provides an HTTPS endpoint for Elasticsearch,
|
||||
you can configure Kibana to access Elasticsearch via HTTPS so communications between
|
||||
the Kibana server and Elasticsearch are encrypted.
|
||||
|
||||
|
@ -89,15 +87,14 @@ ca: /path/to/your/ca/cacert.pem
|
|||
[float]
|
||||
[[controlling-access]]
|
||||
=== Controlling access
|
||||
You can use http://www.elastic.co/overview/shield/[Elasticsearch Shield]
|
||||
(Shield) to control what Elasticsearch data users can access through Kibana.
|
||||
Shield provides index-level access control. If a user isn't authorized to run
|
||||
You can use http://www.elastic.co/overview/shield/[{scyld}] to control what Elasticsearch data users can access through Kibana.
|
||||
{scyld} provides index-level access control. If a user isn't authorized to run
|
||||
the query that populates a Kibana visualization, the user just sees an empty
|
||||
visualization.
|
||||
|
||||
To configure access to Kibana using Shield, you create Shield roles
|
||||
To configure access to Kibana using {scyld}, you create roles
|
||||
for Kibana using the `kibana4` default role as a starting point. For more
|
||||
information, see {shield}/kibana.html#using-kibana4-with-shield[Using Kibana 4 with Shield].
|
||||
information, see {shield}/kibana.html#using-kibana4-with-shield[Using Kibana with {scyld}].
|
||||
|
||||
[float]
|
||||
[[load-balancing]]
|
||||
|
|
|
@ -14,8 +14,7 @@ The {version} release of Kibana requires Elasticsearch {esversion} or later.
|
|||
== Enhancements
|
||||
|
||||
* {k4issue}6387[Issue 6387]: A new look for Kibana: new logo and UI, improved layout and navigation.
|
||||
* {k4pull}6402[Pull Request 6402]: Refactored the command-line plugin management tool to support cross-stack plugin
|
||||
management.
|
||||
* {k4pull}6402[Pull Request 6402]: New command-line plugin management tool supports cross-stack plugin management.
|
||||
* {k4issue}5130[Issue 5130]: Adds a duration formatter for numeric fields.
|
||||
* {k4issue}2964[Issue 2964]: Adds a setting to configure the default columns visible in the Discover tab.
|
||||
* {k4issue}6379[Issue 6379]: Adds a title case formatter for string fields.
|
||||
|
|
|
@ -280,6 +280,7 @@ you'll need to update your `kibana.yml` file. You can also enable SSL and set a
|
|||
|
||||
include::kibana-yml.asciidoc[]
|
||||
|
||||
////
|
||||
deprecated[4.2, The names of several Kibana server properties changed in the 4.2 release of Kibana. The previous names remain as functional aliases, but are now deprecated and will be removed in a future release of Kibana]
|
||||
|
||||
[horizontal]
|
||||
|
@ -409,6 +410,7 @@ you are using a self-signed certificate so the certificate can be verified. Disa
|
|||
`logging.dest` added[4.2]:: The location where you want to store the Kibana's log output. If not specified, log output is written to standard output and not stored. Specifying a log file suppresses log writes to standard output.
|
||||
+
|
||||
*alias*: `log_file` deprecated[4.2]
|
||||
////
|
||||
|
||||
[[managing-saved-objects]]
|
||||
=== Managing Saved Searches, Visualizations, and Dashboards
|
||||
|
|
|
@ -9,8 +9,8 @@ All you need is:
|
|||
** URL of the Elasticsearch instance you want to connect to.
|
||||
** Which Elasticsearch indices you want to search.
|
||||
|
||||
NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[Shield], see
|
||||
{shield}/kibana.html#using-kibana4-with-shield[Shield with Kibana 4] for additional setup instructions.
|
||||
NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[{scyld}], see
|
||||
{shield}/kibana.html#using-kibana4-with-shield[{scyld} with Kibana] for additional setup instructions.
|
||||
|
||||
[float]
|
||||
[[install]]
|
||||
|
@ -18,7 +18,7 @@ NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/o
|
|||
|
||||
To get Kibana up and running:
|
||||
|
||||
. Download the https://www.elastic.co/downloads/kibana[Kibana 4 binary package] for your platform.
|
||||
. Download the https://www.elastic.co/downloads/kibana[Kibana {version} binary package] for your platform.
|
||||
. Extract the `.zip` or `tar.gz` archive file.
|
||||
. After installing, run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows).
|
||||
|
||||
|
@ -81,10 +81,9 @@ simply be the name of a single index.
|
|||
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. Starting in the 2.1 release, Elasticsearch includes
|
||||
sophisticated date parsing APIs that Kibana uses to determine date information, removing the need to specify dates in the
|
||||
index pattern name.
|
||||
WARNING: Using event times to create index names is *deprecated* in this release of Kibana. Starting in the 2.1
|
||||
release, Elasticsearch 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 *Settings > Indices*.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue