1Smokeping_probes_EchoPingDNS(3)    SmokePing   Smokeping_probes_EchoPingDNS(3)
2
3
4

NAME

6       Smokeping::probes::EchoPingDNS - an echoping(1) probe for SmokePing
7

OVERVIEW

9       Measures DNS roundtrip times for SmokePing with the echoping_dns
10       plugin.
11

SYNOPSIS

13        *** Probes ***
14
15        +EchoPingDNS
16
17        binary = /usr/bin/echoping
18        forks = 5
19        offset = 50%
20        step = 300
21
22        # The following variables can be overridden in each target section
23        /^influx_.+/ = influx_location = In the basement
24        dns_request = example.org # mandatory
25        dns_tcp = yes
26        dns_type = AAAA
27        extraopts = -some-letter-the-author-did-not-think-of
28        ipversion = 4
29        pings = 5
30        plugin = /path/to/dns.so
31        pluginargs = -p plugin_specific_arg
32        priority = 6
33        timeout = 1
34        tos = 0xa0
35        waittime = 1
36
37        # [...]
38
39        *** Targets ***
40
41        probe = EchoPingDNS # if this should be the default probe
42
43        # [...]
44
45        + mytarget
46        # probe = EchoPingDNS # if the default probe is something else
47        host = my.host
48        /^influx_.+/ = influx_location = In the basement
49        dns_request = example.org # mandatory
50        dns_tcp = yes
51        dns_type = AAAA
52        extraopts = -some-letter-the-author-did-not-think-of
53        ipversion = 4
54        pings = 5
55        plugin = /path/to/dns.so
56        pluginargs = -p plugin_specific_arg
57        priority = 6
58        timeout = 1
59        tos = 0xa0
60        waittime = 1
61

VARIABLES

63       Supported probe-specific variables:
64
65       binary
66           The location of your echoping binary.
67
68           Default value: /usr/bin/echoping
69
70       forks
71           Run this many concurrent processes at maximum
72
73           Example value: 5
74
75           Default value: 5
76
77       offset
78           If you run many probes concurrently you may want to prevent them
79           from hitting your network all at the same time. Using the probe-
80           specific offset parameter you can change the point in time when
81           each probe will be run. Offset is specified in % of total interval,
82           or alternatively as 'random', and the offset from the 'General'
83           section is used if nothing is specified here. Note that this does
84           NOT influence the rrds itself, it is just a matter of when data
85           acquisition is initiated.  (This variable is only applicable if the
86           variable 'concurrentprobes' is set in the 'General' section.)
87
88           Example value: 50%
89
90       step
91           Duration of the base interval that this probe should use, if
92           different from the one specified in the 'Database' section. Note
93           that the step in the RRD files is fixed when they are originally
94           generated, and if you change the step parameter afterwards, you'll
95           have to delete the old RRD files or somehow convert them. (This
96           variable is only applicable if the variable 'concurrentprobes' is
97           set in the 'General' section.)
98
99           Example value: 300
100
101       Supported target-specific variables:
102
103       /^influx_.+/
104           This is a tag that will be sent to influxdb and has no impact on
105           the probe measurement. The tag name will be sent without the
106           "influx_" prefix, which will be replaced with "tag_" instead. Tags
107           can be used for filtering.
108
109           Example value: influx_location = In the basement
110
111       dns_request
112           The DNS request (domain name) to be queried.
113
114           Example value: example.org
115
116           This setting is mandatory.
117
118       dns_tcp
119           The echoping_dns '--tcp' option: use only TCP ('virtual circuit').
120           Enabled if specified with a value other than 'no' or '0'.
121
122           Example value: yes
123
124       dns_type
125           The echoping_dns '-t' option: type of data requested (NS, A, SOA
126           etc.)
127
128           Example value: AAAA
129
130           Default value: A
131
132       extraopts
133           Any extra options specified here will be passed unmodified to
134           echoping(1).
135
136           Example value: -some-letter-the-author-did-not-think-of
137
138       ipversion
139           The IP protocol used. Possible values are "4" and "6".  Passed to
140           echoping(1) as the "-4" or "-6" options.
141
142           Example value: 4
143
144       pings
145           How many pings should be sent to each target, if different from the
146           global value specified in the Database section. Note that the
147           number of pings in the RRD files is fixed when they are originally
148           generated, and if you change this parameter afterwards, you'll have
149           to delete the old RRD files or somehow convert them.
150
151           Example value: 5
152
153       plugin
154           The echoping plugin that will be used. See echoping(1) for details.
155           This can either be the name of the plugin or a full path to the
156           plugin shared object.
157
158           Example value: /path/to/dns.so
159
160           Default value: dns
161
162       pluginargs
163           Any extra arguments needed by the echoping plugin specified with
164           the pluginname variable. These are generally provided by the
165           subclass probe.
166
167           Example value: -p plugin_specific_arg
168
169       priority
170           The "-p" echoping(1) option.
171
172           Example value: 6
173
174       timeout
175           The "-t" echoping(1) option.
176
177           Example value: 1
178
179           Default value: 5
180
181       tos The "-P" echoping(1) option.
182
183           Example value: 0xa0
184
185       waittime
186           The "-w" echoping(1) option.
187
188           Example value: 1
189

AUTHORS

191       Niko Tyni <ntyni@iki.fi>
192

NOTES

194       The fill, size and udp EchoPing variables are not valid.
195
196       Plugins, including echoping_dns, are available starting with echoping
197       version 6.
198

SEE ALSO

200       Smokeping::probes::EchoPing, Smokeping::probes::EchoPingPlugin
201
202
203
2042.8.2                             2022-07-23   Smokeping_probes_EchoPingDNS(3)
Impressum