From e11c6b0d710e3600d082837b0fe972c1fc45cebe Mon Sep 17 00:00:00 2001 From: Alicja Kwasniewska Date: Fri, 10 Mar 2017 15:50:03 +0000 Subject: [PATCH] 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 --- deploy-guide/source/central-logging-guide.rst | 2 + deploy-guide/source/kibana-guide.rst | 2 - deploy-guide/source/kolla-ansible-index.rst | 2 +- ...na-guide.rst => central-logging-guide.rst} | 39 +++++++++++++------ doc/index.rst | 2 +- 5 files changed, 32 insertions(+), 15 deletions(-) create mode 100644 deploy-guide/source/central-logging-guide.rst delete mode 100644 deploy-guide/source/kibana-guide.rst rename doc/{kibana-guide.rst => central-logging-guide.rst} (89%) diff --git a/deploy-guide/source/central-logging-guide.rst b/deploy-guide/source/central-logging-guide.rst new file mode 100644 index 0000000000..ef6621381e --- /dev/null +++ b/deploy-guide/source/central-logging-guide.rst @@ -0,0 +1,2 @@ +.. central-logging-guide.rst: +.. include:: ../../doc/central-logging-guide.rst diff --git a/deploy-guide/source/kibana-guide.rst b/deploy-guide/source/kibana-guide.rst deleted file mode 100644 index 6b0b5ea944..0000000000 --- a/deploy-guide/source/kibana-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. kibana-guide.rst: -.. include:: ../../doc/kibana-guide.rst diff --git a/deploy-guide/source/kolla-ansible-index.rst b/deploy-guide/source/kolla-ansible-index.rst index 490c1b2ae7..3936e73d27 100644 --- a/deploy-guide/source/kolla-ansible-index.rst +++ b/deploy-guide/source/kolla-ansible-index.rst @@ -27,13 +27,13 @@ Services :maxdepth: 2 bifrost.rst + central-logging-guide.rst ceph-guide.rst cinder-guide.rst cinder-guide-hnas.rst designate-guide.rst external-ceph-guide.rst ironic-guide.rst - kibana-guide.rst kuryr-guide.rst manila-guide.rst manila-hnas-guide.rst diff --git a/doc/kibana-guide.rst b/doc/central-logging-guide.rst similarity index 89% rename from doc/kibana-guide.rst rename to doc/central-logging-guide.rst index dc0441fbd0..e571a93481 100644 --- a/doc/kibana-guide.rst +++ b/doc/central-logging-guide.rst @@ -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 successfully monitor this and use it to diagnose problems, the standard "ssh 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 ========================== @@ -21,6 +18,26 @@ the following: 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 ``:5601``. @@ -39,7 +56,7 @@ After setting parameters, create an index by clicking the ``Create`` button. in Kolla. Search logs - Discover tab -========================== +-------------------------- Operators can create and store searches based on various fields from logs, for 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. Visualize data - Visualize tab -============================== +------------------------------ 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 @@ -123,7 +140,7 @@ of the left-side menu. will be lost after leaving a page or creating another visualization. Organize visualizations and searches - Dashboard tab -==================================================== +---------------------------------------------------- In the Dashboard tab all of saved visualizations and searches can be 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. Exporting and importing created items - Settings tab -==================================================== +---------------------------------------------------- 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 diff --git a/doc/index.rst b/doc/index.rst index c9685547cf..c32f9371f4 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -63,6 +63,7 @@ Kolla Services :maxdepth: 1 ceph-guide + central-logging-guide external-ceph-guide cinder-guide cinder-guide-hnas @@ -71,7 +72,6 @@ Kolla Services manila-guide manila-hnas-guide swift-guide - kibana-guide bifrost networking-guide kuryr-guide