2013-05-13 10:53:31 -05:00
|
|
|
# Kibana
|
2013-01-25 22:00:59 -06:00
|
|
|
|
2013-05-14 11:27:15 -05:00
|
|
|
__NOTE__: You have reached the Kibana 3 repository.
|
|
|
|
|
Kibana 3 is completely new version of Kibana written entirely in HTML and Javascript. You can find
|
|
|
|
|
the Kibana 2 repository at [https://github.com/rashidkpc/Kibana](https://github.com/rashidkpc/Kibana)
|
2013-01-25 22:10:28 -06:00
|
|
|
|
2013-05-22 15:45:14 -05:00
|
|
|
### Important!
|
|
|
|
|
The index pattern format has changed in Kibana 3 milestone 2. Please update your index pattern in the
|
|
|
|
|
timepicker panel for any dashboards you've built. The default has been updated.
|
|
|
|
|
|
2013-05-14 11:27:15 -05:00
|
|
|
More information about Kibana 3 can be found at [http://three.kibana.org](http://three.kibana.org)
|
2013-01-25 22:10:28 -06:00
|
|
|
|
2013-05-13 10:53:31 -05:00
|
|
|
## Overview
|
2013-01-25 22:10:28 -06:00
|
|
|
|
2013-05-14 11:27:15 -05:00
|
|
|
Kibana is an open source (Apache Licensed), browser based analytics and search interface to Logstash
|
|
|
|
|
and other timestamped data sets stored in ElasticSearch. With those in place Kibana is a snap to
|
|
|
|
|
setup and start using (seriously). Kibana strives to be easy to get started with, while also being
|
|
|
|
|
flexible and powerful
|
2013-01-25 22:10:28 -06:00
|
|
|
|
2013-05-13 10:53:31 -05:00
|
|
|
### Requirements
|
2013-05-14 11:27:15 -05:00
|
|
|
* A modern web browser. The latest version of Chrome, Safari and Firefox have all been tested to
|
|
|
|
|
work. IE8 is not currently supported
|
2013-05-13 10:53:31 -05:00
|
|
|
* A webserver. No extensions are required, as long as it can serve plain html it will work
|
2013-05-14 11:27:15 -05:00
|
|
|
* A browser reachable Elasticsearch server. Port 9200 must be open, or a proxy configured to allow
|
|
|
|
|
access to it.
|
2013-01-25 22:10:28 -06:00
|
|
|
|
2013-05-13 10:53:31 -05:00
|
|
|
### Installation
|
|
|
|
|
|
|
|
|
|
1. Copy the entire Kibana directory to your webserver
|
2013-05-14 11:27:15 -05:00
|
|
|
2. Edit config.js to point to your elasticsearch server. This should __not be
|
|
|
|
|
http://localhost:9200__, but rather the fully qualified domain name of your elasticsearch server.
|
|
|
|
|
The url entered here _must be reachable_ by your browser.
|
|
|
|
|
3. Point your browser at your installation. If you're using Logstash with the default indexing
|
|
|
|
|
configuration the default Kibana dashboard should work nicely.
|
|
|
|
|
|
|
|
|
|
### FAQ
|
|
|
|
|
__Q__: Why doesnt it work? I have http://localhost:9200 in my config.js, my webserver and elasticsearch
|
2013-05-14 11:30:00 -05:00
|
|
|
server are on the same machine
|
2013-05-14 11:27:15 -05:00
|
|
|
__A__: Kibana 3 does not work like previous versions of Kibana. To ease deployment, the server side
|
|
|
|
|
component has been eliminated. Thus __the browser connects directly to Elasticsearch__. The default
|
|
|
|
|
config.js setup works for the webserver+Elasticsearch on the same machine scenario. Do not set it
|
|
|
|
|
to http://localhost:9200 unless your browser Wnd elasticsearch are on the same machine
|
|
|
|
|
|
2013-05-14 11:30:00 -05:00
|
|
|
__Q__: How do I secure this? I don't want to leave 9200 open.
|
2013-05-30 05:24:53 -05:00
|
|
|
__A__: A simple nginx virtual host and proxy configuration can be found in the sample/nginx.conf
|
2013-05-13 10:53:31 -05:00
|
|
|
|
|
|
|
|
### Support
|
2013-05-14 11:27:15 -05:00
|
|
|
|
|
|
|
|
Introduction videos can be found at [http://three.kibana.org/about.html](http://three.kibana.org/about.html)
|
2013-05-13 10:53:31 -05:00
|
|
|
If you have questions or comments the best place to reach me is #logstash or #elasticsearch on irc.freenode.net
|
