WARNING: Version 4.5 of Kibana has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Introduction Installing Kibana with apt and yum »
Elastic Docs ›Kibana User Guide [4.5]

Setting Up Kibana

edit

Setting Up Kibana

edit

You can install Kibana and start exploring your Elasticsearch indices in minutes. All you need is:

  • Elasticsearch 2.3 or later
  • A modern web browser - Supported Browsers.

  • Information about your Elasticsearch installation:

    • URL of the Elasticsearch instance you want to connect to.
    • Which Elasticsearch indices you want to search.

Install Kibana

edit

To install and start Kibana:

  1. Download the Kibana 4 binary package for your platform.
  2. Extract the .zip or tar.gz archive file.
  3. If you’re upgrading, migrate any configuration changes from the previous kibana.yml to the new version.
  4. Install Kibana plugins (optional).
  5. 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.

On Unix, you can also install Kibana using the package manager suited for your distribution. For more information, see Installing Kibana with apt and yum.

If your Elasticsearch installation is protected by Shield see Using Kibana with Shield for additional setup instructions.

Connect Kibana with Elasticsearch

edit

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 tab.

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 Using Kibana in a Production Environment.

To configure the Elasticsearch indices you want to access with Kibana:

  1. Point your browser at port 5601 to access the Kibana UI. For example, localhost:5601 or http://YOURDOMAIN.com:5601.

    Kibana start page

  2. 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.

  3. 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.

    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.

  4. 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.

Voila! Kibana is now connected to your Elasticsearch data. Kibana displays a read-only list of fields configured for the matching index.

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 and Elasticsearch Dynamic Mapping.

Start Exploring your Data!

edit

You’re ready to dive in to your data:

  • Search and browse your data interactively from the Discover page.
  • Chart and map your data from the Visualize page.
  • Create and view custom dashboards from the Dashboard page.

For a step-by-step introduction to these core Kibana concepts, see the Getting Started tutorial.

Kibana and Elasticsearch Dynamic Mapping

edit

By default, Elasticsearch enables 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 mapping for the .kibana index.

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:

  1. Start Elasticsearch.

  2. Create the .kibana index with dynamic mapping enabled just for that index:

    PUT .kibana
{
	"index.mapper.dynamic": true
}
  3. Start Kibana and navigate to the web UI and verify that there are no error messages related to dynamic mapping.
« Introduction Installing Kibana with apt and yum »