summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/pm-mapper
diff options
context:
space:
mode:
authorGerard Hickey <gerard.hickey@ericsson.com>2019-04-08 11:31:44 +0000
committerGerard Hickey <gerard.hickey@ericsson.com>2019-04-08 11:36:42 +0000
commit19a9d30db357ed9dbebb0f52dc95c14307ec3bb4 (patch)
tree894c38bc34a54ec1b09ec6eac279567f8dd792dd /docs/sections/services/pm-mapper
parent580eae246a3ac7bf9533df96d20c0fc9b5425d3c (diff)
Update PM Mapper documentation
Change-Id: Ie81b8450fdd940827c07223575184696394af836 Issue-ID: DCAEGEN2-567 Signed-off-by: Gerard Hickey <gerard.hickey@ericsson.com>
Diffstat (limited to 'docs/sections/services/pm-mapper')
-rw-r--r--docs/sections/services/pm-mapper/architecture.rst2
-rw-r--r--docs/sections/services/pm-mapper/configuration.rst88
-rw-r--r--docs/sections/services/pm-mapper/delivery.rst26
-rw-r--r--docs/sections/services/pm-mapper/troubleshooting.rst29
4 files changed, 61 insertions, 84 deletions
diff --git a/docs/sections/services/pm-mapper/architecture.rst b/docs/sections/services/pm-mapper/architecture.rst
index 78011f77..d7fa4956 100644
--- a/docs/sections/services/pm-mapper/architecture.rst
+++ b/docs/sections/services/pm-mapper/architecture.rst
@@ -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.
diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst
index 88d2ccc5..3e1b6b4f 100644
--- a/docs/sections/services/pm-mapper/configuration.rst
+++ b/docs/sections/services/pm-mapper/configuration.rst
@@ -1,42 +1,46 @@
-.. 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.
-==================== ============================ ================================
-
-Feed Name
-"""""""""
-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
diff --git a/docs/sections/services/pm-mapper/delivery.rst b/docs/sections/services/pm-mapper/delivery.rst
index 0a03237a..56ca4a6e 100644
--- a/docs/sections/services/pm-mapper/delivery.rst
+++ b/docs/sections/services/pm-mapper/delivery.rst
@@ -1,12 +1,14 @@
-.. 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``
+.. 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``
diff --git a/docs/sections/services/pm-mapper/troubleshooting.rst b/docs/sections/services/pm-mapper/troubleshooting.rst
index ed0b398f..c025fb0c 100644
--- a/docs/sections/services/pm-mapper/troubleshooting.rst
+++ b/docs/sections/services/pm-mapper/troubleshooting.rst
@@ -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.