1Smokeping_probes_TraceroutePing(3) SmokePingSmokeping_probes_TraceroutePing(3)
2
3
4

NAME

6       Smokeping::probes::TraceroutePing - use traceroute to obtain RTT for a
7       router
8

SYNOPSIS

10        *** Probes ***
11
12        +TraceroutePing
13
14        binary = /usr/bin/traceroute # mandatory
15        binaryv6 = /usr/bin/traceroute6
16        forks = 5
17        offset = 50%
18        step = 300
19        timeout = 15
20
21        # The following variables can be overridden in each target section
22        /^influx_.+/ = influx_location = In the basement
23        desthost = www.example.com # mandatory
24        host = www-net-router.example.com # mandatory
25        maxttl = 15
26        minttl = 11
27        pings = 5
28        wait = 3
29
30        # [...]
31
32        *** Targets ***
33
34        probe = TraceroutePing # if this should be the default probe
35
36        # [...]
37
38        + mytarget
39        # probe = TraceroutePing # if the default probe is something else
40        host = my.host
41        /^influx_.+/ = influx_location = In the basement
42        desthost = www.example.com # mandatory
43        host = www-net-router.example.com # mandatory
44        maxttl = 15
45        minttl = 11
46        pings = 5
47        wait = 3
48

DESCRIPTION

50       Integrates standard traceroute as a probe into smokeping.  The use case
51       for this probe is gateways that do not respond to TCP/UDP/ICMP packets
52       addressed to them, but do return ICMP TTL_EXCEEDED packets for
53       traceroute packets to a host they route to.  It is best used in
54       situations where routing for the path is static or nearly so;
55       attempting to use this on networks with changing routing will yield
56       poor results.  The best place to use this probe is on first- and last-
57       mile links, which are more likely to have static routing and also more
58       likely to have firewalls that ignore ICMP ECHO_REQUEST.
59
60       The mandatory probe variable binary must have an executable path for
61       traceroute.
62
63       The optional probe variable binaryv6 sets an executable path for your
64       IPv6 traceroute.  If this is set to the same value as binary,
65       TraceroutePing will use the -6 flag when running traceroute for IPv6
66       addresses.  If this variable is not set, TraceroutePing will try to
67       find an functioning IPv6 traceroute.  It will first try appending "6"
68       to the path in binary, then try including the "-6" flag in a test
69       command.  Note that Linux appears to have a wide variety of IPv6
70       traceroute implementations.  My Ubuntu 14.04 machine has
71       /usr/sbin/traceroute6 from iputils, but /usr/bin/traceroute (from
72       Dmitry Butskoy) accepts the -6 flag and is actually a better
73       implementation.  You may need to let TraceroutePing autodetect this, or
74       experiment to find the best traceroute.
75
76       The mandatory target variable desthost must name a destination host for
77       the probe.  The destination host itself is not of interest and no data
78       is gathered on it, its only purpose is to route traffic past your
79       actual target.  Selection of a destination just past your target, with
80       static or strongly preferred routing through your target, will get
81       better data.
82
83       The mandatory target variable host must name the target host for the
84       probe.  This is the router that you want to collect RTT data for.  This
85       variable must either be the valid reverse-lookup name of the router, or
86       its IP address.  Using the IP address is preferable since it allows us
87       to tell traceroute to avoid DNS lookups.
88
89       The target variables minttl and maxttl can be used to describe the
90       range of expected hop counts to host.  On longer paths or paths through
91       unresponsive gateways or ending in unresponsive hosts, this reduces the
92       amount of time this probe takes to execute.  These default to 1 and 30.
93
94       The target variables wait sets the traceroute probe timeout in seconds.
95       This defaults to 1, instead of the traditionally higher value used by
96       LBL traceroute.  Traceroute programs often enforce a lower bound on
97       this value.
98

VARIABLES

100       Supported probe-specific variables:
101
102       binary
103           The location of your traceroute binary.
104
105           Example value: /usr/bin/traceroute
106
107           This setting is mandatory.
108
109       binaryv6
110           The location of your IPv6 traceroute binary.
111
112           Example value: /usr/bin/traceroute6
113
114       forks
115           Run this many concurrent processes at maximum
116
117           Example value: 5
118
119           Default value: 5
120
121       offset
122           If you run many probes concurrently you may want to prevent them
123           from hitting your network all at the same time. Using the probe-
124           specific offset parameter you can change the point in time when
125           each probe will be run. Offset is specified in % of total interval,
126           or alternatively as 'random', and the offset from the 'General'
127           section is used if nothing is specified here. Note that this does
128           NOT influence the rrds itself, it is just a matter of when data
129           acquisition is initiated.  (This variable is only applicable if the
130           variable 'concurrentprobes' is set in the 'General' section.)
131
132           Example value: 50%
133
134       step
135           Duration of the base interval that this probe should use, if
136           different from the one specified in the 'Database' section. Note
137           that the step in the RRD files is fixed when they are originally
138           generated, and if you change the step parameter afterwards, you'll
139           have to delete the old RRD files or somehow convert them. (This
140           variable is only applicable if the variable 'concurrentprobes' is
141           set in the 'General' section.)
142
143           Example value: 300
144
145       timeout
146           How long a single 'ping' takes at maximum
147
148           Example value: 15
149
150           Default value: 5
151
152       Supported target-specific variables:
153
154       /^influx_.+/
155           This is a tag that will be sent to influxdb and has no impact on
156           the probe measurement. The tag name will be sent without the
157           "influx_" prefix, which will be replaced with "tag_" instead. Tags
158           can be used for filtering.
159
160           Example value: influx_location = In the basement
161
162       desthost
163           Final destination host for traceroute packets.  Does not have to be
164           reachable unless it is also your host.
165
166           Example value: www.example.com
167
168           This setting is mandatory.
169
170       host
171           Host of interest to monitor.  Must be either the host's reverse-
172           lookup name, or an IP address.
173
174           Example value: www-net-router.example.com
175
176           This setting is mandatory.
177
178       maxttl
179           Maximum TTL.  Set to the maximum expected number of hops to host.
180
181           Example value: 15
182
183       minttl
184           Minimum TTL.  Set to the minimum expected number of hops to host.
185
186           Example value: 11
187
188       pings
189           How many pings should be sent to each target, if different from the
190           global value specified in the Database section. Note that the
191           number of pings in the RRD files is fixed when they are originally
192           generated, and if you change this parameter afterwards, you'll have
193           to delete the old RRD files or somehow convert them.
194
195           Example value: 5
196
197       wait
198           Waittime.  The timeout value for traceroute's probes, in seconds.
199
200           Example value: 3
201

AUTHORS

203       John Hood <cgull@glup.org>,
204

SEE ALSO

206       smokeping_extend
207
208
209
2102.8.2                             2022-07-23Smokeping_probes_TraceroutePing(3)
Impressum