wip

kcech · Nov 9, 2020 · 8e1b1ac · 8e1b1ac
1 parent 4a7a7a4
commit 8e1b1ac
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 48 deletions.
diff --git a/docs/catalog_and_maps/administration_console.rst b/docs/catalog_and_maps/administration_console.rst
@@ -1357,8 +1357,7 @@ New internal monitor API runs on different port that the Sentilo API. It's port
 
    monitor.port=7081
 
-
-The agent *sentilo-agent-metrics-monitor* gathers these metrics and persists them in Elasticsearch.
+The agent `Metrics Monitor Agent <./integrations.html#metrics-monitor-agent>`__ gathers these metrics and persists them in Elasticsearch.
 
 
 .. |ComponentsTypes.png| image:: ../_static/images/catalog_and_maps/ComponentsTypes.png

diff --git a/docs/catalog_and_maps/statistics_page.rst b/docs/catalog_and_maps/statistics_page.rst
@@ -1,13 +1,10 @@
-Sentilo monitoring
-------------------
+Statistics page
+---------------
 
 The public section of the Catalog allows us to display some Sentilo statistics through a set
 of features/pages which allow us to inspect the current platform
 activity and to display the components/sensors over a map.
 
-Statistics
-~~~~~~~~~~
-
 The statistic dashboard, which is accessible from the top menu bar,
 displays some basic use indicators, like total requests processed,
 number of sensors registered, current requests per second, max daily
@@ -27,14 +24,15 @@ graph is automatically updated every 5 minutes.
 Navigate the last data chart
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-You can navigate along the dates of the graph by using the buttons
-located in the lower right corner of it:
 
-|chart_controls.png|
+.. note::
+
+   You can navigate along the dates of the graph by using the buttons located in the lower right corner of it:
+   |chart_controls.png|
 
--  **left arrow**: navigate to the past (only if there are older data)
--  **reload data (center button)**: reload last data / reset chart data
--  **right arrow**: navigate to the future (only if you have navigated
+   -  **left arrow**: navigate to the past (only if there are older data)
+   -  **reload data (center button)**: reload last data / reset chart data
+   -  **right arrow**: navigate to the future (only if you have navigated
    or gone into the past before)
 
 .. |stats_001.jpg| image:: ../_static/images/catalog_and_maps/stats_001.jpg

diff --git a/docs/integrations.rst b/docs/integrations.rst
@@ -408,6 +408,38 @@ The Kafka agent publishes Sentilo events to Kafka.
 Sentilo has been successfully used in with these versions:
 
 -  Kafka 0.11.0
+-  Kafka 0.10.2
+
+
+Metrics Monitor Agent
+~~~~~~~~~~~~~~~~~~~~~
+
+The agent persists internal Sentilo metrics, such as memory usage or number of threads and persists them in Elasticsearch.
+
+Elasticsearch template definition for this agent is located in
+/sentilo-agent-metrics-monitor/src/main/resources/elasticsearch. The template name is *sentilo-metrics* and the index pattern
+created by the agent is *sentilo-metrics**.
+
+The configuration /sentilo/sentilo-agent-metrics-monitor/src/main/resources/properties/monitor-config.properties
+and it's same as for the `Activity Monitor Agent`_. Example configuration:
+
+..
+
+   # Endpoint for elasticsearch
+   elasticsearch.url=http://localhost:9200
+
+   # Properties to configure the index process
+   batch.size=1
+   batch.workers.size=3
+   batch.max.retries=1
+
+
+The difference with the Activity Monitor agent is the Redis topic in subscription.properties:
+
+..
+
+   batch.max.retries=/metrics/*
+
 
 
 Node-red
@@ -471,33 +503,3 @@ In the end, you will be able to visualize private links in S3, for example:
 
 `see more <./services/subscription/subscription.html>`__
 
-
-Metrics Monitor Agent
----------------------
-
-The agent persists internal Sentilo metrics, such as memory usage or number of threads and persists them in Elasticsearch.
-
-Elasticsearch template definition for this agent is located in
-/sentilo-agent-metrics-monitor/src/main/resources/elasticsearch. The template name is *sentilo-metrics* and the index pattern
-created by the agent is *sentilo-metrics**.
-
-The configuration /sentilo/sentilo-agent-metrics-monitor/src/main/resources/properties/monitor-config.properties
-and it's same as for the `Activity Monitor Agent`_. Example configuration:
-
-..
-
-   # Endpoint for elasticsearch
-   elasticsearch.url=http://localhost:9200
-
-   # Properties to configure the index process
-   batch.size=1
-   batch.workers.size=3
-   batch.max.retries=1
-
-
-The difference with the Activity Monitor agent is the Redis topic in subscription.properties:
-
-..
-
-   batch.max.retries=/metrics/*
-
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -4,24 +4,24 @@ Quickstart
 Prequisites
 -----------
 
-After checking the `Sentilo Setup <./setup.html>`__. No need to setup any
-agents or other optional components such as Elasticsearch or OpenTSDB.
-
 You should have 4 components up & running:
-
 -  Redis Server
 -  MongoDB
 -  Sentilo API, running at http://127.0.0.1:8081
 -  Sentilo Catalog, running at http://127.0.0.1:8080/sentilo-catalog-web
 
+The installation covered by the section  `Sentilo Setup <./setup.html>`__.
+( No need to setup any agents or other optional components such as Elasticsearch or OpenTSDB).
+Alternatively, you can use our `VM  <./use_a_virtual_machine.html>`__.
+
 Create a Provider, Component and a Sensor
 -----------------------------------------
 
 In order to create a publication of sensor data, we have to create first
 the Provider, Component and a Sensor.
 
 We’ll do that from the catalog application as superuser, using the
-admin/admin credentials.
+admin/1234 credentials.
 
 A provider is an entity that manages devices (sensors). We’ll have to
 create one from the menu “Providers” -> “New Provider”