github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fixed a bad link in setup.asciidoc

Browse source
This commit is contained in:
Clinton Gormley 2015-06-10 21:58:29 +02:00
parent fc8a2bf9cc
commit 6e4a57f73a
1 changed files with 24 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

48
docs/setup.asciidoc
View file

@ -9,7 +9,7 @@ All you need is:
** URL of the Elasticsearch instance you want to connect to. ** URL of the Elasticsearch instance you want to connect to.
** Which Elasticsearch indices you want to search. ** Which Elasticsearch indices you want to search.
NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[Shield] see NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[Shield] see
{shield}/_shield_with_kibana_4.html[Shield with Kibana 4] for additional setup instructions. {shield}/_shield_with_kibana_4.html[Shield with Kibana 4] for additional setup instructions.
[float] [float]
@ -22,10 +22,10 @@ To get Kibana up and running:
. Extract the `.zip` or `tar.gz` archive file. . Extract the `.zip` or `tar.gz` archive file.
// On Unix, you can instead run the package manager suited for your distribution. // On Unix, you can instead run the package manager suited for your distribution.
// //
// [float] // [float]
// include::kibana-repositories.asciidoc[] // include::kibana-repositories.asciidoc[]
// //
After installing, run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows). After installing, run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows).
That's it! Kibana is now running on port 5601. That's it! Kibana is now running on port 5601.
@ -33,12 +33,12 @@ That's it! Kibana is now running on port 5601.
[float] [float]
[[kibana-dynamic-mapping]] [[kibana-dynamic-mapping]]
==== Kibana and Elasticsearch Dynamic Mapping ==== Kibana and Elasticsearch Dynamic Mapping
By default, Elasticsearch enables {ref}/dynamic-mapping.html[dynamic mapping] for fields. Kibana needs dynamic mapping By default, Elasticsearch enables {ref}mapping-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, to use fields in visualizations correctly, as well as to manage the `.kibana` index where saved searches,
visualizations, and dashboards are stored. visualizations, and dashboards are stored.
If your Elasticsearch use case requires you to disable dynamic mapping, you need to manually provide mappings for 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` fields that Kibana uses to create visualizations. You also need to manually enable dynamic mapping for the `.kibana`
index. index.
The following procedure assumes that the `.kibana` index does not already exist in Elasticsearch and that the The following procedure assumes that the `.kibana` index does not already exist in Elasticsearch and that the
@ -58,13 +58,13 @@ PUT .kibana
[float] [float]
[[connect]] [[connect]]
=== Connect Kibana with Elasticsearch === 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 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. 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 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>>. <<settings-create-pattern,Settings tab>>.
TIP: By default, Kibana connects to the Elasticsearch instance running on `localhost`. To connect to a different 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. For Elasticsearch instance, modify the Elasticsearch URL in the `kibana.yml` configuration file and restart Kibana. For
information about using Kibana with your production nodes, see <<production>>. information about using Kibana with your production nodes, see <<production>>.
To configure the Elasticsearch indices you want to access with Kibana: To configure the Elasticsearch indices you want to access with Kibana:
@ -73,22 +73,22 @@ To configure the Elasticsearch indices you want to access with Kibana:
+ +
image:images/Start-Page.jpg[Kibana start page] image:images/Start-Page.jpg[Kibana start page]
+ +
. Specify an index pattern that matches the name of one or more of your Elasticsearch indices. By default, Kibana . 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 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 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 your Elasticsearch indices follow some other naming convention, enter an appropriate pattern. The "pattern" can also
simply be the name of a single index. 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 . 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, 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. disable the *Index contains time-based events* option.
. If new indices are generated periodically and have a timestamp appended to the name, select the *Use event times to . If new indices are generated periodically and have a timestamp appended to the name, select the *Use event times to
create index names* option and select the *Index pattern interval*. This improves search performance by enabling Kibana create index names* option and select the *Index pattern interval*. This improves search performance by enabling Kibana
to search only those indices that could contain data in the time range you specify. This is primarily applicable if you to search only those indices that could contain data in the time range you specify. This is primarily applicable if you
are using Logstash to feed data into Elasticsearch. are using Logstash to feed data into Elasticsearch.
. Click *Create* to add the index pattern. This first pattern is automatically configured as the default. . 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*. When you have more than one index pattern, you can designate which one to use as the default from *Settings > Indices*.
Voila! Kibana is now connected to your Elasticsearch data. Kibana displays a read-only list of fields configured for Voila! Kibana is now connected to your Elasticsearch data. Kibana displays a read-only list of fields configured for
the matching index. the matching index.
[float] [float]
@ -100,5 +100,5 @@ You're ready to dive in to your data:
* Chart and map your data from the <<visualize, Visualize>> page. * Chart and map your data from the <<visualize, Visualize>> page.
* Create and view custom dashboards from the <<dashboard, Dashboard>> page. * Create and view custom dashboards from the <<dashboard, Dashboard>> page.
For a brief tutorial that explores these core Kibana concepts, take a look at the <<getting-started, Getting For a brief tutorial that explores these core Kibana concepts, take a look at the <<getting-started, Getting
Started>> page. Started>> page.