Final pass on doc

Change-Id: I7c8e85eeaf6c1df7a9a70ffd2163d1a970d6b74b
This commit is contained in:
Patrick Petit 2016-03-14 19:28:32 +01:00 committed by Simon Pasquier
parent 8e80adce62
commit a4f679dbd5
3 changed files with 17 additions and 17 deletions

View File

@ -3,8 +3,8 @@
Installation Guide
==================
Elasticsearch-Kibana Fuel Plugin install using the RPM file of the Fuel Plugins Catalog
---------------------------------------------------------------------------------------
Elasticsearch-Kibana Fuel Plugin Installation using the RPM file of the Fuel Plugins Catalog
--------------------------------------------------------------------------------------------
To install the Elasticsearch-Kibana Fuel Plugin using the RPM file of the Fuel Plugins
Catalog, you need to follow these steps:
@ -27,8 +27,8 @@ Catalog, you need to follow these steps:
---|----------------------|---------|----------------
1 | elasticsearch_kibana | 0.9.0 | 4.0.0
Elasticsearch-Kibana Fuel Plugin install from source
----------------------------------------------------
Elasticsearch-Kibana Fuel Plugin installation from source
---------------------------------------------------------
Alternatively, you may want to build the RPM file of the plugin from source
if, for example, you want to test the latest features, modify some built-in
@ -36,7 +36,7 @@ configuration or implement your own customization.
But note that running a Fuel plugin that you have built yourself is at your own risk.
To install Elasticsearch-Kibana Plugin from source, you first need to prepare an
environement to build the RPM file.
environment to build the RPM file.
The recommended approach is to build the RPM file directly onto the Fuel Master
node so that you won't have to copy that file later on.
@ -55,9 +55,9 @@ node so that you won't have to copy that file later on.
[root@home ~] pip install fuel-plugin-builder
**Note**: You may also need to build the Fuel Plugin Builder if the package version of the
plugin is higher than package version supported by the Fuel Plugin Builder you get from `pypi`.
plugin is higher than the package version supported by the Fuel Plugin Builder you get from `pypi`.
In this case, please refer to the section "Preparing an environment for plugin development"
of the `Fuel Plugins wiki <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
of the `Fuel Plugins wiki <https://wiki.openstack.org/wiki/Fuel/Plugins>`_,
if you need further instructions about how to build the Fuel Plugin Builder.
4. Clone the plugin git repository::

View File

@ -66,5 +66,5 @@ Key terms, acronyms and abbreviations
| | of Lucene behind a simple, coherent, RESTful API. |
+----------------------------+--------------------------------------------------------------------------------------+
| Kibana | An open source (Apache Licensed), browser based analytics and search dashboard for |
| | Elasticsearch. Kibana is easry to setup and start using. |
| | Elasticsearch. Kibana is easy to setup and start using. |
+----------------------------+--------------------------------------------------------------------------------------+

View File

@ -120,7 +120,7 @@ Here is how to proceed.
curl http://10.109.1.5:9200/
The output should look like something like this::
The output should look like this::
{
"status" : 200,
@ -151,7 +151,7 @@ Dashboards management
The *Elasticsearch-Kibana Server Plugin* comes with two predefined dashboards:
- The *Logs Dashboard* that is the Kibana Home Dashboard for viewing the log messages.
- The *Logs Dashboard* which is the Kibana Home Dashboard for viewing the log messages.
- The *Notifications Dashboard* for viewing the OpenStack notifications if you enabled
this option in the LMA Collector settings.
@ -198,9 +198,9 @@ Filters and queries have similar syntax but they are used for different purposes
- The queries are used for free-text search.
You can also combine multiple queries and compare their results.
To further filter the log messages based, for example, on the deployment_id,
you need to expand a log entry and then select the deployment_id field by clicking
on the magnifying glass icon as shown below.
To further filter the log messages to, for example, select the *deployment_id*,
you need to expand a log entry and then select the *deployment_id* field
by clicking on the magnifying glass icon as shown below.
.. image:: ../images/kibana_logs_filter1.png
:align: center
@ -213,9 +213,9 @@ This will apply a new filter in the dashboard.
:width: 800
Filtering will work for any field that has been indexed for the log entries that
are displayed in the dashboard.
are in the dashboard.
Filters and queries can also use wildcards wich can be conbined with *field names* like in::
Filters and queries can also use wildcards which can be combined with *field names* like in::
programname: <name>*
@ -223,7 +223,7 @@ For example, to display only the Nova logs you could enter::
programname:nova*
in the query textbox like shown below.
in the query textbox as shown below.
.. image:: ../images/kibana_logs_query1.png
:align: center
@ -245,7 +245,7 @@ Troubleshooting
---------------
If you cannot access the Kibana dashboard or you get no data in the dashboard,
follow these troubleshoot tips.
follow these troubleshooting tips.
1. First, check that the LMA Collector is running properly by following the
LMA Collector troubleshooting instructions in the