summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authormarcinrzepeckiwroc <marcin.rzepecki@nokia.com>2020-07-16 11:49:11 +0200
committerMarcin Rzepecki <marcin.rzepecki@nokia.com>2020-07-20 08:41:03 +0000
commit3756b7f62f95e42640dc3056d5125179e522fbeb (patch)
treebfdf780071b5542cd4540abd829308dc0b4ed1a1 /docs
parent7a0186cba764d1dd982c42c617e09ac22642ec69 (diff)
Update documentation for PM Mapper filtering (regex support)
Issue-ID: DCAEGEN2-2347 Signed-off-by: marcinrzepeckiwroc <marcin.rzepecki@nokia.com> Change-Id: Id63f28d4ac19db592ee19150b8d9db2d415e9788
Diffstat (limited to 'docs')
-rw-r--r--docs/sections/services/pm-mapper/configuration.rst14
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst
index 1e676c6a..a9f4f5bf 100644
--- a/docs/sections/services/pm-mapper/configuration.rst
+++ b/docs/sections/services/pm-mapper/configuration.rst
@@ -4,10 +4,12 @@
Configuration and Performance
=============================
-Filtering
+PM Mapper Filtering
"""""""""
-PM Mapper maps PM XML files to performance VES event by applying the mapper filtering information. Mapper filtering is configured during instantiation through cloudify manager.
-Mapper filtering is based on the PM dictionary fields.
+The PM Mapper performs data reduction, by filtering the PM telemetry data it receives.
+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.
+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).
+If a filter is provided, any measurement that does not match the filter, will be ignored and a warning will be logged.
PM Mapper expects the filter in the following JSON format:
::
@@ -17,8 +19,8 @@ PM Mapper expects the filter in the following JSON format:
"pmDefVsn": "1.3",
"nfType": "gnb",
"vendor": "Ericsson",
- "measTypes": [ "attTCHSeizures", "succTCHSeizures" ]
- }]
+ "measTypes": [ "attTCHSeizures", "succTCHSeizures", "att.*", ".*Seizures" ]
+ }]
@@ -31,7 +33,7 @@ nfType nfType is vendor String
defined and should match the
string used in file ready
eventName.
-measTypes Measurement name used in PM Array of String
+measTypes Measurement name used in PM List of Strings, Regular expressions
file in 3GPP format where
specified, else vendor
defined.