Documents up-to-date
[doctor.git] / docs / release / userguide / monitors.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 Monitor Types and Limitations
5 =============================
6
7 Currently there are two monitor types supported: sample and collectd
8
9 Sample Monitor
10 --------------
11
12 Sample monitor type pings the compute host from the control host and calculates the
13 notification time after the ping timeout.
14 Also if inspector type is sample, the compute node needs to communicate with the control
15 node on port 12345. This port needs to be opened for incomming traffic on control node.
16
17 Collectd Monitor
18 ----------------
19
20 Collectd monitor type uses collectd daemon running ovs_events plugin. Collectd runs on
21 compute to send instant notification to the control node. The notification time is
22 calculated by using the difference of time at which compute node sends notification to
23 control node and the time at which consumer is notified. The time on control and compute
24 node has to be synchronized for this reason. For further details on setting up collectd
25 on the compute node, use the following link:
26 :doc:`<barometer:release/userguide/feature.userguide>`
27
28
29 Collectd monitors an interface managed by OVS. If the interface is not be assigned
30 an IP, the user has to provide the name of interface to be monitored. The command to
31 launch the doctor test in that case is:
32 MONITOR_TYPE=collectd INSPECTOR_TYPE=sample INTERFACE_NAME=example_iface ./run.sh
33
34 If the interface name or IP is not provided, the collectd monitor type will monitor the
35 default management interface. This may result in the failure of doctor run.sh test case.
36 The test case sets the monitored interface down and if the inspector (sample or congress)
37 is running on the same subnet, collectd monitor will not be able to communicate with it.