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 .. Copyright (c) 2023 AT&T Intellectual Property. All rights reserved.
   5
   6
   7 Configuration and Performance
   8 =============================
   9
  10 Files Processing Configuration
  11 """"""""""""""""""""""""""""""
  12 The PM Mapper consumes the 3GPP XML files from DMaaP-DR, and processes them. It is possible to process it in parallel.
  13 In order to parallel processing, new configuration env has been introduced:
  14
  15 - PROCESSING_LIMIT_RATE (optional, default value: 1) - allows to limit the rate of processing files through channel.
  16
  17 - THREADS_MULTIPLIER (optional, default value: 1) - allows to specify multiplier to calculate the amount of threads.
  18
  19 - 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.
  20
  21 .. _pm_mapper_disable_tls:
  22
  23 Disable TLS
  24 """""""""""
  25 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.
  26
  27 .. code-block:: yaml
  28
  29   applicationConfig:
  30     enable_http: true
  31     key_store_path: ""
  32     key_store_pass_path: ""
  33     trust_store_path: ""
  34     trust_store_pass_path: ""
  35
  36
  37
  38 Or
  39
  40 .. code-block:: yaml
  41
  42   applicationConfig:
  43     enable_http: true
  44     #key_store_path:
  45     #key_store_pass_path:
  46     #trust_store_path:
  47     #trust_store_pass_path:
  48
  49
  50 Unauthenticated topic
  51 """""""""""""""""""""
  52 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.
  53
  54 .. code-block:: yaml
  55
  56   applicationConfig:
  57     aaf_identity: ""
  58     aaf_password: ""
  59
  60
  61 Or
  62
  63 .. code-block:: yaml
  64
  65   applicationConfig:
  66     #aaf_identity:
  67     #aaf_password:
  68
  69
  70
  71 PM Mapper Filtering
  72 """""""""""""""""""
  73 The PM Mapper performs data reduction, by filtering the PM telemetry data it receives.
  74 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.
  75 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).
  76 If a filter is provided, any measurement that does not match the filter, will be ignored and a warning will be logged.
  77 PM Mapper expects the filter in the following JSON format:
  78
  79 ::
  80
  81
  82          "filters":[{
  83             "pmDefVsn": "1.3",
  84             "nfType": "gnb",
  85             "vendor": "Ericsson",
  86             "measTypes": [ "attTCHSeizures", "succTCHSeizures", "att.*", ".*Seizures" ]
  87          }]
  88
  89
  90
  91 ====================   ============================      ================================
  92 Field                  Description                       Type
  93 ====================   ============================      ================================
  94 pmDefVsn               PM Dictionary version.            String
  95 vendor                 Vendor of the xNF type.           String
  96 nfType                 nfType is vendor                  String
  97                        defined and should match the
  98                        string used in file ready
  99                        eventName.
 100 measTypes              Measurement name used in PM       List of Strings, Regular expressions
 101                        file in 3GPP format where
 102                        specified, else vendor
 103                        defined.
 104 ====================   ============================      ================================
 105
 106 Message Router Topic Name
 107 """""""""""""""""""""""""
 108 PM Mapper publishes the perf3gpp VES PM Events to the following authenticated MR topic;
 109
 110 ::
 111
 112         org.onap.dmaap.mr.PERFORMANCE_MEASUREMENTS
 113
 114 Performance
 115 ^^^^^^^^^^^
 116
 117 To see the performance of PM Mapper, see "`PM Mapper performance baseline results`_".
 118
 119 .. _PM Mapper performance baseline results: https://wiki.onap.org/display/DW/PM-Mapper+performance+baseline+results