Smokeping_probes_CiscoRTTMonTcpConnect(3)

1Smokeping_probes_CiscoRTTMonTcpConneScmtoS(km3eo)Pkienpging_probes_CiscoRTTMonTcpConnect(3)
2
3
4

NAME

6       Smokeping::probes::CiscoRTTMonTcpConnect - Probe for SmokePing
7

SYNOPSIS

9        *** Probes ***
10
11        +CiscoRTTMonTcpConnect
12
13        forks = 5
14        offset = 50%
15        step = 300
16        timeout = 15
17
18        # The following variables can be overridden in each target section
19        /^influx_.+/ = influx_location = In the basement
20        ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
21        iosint = 10.33.22.11
22        pings = 5
23        port = 80
24        timeout = 15
25        tos = 160
26
27        # [...]
28
29        *** Targets ***
30
31        probe = CiscoRTTMonTcpConnect # if this should be the default probe
32
33        # [...]
34
35        + mytarget
36        # probe = CiscoRTTMonTcpConnect # if the default probe is something else
37        host = my.host
38        /^influx_.+/ = influx_location = In the basement
39        ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
40        iosint = 10.33.22.11
41        pings = 5
42        port = 80
43        timeout = 15
44        tos = 160
45

DESCRIPTION

47       A probe for smokeping, which uses the ciscoRttMon MIB functionality
48       ("Service Assurance Agent", "SAA") of Cisco IOS to measure TCP connect
49       times between a Cisco router and a TCP server. The measured value is
50       the time is the time to establish a TCP session, i.e. the time between
51       the initial "SYN" TCP packet of the router and the "SYN ACK" packet of
52       the host. The router terminates the TCP session immediately after the
53       reception of "SYN ACK" with a "FIN" packet.
54

VARIABLES

56       Supported probe-specific variables:
57
58       forks
59           Run this many concurrent processes at maximum
60
61           Example value: 5
62
63           Default value: 5
64
65       offset
66           If you run many probes concurrently you may want to prevent them
67           from hitting your network all at the same time. Using the probe-
68           specific offset parameter you can change the point in time when
69           each probe will be run. Offset is specified in % of total interval,
70           or alternatively as 'random', and the offset from the 'General'
71           section is used if nothing is specified here. Note that this does
72           NOT influence the rrds itself, it is just a matter of when data
73           acquisition is initiated.  (This variable is only applicable if the
74           variable 'concurrentprobes' is set in the 'General' section.)
75
76           Example value: 50%
77
78       step
79           Duration of the base interval that this probe should use, if
80           different from the one specified in the 'Database' section. Note
81           that the step in the RRD files is fixed when they are originally
82           generated, and if you change the step parameter afterwards, you'll
83           have to delete the old RRD files or somehow convert them. (This
84           variable is only applicable if the variable 'concurrentprobes' is
85           set in the 'General' section.)
86
87           Example value: 300
88
89       timeout
90           How long a single 'ping' takes at maximum
91
92           Example value: 15
93
94           Default value: 5
95
96       Supported target-specific variables:
97
98       /^influx_.+/
99           This is a tag that will be sent to influxdb and has no impact on
100           the probe measurement. The tag name will be sent without the
101           "influx_" prefix, which will be replaced with "tag_" instead. Tags
102           can be used for filtering.
103
104           Example value: influx_location = In the basement
105
106       ioshost
107           The (mandatory) ioshost parameter specifies the Cisco router, which
108           will establish the TCP connections as well as the SNMP community
109           string on the router.
110
111           Example value: RTTcommunity@Myrouter.foobar.com.au
112
113           This setting is mandatory.
114
115       iosint
116           The (optional) iosint parameter is the source address for the TCP
117           connections. This should be one of the active (!) IP addresses of
118           the router to get results. IOS looks up the target host address in
119           the forwarding table and then uses the interface(s) listed there to
120           send the TCP packets. By default IOS uses the (primary) IP address
121           on the sending interface as source address for a connection.
122
123           Example value: 10.33.22.11
124
125       pings
126           How many pings should be sent to each target, if different from the
127           global value specified in the Database section. Note that the
128           number of pings in the RRD files is fixed when they are originally
129           generated, and if you change this parameter afterwards, you'll have
130           to delete the old RRD files or somehow convert them.
131
132           Example value: 5
133
134       port
135           The (optional) port parameter lets you configure the destination
136           TCP port on the host. The default is the http port 80.
137
138           Default value: 80
139
140       timeout
141           How long a single RTTMon TcpConnect 'ping' take at maximum plus 10
142           seconds to spare. Since we control our own timeout the only purpose
143           of this is to not have us killed by the ping method from basefork.
144
145           Example value: 15
146
147           Default value: 15
148
149       tos The (optional) tos parameter specifies the value of the ToS byte in
150           the IP header of the packets from the router. Multiply DSCP values
151           times 4 and Precedence values times 32 to calculate the ToS values
152           to configure, e.g. ToS 160 corresponds to a DSCP value 40 and a
153           Precedence value of 5. Please note that this will not influence the
154           ToS value in the packets sent by the the host.
155
156           Example value: 160
157
158           Default value: 0
159

AUTHORS

161       Joerg.Kummer at Roche.com
162

NOTES

164   IOS VERSIONS
165       This probe only works with Cisco IOS 12.0(3)T or higher. It is
166       recommended to test it on less critical routers first.
167
168   INSTALLATION
169       To install this probe copy ciscoRttMonMIB.pm to
170       ($SMOKEPINGINSTALLDIR)/Smokeping/lib and CiscoRTTMonTcpConnect.pm to
171       ($SMOKEPINGINSTALLDIR)/lib/Smokeping/probes. V0.97 or higher of Simon
172       Leinen's SNMP_Session.pm is required.
173
174       The router(s) must be configured to allow read/write SNMP access.
175       Sufficient is:
176
177               snmp-server community RTTCommunity RW
178
179       If you want to be a bit more restrictive with SNMP write access to the
180       router, then consider configuring something like this
181
182               access-list 2 permit 10.37.3.5
183               snmp-server view RttMon ciscoRttMonMIB included
184               snmp-server community RTTCommunity view RttMon RW 2
185
186       The above configuration grants SNMP read-write only to 10.37.3.5 (the
187       smokeping host) and only to the ciscoRttMon MIB tree. The probe does
188       not need access to SNMP variables outside the RttMon tree.
189

BUGS

191       The probe establishes unnecessary connections, i.e. more than
192       configured in the "pings" variable, because the RTTMon MIB only allows
193       to set a total time for all connections in one measurement run (one
194       "life"). Currently the probe sets the life duration to "pings"*5+3
195       seconds (5 secs is the timeout value hardcoded into this probe).
196