kibana/README.md

59 lines
2.8 KiB
Markdown
Raw Normal View History

2014-09-18 22:45:51 +02:00
<!-- render {"template":"# Kibana <%= pkg.version %>"} -->
# Kibana 4.0.0-BETA1
<!-- /render -->
2014-03-04 19:58:10 +01:00
2014-09-18 22:45:25 +02:00
[![Build Status](https://magnum.travis-ci.com/elasticsearch/kibana4.svg?token=tsFxSKHtVKG8EZavSjXY&branch=master)](https://magnum.travis-ci.com/elasticsearch/kibana4)
Kibana is an open source (Apache Licensed), browser based analytics and search dashboard for Elasticsearch. Kibana is a snap to setup and start using. Kibana strives to be easy to get started with, while also being flexible and powerful, just like Elasticsearch.
## Installation
* Download: http://www.elasticsearch.org/overview/kibana/installation/
* Run **bin/kibana** on unix, or **bin/kibana.bat** on Windows.
* Visit http://localhost:5601
## Need Help?
Need help? Try #elasticsearch or #logstash on Freenode IRC. You can also find help on the elasticsearch-users@googlegroups.com or logstash-users@googlegroups.com mailing lists.
You can also find documentation at http://www.elasticsearch.com/guide/en/kibana/current
2014-09-18 23:26:40 +02:00
<!-- include {"path":"docs/settings.md"} -->
2014-09-18 22:45:51 +02:00
# Settings
The settings application is broken up into three pages: Indices, Advanced, and Object.
## Indices
2014-09-18 23:39:08 +02:00
The Indices page manages Index Patterns. Before you can do anything in Kibana you will need to create an Index Pattern to use in other parts of the application. Index Patterns represent one or more indices in Elasticsearch and track associated meta-data, like field types and pattern interval.
2014-09-18 22:45:51 +02:00
2014-09-18 23:39:08 +02:00
### Creating an Index Pattern
2014-09-18 23:29:00 +02:00
2014-09-18 23:39:08 +02:00
If this is your first time in Kibana you'll be prompted to create your first index pattern. For more information on index pattern creation see the **Getting Started** section of the documentation.
2014-09-18 23:29:00 +02:00
2014-09-18 22:45:51 +02:00
## Advanced
2014-09-18 23:29:00 +02:00
Please, **use caution** on this page, because the advanced editor will let you break things.
The Advanced page allows modification of individual configuration parameters. Each of these parameters can be tweaked to customize the entire Kibana installation. This means that your changes will apply to all users. This could prevent the application from loading if used incorrectly.
### Edit
### Save
### Delete
2014-09-18 22:45:51 +02:00
## Objects
2014-09-18 23:39:08 +02:00
Please, **use caution** on this page. No support is available for changes made here.
2014-09-18 23:29:00 +02:00
2014-09-18 23:39:08 +02:00
The Objects page manages all of the objects created by Kibana (except Index Patterns which are handled by the Indices page). Most apps give you all the tools needed to manage objects they create, but if/when they fall short, you can come here to tweak the specifics.
2014-09-18 23:29:00 +02:00
### View
Clicking on the *View* action loads that item in the associated applications. Refer to the documentation for the associated applications if you need help using them.
### Edit
2014-09-18 22:45:51 +02:00
2014-09-18 23:39:08 +02:00
The edit button will allow you to edit the schema of the stored object. Note this operation is for advanced users only. Making changes here can break large portions of the application.
2014-09-18 22:45:51 +02:00
<!-- /include -->