Smokeping_probes_CiscoRTTMonDNS(3)

1Smokeping_probes_CiscoRTTMonDNS(3) SmokePingSmokeping_probes_CiscoRTTMonDNS(3)
2
3
4

NAME

6       Smokeping::probes::CiscoRTTMonDNS.pm - Probe for SmokePing
7

SYNOPSIS

9        *** Probes ***
10
11        +CiscoRTTMonDNS
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        name = www.foobar.com.au # mandatory
23        pings = 5
24        timeout = 15
25
26        # [...]
27
28        *** Targets ***
29
30        probe = CiscoRTTMonDNS # if this should be the default probe
31
32        # [...]
33
34        + mytarget
35        # probe = CiscoRTTMonDNS # if the default probe is something else
36        host = my.host
37        /^influx_.+/ = influx_location = In the basement
38        ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
39        iosint = 10.33.22.11
40        name = www.foobar.com.au # mandatory
41        pings = 5
42        timeout = 15
43

DESCRIPTION

45       A probe for smokeping, which uses the ciscoRttMon MIB functionality
46       ("Service Assurance Agent", "SAA") of Cisco IOS to time ( recursive,
47       type A) DNS queries to a DNS server.
48

VARIABLES

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

AUTHORS

146       Joerg.Kummer at Roche.com
147

NOTES

149   host parameter
150       The host parameter specifies the DNS server, which the router will use.
151
152   IOS VERSIONS
153       This probe only works with IOS 12.0(3)T or higher.  It is recommended
154       to test it on less critical routers first.
155
156   INSTALLATION
157       To install this probe copy ciscoRttMonMIB.pm to
158       ($SMOKEPINGINSTALLDIR)/lib/Smokeping and CiscoRTTMonDNS.pm to
159       ($SMOKEPINGINSTALLDIR)/lib/Smokeping/probes.
160
161       The router(s) must be configured to allow read/write SNMP access.
162       Sufficient is:
163
164               snmp-server community RTTCommunity RW
165
166       If you want to be a bit more restrictive with SNMP write access to the
167       router, then consider configuring something like this
168
169               access-list 2 permit 10.37.3.5
170               snmp-server view RttMon ciscoRttMonMIB included
171               snmp-server community RTTCommunity view RttMon RW 2
172
173       The above configuration grants SNMP read-write only to 10.37.3.5 (the
174       smokeping host) and only to the ciscoRttMon MIB tree. The probe does
175       not need access to SNMP variables outside the RttMon tree.
176

BUGS

178       The probe does unnecessary DNS queries, i.e. more than configured in
179       the "pings" variable, because the RTTMon MIB only allows to set a total
180       time for all queries in one measurement run (one "life"). Currently the
181       probe sets the life duration to "pings"*5+3 seconds (5 secs is the
182       timeout value hardcoded into this probe).
183