Update PM Mapper documentation 17/84517/2
authorGerard Hickey <gerard.hickey@ericsson.com>
Mon, 8 Apr 2019 11:31:44 +0000 (11:31 +0000)
committerGerard Hickey <gerard.hickey@ericsson.com>
Mon, 8 Apr 2019 11:36:42 +0000 (11:36 +0000)
Change-Id: Ie81b8450fdd940827c07223575184696394af836
Issue-ID: DCAEGEN2-567
Signed-off-by: Gerard Hickey <gerard.hickey@ericsson.com>
docs/sections/services/pm-mapper/architecture.rst
docs/sections/services/pm-mapper/configuration.rst
docs/sections/services/pm-mapper/delivery.rst
docs/sections/services/pm-mapper/troubleshooting.rst

index 78011f7..d7fa495 100644 (file)
@@ -26,4 +26,4 @@ The mapper receives the files by subscribing to a Data Router feed.
 
 Interaction
 """""""""""
-PM Mapper will interact with the DMaaP Bus Controller for Subscribing to Data Router feeds and publishing to Message Router. PM Mapper also intracts with the Config Binding Service to get configuration information.
+PM Mapper interacts with the Config Binding Service to get configuration information.
index 88d2ccc..3e1b6b4 100644 (file)
@@ -1,42 +1,46 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
-.. http://creativecommons.org/licenses/by/4.0\r
-\r
-Configuration\r
-=============\r
-\r
-Filtering\r
-"""""""""\r
-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.\r
-Mapper filtering is based on the PM dictionary fields.\r
-PM mapper expects the filter in the following JSON format:\r
-\r
-::\r
-\r
-\r
-         "filters":[{\r
-            "pmDefVsn": "1.3",\r
-            "nfType": "gnb",\r
-            "vendor": "Ericsson",\r
-            "measTypes": [ "attTCHSeizures", "succTCHSeizures" ]\r
-        }]\r
-\r
-\r
-\r
-====================   ============================      ================================\r
-Field                  Description                       Type\r
-====================   ============================      ================================\r
-pmDefVsn               PM Dictionary version.            String\r
-vendor                 Vendor of the xNF type.           String\r
-nfType                 nfType is vendor                  String\r
-                       defined and should match the\r
-                       string used in file ready\r
-                       eventName.\r
-measTypes              Measurement name used in PM       Array of String\r
-                       file in 3GPP format where\r
-                       specified, else vendor\r
-                       defined.\r
-====================   ============================      ================================\r
-\r
-Feed Name\r
-"""""""""\r
-A default feed name "bulk_pm_feed" is configured in PM Mapper blueprint but the feed name can be changed to a user defined value through cloudify manager.
\ No newline at end of file
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Configuration
+=============
+
+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.
+PM mapper expects the filter in the following JSON format:
+
+::
+
+
+         "filters":[{
+            "pmDefVsn": "1.3",
+            "nfType": "gnb",
+            "vendor": "Ericsson",
+            "measTypes": [ "attTCHSeizures", "succTCHSeizures" ]
+        }]
+
+
+
+====================   ============================      ================================
+Field                  Description                       Type
+====================   ============================      ================================
+pmDefVsn               PM Dictionary version.            String
+vendor                 Vendor of the xNF type.           String
+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
+                       file in 3GPP format where
+                       specified, else vendor
+                       defined.
+====================   ============================      ================================
+
+Message Router Topic Name
+"""""""""
+PM Mapper publishes the perf3gpp VES PM Events to the following authenticated MR topic;
+
+::
+
+        topic.org.onap.dmaap.mr.PM_MAPPER
index 0a03237..56ca4a6 100644 (file)
@@ -1,12 +1,14 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
-.. http://creativecommons.org/licenses/by/4.0\r
-\r
-Delivery\r
-========\r
-\r
-Docker Container\r
-----------------\r
-\r
-**PM Mapper** is delivered as a docker image that can be downloaded from ONAP docker registry:\r
-\r
-    ``docker run -d --name pmmapper -e CONFIG_BINDING_SERVICE_SERVICE_HOST=<IP Required> -e CONFIG_BINDING_SERVICE_SERVICE_PORT=<Port Required> -e HOSTNAME=<HOSTNAME>  nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:1.0-SNAPSHOT``\r
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Delivery
+========
+
+Docker Container
+----------------
+
+**PM Mapper** is delivered as a docker image that can be downloaded from ONAP docker registry:
+
+::
+
+    ``docker run -d --name pmmapper -e CONFIG_BINDING_SERVICE_SERVICE_HOST=<IP Required> -e CONFIG_BINDING_SERVICE_SERVICE_PORT=<Port Required> -e HOSTNAME=<HOSTNAME>  nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:1.0-SNAPSHOT``
index ed0b398..c025fb0 100644 (file)
@@ -127,33 +127,4 @@ Make sure Config Binding Service is up and running and the **ip + port** combina
 
 **PM Mapper** logs this information when connected to Consul, but cannot find a valid JSON configuration.
 
