docs/sections/services/pm-mapper/configuration.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Configuration and Performance
   5 =============================
   6
   7 Files Processing Configuration
   8 """"""""""""""""""""""""""""""
   9 The PM Mapper consumes the 3GPP XML files from DMaaP-DR, and processes them. It is possible to process it in parallel.
  10 In order to parallel processing, new configuration env has been introduced:
  11
  12 - PROCESSING_LIMIT_RATE (optional, default value: 1) - allows to limit the rate of processing files through channel.
  13
  14 - THREADS_MULTIPLIER (optional, default value: 1) - allows to specify multiplier to calculate the amount of threads.
  15
  16 - 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.
  17
  18
  19 Envs should be specified in section "envs:" in blueprint. Example part of blueprint configuration:
  20
  21 ::
  22
  23         ...
  24         pm-mapper:
  25           type: dcae.nodes.ContainerizedServiceComponentUsingDmaap
  26           interfaces:
  27             cloudify.interfaces.lifecycle:
  28               create:
  29                 inputs:
  30                   ports:
  31                     - '8443:0'
  32                     - '8081:0'
  33                   envs:
  34                     PROCESSING_LIMIT_RATE: "1"
  35                     THREADS_MULTIPLIER: "2"
  36                     PROCESSING_THREADS_COUNT: "3"
  37           relationships:
  38             - type: dcaegen2.relationships.subscribe_to_files
  39               target: pm-feed
  40             - type: dcaegen2.relationships.publish_events
  41               target: pm-topic
  42         ...
  43
  44
  45 PM Mapper Filtering
  46 """""""""""""""""""
  47 The PM Mapper performs data reduction, by filtering the PM telemetry data it receives.
  48 This filtering information is provided to the service as part of its configuration, and is used to identify desired PM measurements (measType) contained within the data.
  49 The service can accept an exact match to the measType or regex(java.util.regex) identifying multiple measTypes (it is possible to use both types simultaneously).
  50 If a filter is provided, any measurement that does not match the filter, will be ignored and a warning will be logged.
  51 PM Mapper expects the filter in the following JSON format:
  52
  53 ::
  54
  55
  56          "filters":[{
  57             "pmDefVsn": "1.3",
  58             "nfType": "gnb",
  59             "vendor": "Ericsson",
  60             "measTypes": [ "attTCHSeizures", "succTCHSeizures", "att.*", ".*Seizures" ]
  61          }]
  62
  63
  64
  65 ====================   ============================      ================================
  66 Field                  Description                       Type
  67 ====================   ============================      ================================
  68 pmDefVsn               PM Dictionary version.            String
  69 vendor                 Vendor of the xNF type.           String
  70 nfType                 nfType is vendor                  String
  71                        defined and should match the
  72                        string used in file ready
  73                        eventName.
  74 measTypes              Measurement name used in PM       List of Strings, Regular expressions
  75                        file in 3GPP format where
  76                        specified, else vendor
  77                        defined.
  78 ====================   ============================      ================================
  79
  80 Message Router Topic Name
  81 """""""""""""""""""""""""
  82 PM Mapper publishes the perf3gpp VES PM Events to the following authenticated MR topic;
  83
  84 ::
  85
  86         org.onap.dmaap.mr.PERFORMANCE_MEASUREMENTS
  87
  88 Performance
  89 ^^^^^^^^^^^
  90
  91 To see the performance of PM Mapper, see "`PM Mapper performance baseline results`_".
  92
  93 .. _PM Mapper performance baseline results: https://wiki.onap.org/display/DW/PM-Mapper+performance+baseline+results