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 .. Copyright 2022 Nokia. All rights reserved.
   4
   5 Configuration and Performance
   6 =============================
   7
   8 Files Processing Configuration
   9 """"""""""""""""""""""""""""""
  10 The PM Mapper consumes the 3GPP XML files from DMaaP-DR, and processes them. It is possible to process it in parallel.
  11 In order to parallel processing, new configuration env has been introduced:
  12
  13 - PROCESSING_LIMIT_RATE (optional, default value: 1) - allows to limit the rate of processing files through channel.
  14
  15 - THREADS_MULTIPLIER (optional, default value: 1) - allows to specify multiplier to calculate the amount of threads.
  16
  17 - 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.
  18
  19
  20 Envs should be specified in section "envs:" in blueprint. Example part of blueprint configuration:
  21
  22 ::
  23
  24         ...
  25         pm-mapper:
  26           type: dcae.nodes.ContainerizedServiceComponentUsingDmaap
  27           interfaces:
  28             cloudify.interfaces.lifecycle:
  29               create:
  30                 inputs:
  31                   ports:
  32                     - '8443:0'
  33                     - '8081:0'
  34                   envs:
  35                     PROCESSING_LIMIT_RATE: "1"
  36                     THREADS_MULTIPLIER: "2"
  37                     PROCESSING_THREADS_COUNT: "3"
  38           relationships:
  39             - type: dcaegen2.relationships.subscribe_to_files
  40               target: pm-feed
  41             - type: dcaegen2.relationships.publish_events
  42               target: pm-topic
  43         ...
  44
  45
  46 .. _pm_mapper_disable_tls:
  47
  48 Disable TLS
  49 """""""""""
  50 Pm-mapper by default uses communication over TLS, but it is also possible to use plain http request. To disable TLS, set configuration flag 'enable_http' to true, and set the certificate paths to empty strings or remove them from the configuration. See the config.yaml examples below.
  51
  52 .. code-block:: yaml
  53
  54   applicationConfig:
  55     enable_http: true
  56     key_store_path: ""
  57     key_store_pass_path: ""
  58     trust_store_path: ""
  59     trust_store_pass_path: ""
  60
  61
  62
  63 Or
  64
  65 .. code-block:: yaml
  66
  67   applicationConfig:
  68     enable_http: true
  69     #key_store_path:
  70     #key_store_pass_path:
  71     #trust_store_path:
  72     #trust_store_pass_path:
  73
  74
  75 Unauthenticated topic
  76 """""""""""""""""""""
  77 To use unauthenticated topics :ref:`disable TLS <pm_mapper_disable_tls>`, and edit AAF credentials in configuration, it should be removed or set to empty string. See the examples below.
  78
  79 .. code-block:: yaml
  80
  81   applicationConfig:
  82     aaf_identity: ""
  83     aaf_password: ""
  84
  85
  86 Or
  87
  88 .. code-block:: yaml
  89
  90   applicationConfig:
  91     #aaf_identity:
  92     #aaf_password:
  93
  94
  95
  96 PM Mapper Filtering
  97 """""""""""""""""""
  98 The PM Mapper performs data reduction, by filtering the PM telemetry data it receives.
  99 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.
 100 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).
 101 If a filter is provided, any measurement that does not match the filter, will be ignored and a warning will be logged.
 102 PM Mapper expects the filter in the following JSON format:
 103
 104 ::
 105
 106
 107          "filters":[{
 108             "pmDefVsn": "1.3",
 109             "nfType": "gnb",
 110             "vendor": "Ericsson",
 111             "measTypes": [ "attTCHSeizures", "succTCHSeizures", "att.*", ".*Seizures" ]
 112          }]
 113
 114
 115
 116 ====================   ============================      ================================
 117 Field                  Description                       Type
 118 ====================   ============================      ================================
 119 pmDefVsn               PM Dictionary version.            String
 120 vendor                 Vendor of the xNF type.           String
 121 nfType                 nfType is vendor                  String
 122                        defined and should match the
 123                        string used in file ready
 124                        eventName.
 125 measTypes              Measurement name used in PM       List of Strings, Regular expressions
 126                        file in 3GPP format where
 127                        specified, else vendor
 128                        defined.
 129 ====================   ============================      ================================
 130
 131 Message Router Topic Name
 132 """""""""""""""""""""""""
 133 PM Mapper publishes the perf3gpp VES PM Events to the following authenticated MR topic;
 134
 135 ::
 136
 137         org.onap.dmaap.mr.PERFORMANCE_MEASUREMENTS
 138
 139 Performance
 140 ^^^^^^^^^^^
 141
 142 To see the performance of PM Mapper, see "`PM Mapper performance baseline results`_".
 143
 144 .. _PM Mapper performance baseline results: https://wiki.onap.org/display/DW/PM-Mapper+performance+baseline+results