clean up some sphinx warnings
[dcaegen2.git] / docs / sections / services / mapper / troubleshooting.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
5 Troubleshooting
6 ===============
7
8 **NOTE**
9
10 According to **ONAP** logging policy, **Mapper** logs contain all required markers as well as service and client specific Mapped Diagnostic Context (later referred as MDC)
11
12 Default console log pattern:
13
14 ::
15
16         |%date{"HH:mm:ss.SSSXXX", UTC}\t[ %thread\t] %highlight(%-5level)\t - %msg\t
17
18 A sample, fully qualified message implementing this pattern:
19
20 ::
21
22         |11:10:13.230 [rcc-notification] INFO metricsLogger - fetch and publish from and to Dmaap started:rcc-notification
23
24
25 For simplicity, all log messages in this section are shortened to contain only:
26     * logger name
27     * log level
28     * message
29
30 Error and warning logs contain also:
31     * exception message
32     * stack trace
33
34 **Do not rely on exact log messages or their presence, as they are often subject to change.**
35
36 Deployment/Installation errors
37 ------------------------------
38
39 **Missing Default Config File in case of using local config instead of Consul**
40
41 ::
42
43
44    |13:04:37.535 [main] ERROR errorLogger - Default Config file kv.json is missing
45    |13:04:37.537 [main] ERROR errorLogger - Application stoped due to missing default Config file
46    |13:04:37.538 [main] INFO  o.s.s.c.ThreadPoolTaskExecutor - Shutting down ExecutorService 'applicationTaskExecutor'
47    |15:40:43.982 [main] WARN  debugLogger - All Smooks objects closed
48
49 **These log messages are printed when the default configuration file "kv.json", was not present.**
50
51
52 **Invalid Default Config File in case of using local config instead of Consul**
53
54 If Default Config File  is an invalid json file, we will get below exception
55
56 ::
57
58  |15:19:52.489 [main] ERROR o.s.boot.SpringApplication - Application run failed
59  |java.lang.IllegalStateException: Failed to execute CommandLineRunner
60         at org.springframework.boot.SpringApplication.callRunner(SpringApplication.java:816)
61         at org.springframework.boot.SpringApplication.callRunners(SpringApplication.java:797)
62         at org.springframework.boot.SpringApplication.run(SpringApplication.java:324)
63         at org.springframework.boot.SpringApplication.run(SpringApplication.java:1260)
64         at org.springframework.boot.SpringApplication.run(SpringApplication.java:1248)
65         at org.onap.universalvesadapter.Application.main(Application.java:29)
66  |Caused by: org.json.JSONException: Expected a ',' or '}' at 8100 [character 2 line 54]
67         at org.json.JSONTokener.syntaxError(JSONTokener.java:433)
68         at org.json.JSONObject.<init>(JSONObject.java:229)
69         at org.json.JSONObject.<init>(JSONObject.java:321)
70         at org.onap.universalvesadapter.utils.FetchDynamicConfig.verifyConfigChange(FetchDynamicConfig.java:97)
71         at org.onap.universalvesadapter.utils.FetchDynamicConfig.cbsCall(FetchDynamicConfig.java:66)
72         at org.onap.universalvesadapter.service.VESAdapterInitializer.run(VESAdapterInitializer.java:83)
73         at org.springframework.boot.SpringApplication.callRunner(SpringApplication.java:813)
74         ... 5 common frames omitted
75  |15:19:52.492 [main] INFO  o.s.s.c.ThreadPoolTaskExecutor - Shutting down ExecutorService 'applicationTaskExecutor'
76  |15:19:52.493 [main] WARN  debugLogger - All Smooks objects closed
77
78
79 **Invalid Smooks mapping file**
80
81 If VES-Mapper blueprint or local config file contains invalid Smooks mapping file, then we will get below SAXException / JsonProcessingException / JsonSyntaxException / JsonParseException while processing the incoming notifications and the notification will be dropped without converting into required VES event. All such dropped notifications will be logged in error log file.