-====
-
-**Unable to Subscriber to Data Router Feed**
-
-::
-
-        2019-02-11T16:44:37.012Z       main    DEBUG   org.onap.dcaegen2.services.pmmapper.config.ConfigHandler                Mapper configuration:\nMapperConfig(messageRouterTopicName=unauthenticated.PM_VES_OUTPUT, busControllerConfig=BusControllerConfig(dcaeLocation=dcaeLocation, deliveryURL=deliveryURL, feedId=2, lastMod=lastMod, username=username, password=password, dataRouterSubscribeEndpoint=null), streamsSubscribes=MapperConfig.StreamsSubscribes(dmaapSubscriber=MapperConfig.DmaapSubscriber(dmaapInfo=MapperConfig.DmaapInfo(location=location, username=username, password=password, deliveryUrl=delivery_url, subscriberId=subsriber_id))))
-        2019-02-11T16:44:37.013Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             Starting subscription to DataRouter             ENTRY
-        2019-02-11T16:44:37.013Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             e04d9fb4-5bc3-405b-89ea-6b824de8f137            INVOKE [ SYNCHRONOUS ]
-        2019-02-11T16:44:37.061Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             Request to bus controller executed with Response Code: '404' and Response Event: 'Not Found'.
-        2019-02-11T16:44:39.062Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             d4982d98-574d-42e4-9922-640610ffa34d            INVOKE [ SYNCHRONOUS ]
-        2019-02-11T16:44:39.071Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             Request to bus controller executed with Response Code: '404' and Response Event: 'Not Found'.
-        2019-02-11T16:44:43.079Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             05c73228-d04c-47c2-b897-8e936de5c8fd            INVOKE [ SYNCHRONOUS ]
-        2019-02-11T16:44:43.089Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             Request to bus controller executed with Response Code: '404' and Response Event: 'Not Found'.
-        2019-02-11T16:44:51.129Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             c898b5c7-a347-496a-af3b-aeac661d4f1b            INVOKE [ SYNCHRONOUS ]
-        2019-02-11T16:44:51.138Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             Request to bus controller executed with Response Code: '404' and Response Event: 'Not Found'.
-        2019-02-11T16:45:07.220Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             b190fbc1-ab91-44da-b393-727810925374            INVOKE [ SYNCHRONOUS ]
-        2019-02-11T16:45:07.234Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber             Request to bus controller executed with Response Code: '404' and Response Event: 'Not Found'.
-        2019-02-11T16:45:07.235Z       main    INFO    org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber                             EXIT
-        Exception in thread "main" org.onap.dcaegen2.services.pmmapper.exceptions.TooManyTriesException: Failed to subscribe within appropriate amount of attempts
-        at org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber.subscribe(DataRouterSubscriber.java:152)
-        at org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber.subscribe(DataRouterSubscriber.java:150)
-        at org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber.subscribe(DataRouterSubscriber.java:150)
-        at org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber.subscribe(DataRouterSubscriber.java:150)
-        at org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber.subscribe(DataRouterSubscriber.java:150)
-        at org.onap.dcaegen2.services.pmmapper.datarouter.DataRouterSubscriber.start(DataRouterSubscriber.java:97)
-        at org.onap.dcaegen2.services.pmmapper.App.main(App.java:53)
-
-This log is printed when pm mapper couldn't subscribe to the data router.