Smokeping_probes_EchoPingDNS(3)

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        dns_request = example.org # mandatory
24        dns_tcp = yes
25        dns_type = AAAA
26        extraopts = -some-letter-the-author-did-not-think-of
27        ipversion = 4
28        pings = 5
29        plugin = /path/to/dns.so
30        pluginargs = -p plugin_specific_arg
31        priority = 6
32        timeout = 1
33        tos = 0xa0
34        waittime = 1
35
36        # [...]
37
38        *** Targets ***
39
40        probe = EchoPingDNS # if this should be the default probe
41
42        # [...]
43
44        + mytarget
45        # probe = EchoPingDNS # if the default probe is something else
46        host = my.host
47        dns_request = example.org # mandatory
48        dns_tcp = yes
49        dns_type = AAAA
50        extraopts = -some-letter-the-author-did-not-think-of
51        ipversion = 4
52        pings = 5
53        plugin = /path/to/dns.so
54        pluginargs = -p plugin_specific_arg
55        priority = 6
56        timeout = 1
57        tos = 0xa0
58        waittime = 1
59

VARIABLES

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

AUTHORS

181       Niko Tyni <ntyni@iki.fi>
182

NOTES

184       The fill, size and udp EchoPing variables are not valid.
185
186       Plugins, including echoping_dns, are available starting with echoping
187       version 6.
188

NAME

OVERVIEW

SYNOPSIS

VARIABLES

AUTHORS

NOTES

SEE ALSO