wip

kcech · Nov 9, 2020 · 4a7a7a4 · 4a7a7a4
1 parent 6c6d347
commit 4a7a7a4
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 5 deletions.
diff --git a/...s/catalog_and_maps/monitoring_190_001.png → ...ages/catalog_and_maps/metrics_190_001.png b/...s/catalog_and_maps/monitoring_190_001.png → ...ages/catalog_and_maps/metrics_190_001.png
diff --git a/...s/catalog_and_maps/monitoring_190_002.png → ...ages/catalog_and_maps/metrics_190_002.png b/...s/catalog_and_maps/monitoring_190_002.png → ...ages/catalog_and_maps/metrics_190_002.png
diff --git a/docs/catalog_and_maps/administration_console.rst b/docs/catalog_and_maps/administration_console.rst
@@ -1330,6 +1330,35 @@ icon for the new typology.
 
 |componenttypes_170_002.jpg|
 
+Metrics
+~~~~~~~
+
+The new *Metrics* section provides a real-time monitoring of all Sentilo modules, including agents.
+This information is useful when you want to rapidly assess the state of the service. However, for
+production monitoring, we recommend to also setup some process watcher and alerting system.
+
+Example of the timeline:
+
+|metrics_190_001.png|
+
+Example of dashboard:
+
+|metrics_190_002.png|
+
+.. note::
+
+   Since the metrics are in real-time only, no history is shown unless you leave the Metrics page open for a while.
+   The page will show graphics for this time. If you reload the page, the history will be reset.
+
+New internal monitor API runs on different port that the Sentilo API. It's port number is configured in
+/sentilo-platform/sentilo-platform-server/src/main/resources/properties/config.properties. The default value is 7081.
+
+..
+
+   monitor.port=7081
+
+
+The agent *sentilo-agent-metrics-monitor* gathers these metrics and persists them in Elasticsearch.
 
 
 .. |ComponentsTypes.png| image:: ../_static/images/catalog_and_maps/ComponentsTypes.png
@@ -1379,3 +1408,5 @@ icon for the new typology.
 .. |sensorstypes_170_002.jpg| image:: ../_static/images/catalog_and_maps/sensorstypes_170_002.jpg
 .. |componenttypes_170_001.jpg| image:: ../_static/images/catalog_and_maps/componenttypes_170_001.jpg
 .. |componenttypes_170_002.jpg| image:: ../_static/images/catalog_and_maps/componenttypes_170_002.jpg
+.. |metrics_190_001.png| image:: ../_static/images/catalog_and_maps/metrics_190_001.png
+.. |metrics_190_002.png| image:: ../_static/images/catalog_and_maps/metrics_190_002.png
diff --git a/docs/catalog_and_maps/map_viewers.rst b/docs/catalog_and_maps/map_viewers.rst
@@ -119,14 +119,14 @@ any OGC WMS/WMTS service that provides a EPSG 3857 SRID.
 
 The configuration of both is in in /sentilo-catalog-web/src/main/resources/properties/catalog-config.properties.
 
-Example of a Google maps configuration
+Example of Google Maps configuration
 
 ::
 
    catalog.map.provider=gmaps
    catalog.map.google.key=AIza...
 
-Example of a Leaflet maps configuration, using a public Terrestris WMS service:
+Example of Leaflet maps configuration, using a public Terrestris WMS service:
 
 ::
 
@@ -138,6 +138,10 @@ Example of a Leaflet maps configuration, using a public Terrestris WMS service:
    catalog.map.wms.attribution=Terrestris
    catalog.map.wms.styles=
 
+.. note::
+
+   If you insert multiple layers in the *catalog.map.wms.layers* property, a layer selector
+   in the bottom-right corner of the map will appear.
 
 .. |universal_viewer_170_001.jpg| image:: ../_static/images/catalog_and_maps/universal_viewer_170_001.jpg
 .. |universal_viewer_170_002.jpg| image:: ../_static/images/catalog_and_maps/universal_viewer_170_002.jpg

diff --git a/docs/integrations.rst b/docs/integrations.rst
@@ -291,7 +291,7 @@ Sentilo has been successfully used in with these versions:
 
 
 Federation agent
-~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~
 
 **Description**
 
@@ -361,7 +361,7 @@ The "Client application token" input is the token created in the emitting Sentil
 
 
 Kafka agent
-~~~~~~~~~~~~~~~
+~~~~~~~~~~~
 
 **Description**
 
@@ -469,4 +469,35 @@ In the end, you will be able to visualize private links in S3, for example:
 .. image:: _static/images/integrations/catalog-s3-audio-preview.png
 
 
-`see more <./services/subscription/subscription.html>`__
+`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/*
+