Provide RPC to fetch PCEP session stats
[bgpcep.git] / docs / bmp / bgp-monitoring-protocol-user-guide-troubleshooting.rst
1 .. _bgp-monitoring-protocol-user-guide-troubleshooting:
2
3 Troubleshooting
4 ===============
5 This section offers advices in a case OpenDaylight BMP plugin is not working as expected.
6
7 .. contents:: Contents
8    :depth: 2
9    :local:
10
11 BMP is not working...
12 ^^^^^^^^^^^^^^^^^^^^^
13 * First of all, ensure that all required features are installed, local monitoring station and monitored router/peers configuration is correct.
14
15   To list all installed features in OpenDaylight use the following command at the Karaf console:
16
17   .. code-block:: console
18
19      feature:list -i
20
21 * Check OpenDaylight Karaf logs:
22
23   From Karaf console:
24
25   .. code-block:: console
26
27      log:tail
28
29   or open log file: ``data/log/karaf.log``
30
31   Possibly, a reason/hint for a cause of the problem can be found there.
32
33 * Try to minimize effect of other OpenDaylight features, when searching for a reason of the problem.
34
35 * Try to set DEBUG severity level for BMP logger via Karaf console commands, in order to collect more information:
36
37   .. code-block:: console
38
39      log:set DEBUG org.opendaylight.protocol.bmp
40
41 Bug reporting
42 ^^^^^^^^^^^^^
43 Before you report a bug, check `BGPCEP Jira <https://jira.opendaylight.org/projects/BGPCEP/issues/BGPCEP-589?filter=allopenissues>`_ to ensure same/similar bug is not already filed there.
44
45 Write an e-mail to bgpcep-users@lists.opendaylight.org and provide following information:
46
47 #. State OpenDaylight version
48
49 #. Describe your use-case and provide as much details related to BMP as possible
50
51 #. Steps to reproduce
52
53 #. Attach Karaf log files, optionally packet captures, REST input/output