Create wt-odlux directory
[ccsdk/features.git] / sdnr / wt-odlux / helpserver / provider / src / main / resources / help / sdnr / faq.md
1 # Frequently asked questions
2
3
4
5 ## Which browser should I use to operate Opendaylight SDN-R User interface?
6
7 An actual version of [Google Chromium](https://www.chromium.org/getting-involved/download-chromium "Download Chromium") or 
8 [Google Chrome](https://www.google.de/search?q=chrome+download&oq=chrome+download&aqs=chrome..69i57j0l5.2718j0j4&sourceid=chrome&ie=UTF-8 "Download Chrome") is recommended.
9
10 - - -
11
12
13 ## How to enable detailed logs in karaf for SDN-R applications
14
15 If you like to see more details in karaf logs for the NetConf communication between ODL and NetConf servers (mediators/devices) please invoke the following commands in the karaf console.
16
17 ```
18 # Logging settings (on)
19 log:set DEBUG org.opendaylight.mwtn
20 log:set TRACE org.opendaylight.netconf
21 log:set TRACE com.highstreet.technologies.odl.app
22 ```
23
24 Please note, setting the debug level to 'TRACE' may impact the performance on the controller. In production environment make sure to set back the debug level to 'INFO' as soon possible.
25
26
27 ```
28 # Logging settings (off)
29 log:set INFO org.opendaylight.mwtn
30 log:set INFO org.opendaylight.netconf
31 log:set INFO com.highstreet.technologies.odl.app
32 ```
33
34 - - -
35
36 ## Which commands should be used to analyse karaf logs?
37
38 ```
39 cd $ODL_KARAF_HOME/data/log
40 rm *.txt
41 grep -anr --include=*.log* "| ERROR |" . | grep 2018 >> 01-error.txt
42 grep -anr --include=*.log* "RemoteDevice{" . | grep 2018 >> 02-devices.txt
43 grep -anr --include=*.log* "RemoteDevice{" . | grep "Unable to build schema context, unsatisfied imports" | grep 2018 >> 03-schema-issue.txt
44 grep -anr --include=*.log* "Matched request:" . | grep 2018 >> 04-matched-request.txt
45 grep -anr --include=*.log* "network-element" . | grep 2018 >> 05-network-element.txt
46 grep -anr --include=*.log* "urn:onf:params:xml:ns:yang:core-model" . | grep 2018 >> 06-core-module.txt
47 grep -anr --include=*.log* "PerformanceManagerTask" . | grep 2018 >> 07-pm-tick.txt
48 grep -anr --include=*.log* "Unable to read NE data for mountpoint" . | grep 2018 >> 08-unable-to-read.txt
49 grep -anr --include=*.log* "LKCYFL79Q01M01MSS801" . | grep 2018 >> 09-LKCYFL79Q01M01MSS801.txt
50 ```
51
52
53 ## How to report an odlux issue
54
55 If you would like to report an odlux issue which you have noticed in the Graphical User Interface, please provide the following information:
56
57 1. **Description**: In which application you have noticed the issue?
58
59 2. **Environment**: 
60     - Which browser is used and the version of the browser.  eg: *Google chrome - version 71.0.3578.80  / Mozilla Firefox.*
61     - Which Operating system and version. eg: *Linux/ Windows 10 -  version 1803.* 
62     - In which language you are using the application. 
63     - The application URL which is available on the browser address bar.  eg: *http://hostname/odlux/index.html#/connectApp* 
64
65 3. **Expected Result**: What is the expected result you are looking for?
66
67 4. **Actual Result**: What is the actual result you got?
68
69 5. **Steps to reproduce**: Describe the steps to reproduce the scenario. If possible, please provide the screenshots
70  
71 The above information helps us to analyze the problem quicker.
72