Improved documentation for central logging.

Added a note about Elasticsearch using volume space.
Renamed Kibana guide to central-logging guide.

Change-Id: I0a451b5316a53815a53c62faa2bf993ca34f27e0
Closes-Bug: #1614572
This commit is contained in:
Alicja Kwasniewska 2017-03-10 15:50:03 +00:00
parent c0df4ab8b6
commit e11c6b0d71
5 changed files with 32 additions and 15 deletions

View File

@ -0,0 +1,2 @@
.. central-logging-guide.rst:
.. include:: ../../doc/central-logging-guide.rst

View File

@ -1,2 +0,0 @@
.. kibana-guide.rst:
.. include:: ../../doc/kibana-guide.rst

View File

@ -27,13 +27,13 @@ Services
:maxdepth: 2 :maxdepth: 2
bifrost.rst bifrost.rst
central-logging-guide.rst
ceph-guide.rst ceph-guide.rst
cinder-guide.rst cinder-guide.rst
cinder-guide-hnas.rst cinder-guide-hnas.rst
designate-guide.rst designate-guide.rst
external-ceph-guide.rst external-ceph-guide.rst
ironic-guide.rst ironic-guide.rst
kibana-guide.rst
kuryr-guide.rst kuryr-guide.rst
manila-guide.rst manila-guide.rst
manila-hnas-guide.rst manila-hnas-guide.rst

View File

@ -1,16 +1,13 @@
.. _kibana-guide: .. _central-logging-guide:
=============== ========================
Kibana in Kolla Central Logging in Kolla
=============== ========================
An OpenStack deployment generates vast amounts of log data. In order to An OpenStack deployment generates vast amounts of log data. In order to
successfully monitor this and use it to diagnose problems, the standard "ssh successfully monitor this and use it to diagnose problems, the standard "ssh
and grep" solution quickly becomes unmanageable. and grep" solution quickly becomes unmanageable.
Kolla can deploy Kibana as part of the E*K stack in order to allow operators to
search and visualise logs in a centralised manner.
Preparation and deployment Preparation and deployment
========================== ==========================
@ -21,6 +18,26 @@ the following:
enable_central_logging: "yes" enable_central_logging: "yes"
Elasticsearch
=============
Kolla deploys Elasticsearch as part of the E*K stack to store, organize
and make logs easily accessible.
By default Elasticsearch is deployed on port ``9200``.
.. note::
Elasticsearch stores a lot of logs, so if you are running centralized logging,
remember to give ``/var/lib/docker`` an adequate space.
Kibana
======
Kolla deploys Kibana as part of the E*K stack in order to allow operators to
search and visualise logs in a centralised manner.
After successful deployment, Kibana can be accessed using a browser on After successful deployment, Kibana can be accessed using a browser on
``<kolla_external_vip_address>:5601``. ``<kolla_external_vip_address>:5601``.
@ -39,7 +56,7 @@ After setting parameters, create an index by clicking the ``Create`` button.
in Kolla. in Kolla.
Search logs - Discover tab Search logs - Discover tab
========================== --------------------------
Operators can create and store searches based on various fields from logs, for Operators can create and store searches based on various fields from logs, for
example, "show all logs marked with ERROR on nova-compute". example, "show all logs marked with ERROR on nova-compute".
@ -103,7 +120,7 @@ can still be seen how Kibana helps in tracing this data, particularly in a
large scale deployment scenario. large scale deployment scenario.
Visualize data - Visualize tab Visualize data - Visualize tab
============================== ------------------------------
In the visualization tab a wide range of charts is available. If any In the visualization tab a wide range of charts is available. If any
visualization has not been saved yet, after choosing this tab *Create a new visualization has not been saved yet, after choosing this tab *Create a new
@ -123,7 +140,7 @@ of the left-side menu.
will be lost after leaving a page or creating another visualization. will be lost after leaving a page or creating another visualization.
Organize visualizations and searches - Dashboard tab Organize visualizations and searches - Dashboard tab
==================================================== ----------------------------------------------------
In the Dashboard tab all of saved visualizations and searches can be In the Dashboard tab all of saved visualizations and searches can be
organized in one Dashboard. To add visualization or search, one can choose organized in one Dashboard. To add visualization or search, one can choose
@ -140,7 +157,7 @@ If a Dashboard has already been saved, it can be opened by choosing *open
dashboard* option in the menu on the right. dashboard* option in the menu on the right.
Exporting and importing created items - Settings tab Exporting and importing created items - Settings tab
==================================================== ----------------------------------------------------
Once visualizations, searches or dashboards are created, they can be exported Once visualizations, searches or dashboards are created, they can be exported
to a JSON format by choosing Settings tab and then Objects tab. Each of the to a JSON format by choosing Settings tab and then Objects tab. Each of the

View File

@ -63,6 +63,7 @@ Kolla Services
:maxdepth: 1 :maxdepth: 1
ceph-guide ceph-guide
central-logging-guide
external-ceph-guide external-ceph-guide
cinder-guide cinder-guide
cinder-guide-hnas cinder-guide-hnas
@ -71,7 +72,6 @@ Kolla Services
manila-guide manila-guide
manila-hnas-guide manila-hnas-guide
swift-guide swift-guide
kibana-guide
bifrost bifrost
networking-guide networking-guide
kuryr-guide kuryr-guide