DCAE doc cleanup warnings
[dcaegen2.git] / 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 PM Mapper Filtering
8 """""""""""""""""""
9 The PM Mapper performs data reduction, by filtering the PM telemetry data it receives.
10 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.
11 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).
12 If a filter is provided, any measurement that does not match the filter, will be ignored and a warning will be logged.
13 PM Mapper expects the filter in the following JSON format:
14
15 ::
16
17
18          "filters":[{
19             "pmDefVsn": "1.3",
20             "nfType": "gnb",
21             "vendor": "Ericsson",
22             "measTypes": [ "attTCHSeizures", "succTCHSeizures", "att.*", ".*Seizures" ]
23          }]
24
25
26
27 ====================   ============================      ================================
28 Field                  Description                       Type
29 ====================   ============================      ================================
30 pmDefVsn               PM Dictionary version.            String
31 vendor                 Vendor of the xNF type.           String
32 nfType                 nfType is vendor                  String
33                        defined and should match the
34                        string used in file ready
35                        eventName.
36 measTypes              Measurement name used in PM       List of Strings, Regular expressions
37                        file in 3GPP format where
38                        specified, else vendor
39                        defined.
40 ====================   ============================      ================================
41
42 Message Router Topic Name
43 """""""""""""""""""""""""
44 PM Mapper publishes the perf3gpp VES PM Events to the following authenticated MR topic;
45
46 ::
47
48         org.onap.dmaap.mr.PERFORMANCE_MEASUREMENTS
49
50 Performance
51 ^^^^^^^^^^^
52
53 To see the performance of PM Mapper, see "`PM Mapper performance baseline results`_".
54
55 .. _PM Mapper performance baseline results: https://wiki.onap.org/display/DW/PM-Mapper+performance+baseline+results