Add PM-Mapper files processing config description

[dcaegen2.git] / docs / sections / services / pm-mapper / configuration.rst

diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst
index c699a35..df7423a 100644 (file)
--- a/docs/sections/services/pm-mapper/configuration.rst
+++ b/docs/sections/services/pm-mapper/configuration.rst
@@ -4,6 +4,44 @@
 Configuration and Performance
 =============================
 
+Files Processing Configuration
+""""""""""""""""""""""""""""""
+The PM Mapper consumes the 3GPP XML files from DMaaP-DR, and processes them. It is possible to process it in parallel.
+In order to parallel processing, new configuration env has been introduced:
+
+- PROCESSING_LIMIT_RATE (optional, default value: 1) - allows to limit the rate of processing files through channel.
+
+- THREADS_MULTIPLIER (optional, default value: 1) - allows to specify multiplier to calculate the amount of threads.
+
+- PROCESSING_THREADS_COUNT (optional, default value: number of threads available to JVM) - allows to specify number of threads that will be used for files processing.
+
+
+Envs should be specified in section "envs:" in blueprint. Example part of blueprint configuration:
+
+::
+
+        ...
+        pm-mapper:
+          type: dcae.nodes.ContainerizedServiceComponentUsingDmaap
+          interfaces:
+            cloudify.interfaces.lifecycle:
+              create:
+                inputs:
+                  ports:
+                    - '8443:0'
+                    - '8081:0'
+                  envs:
+                    PROCESSING_LIMIT_RATE: "1"
+                    THREADS_MULTIPLIER: "2"
+                    PROCESSING_THREADS_COUNT: "3"
+          relationships:
+            - type: dcaegen2.relationships.subscribe_to_files
+              target: pm-feed
+            - type: dcaegen2.relationships.publish_events
+              target: pm-topic
+        ...
+
+
 PM Mapper Filtering
 """""""""""""""""""
 The PM Mapper performs data reduction, by filtering the PM telemetry data it receives.