Smokeping_probes_EchoPing(3)

1Smokeping_probes_EchoPing(3)       SmokePing      Smokeping_probes_EchoPing(3)
2
3
4

NAME

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

OVERVIEW

9       Measures TCP or UDP echo (port 7) roundtrip times for SmokePing. Can
10       also be used as a base class for other echoping(1) probes.
11

SYNOPSIS

13        *** Probes ***
14
15        +EchoPing
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        extraopts = -some-letter-the-author-did-not-think-of
25        fill = A
26        ipversion = 4
27        pings = 5
28        priority = 6
29        size = 510
30        timeout = 1
31        tos = 0xa0
32        udp = no
33        waittime = 1
34
35        # [...]
36
37        *** Targets ***
38
39        probe = EchoPing # if this should be the default probe
40
41        # [...]
42
43        + mytarget
44        # probe = EchoPing # if the default probe is something else
45        host = my.host
46        /^influx_.+/ = influx_location = In the basement
47        extraopts = -some-letter-the-author-did-not-think-of
48        fill = A
49        ipversion = 4
50        pings = 5
51        priority = 6
52        size = 510
53        timeout = 1
54        tos = 0xa0
55        udp = no
56        waittime = 1
57

DESCRIPTION

59       See echoping(1) for details of the options below.
60

VARIABLES

62       Supported probe-specific variables:
63
64       binary
65           The location of your echoping binary.
66
67           Default value: /usr/bin/echoping
68
69       forks
70           Run this many concurrent processes at maximum
71
72           Example value: 5
73
74           Default value: 5
75
76       offset
77           If you run many probes concurrently you may want to prevent them
78           from hitting your network all at the same time. Using the probe-
79           specific offset parameter you can change the point in time when
80           each probe will be run. Offset is specified in % of total interval,
81           or alternatively as 'random', and the offset from the 'General'
82           section is used if nothing is specified here. Note that this does
83           NOT influence the rrds itself, it is just a matter of when data
84           acquisition is initiated.  (This variable is only applicable if the
85           variable 'concurrentprobes' is set in the 'General' section.)
86
87           Example value: 50%
88
89       step
90           Duration of the base interval that this probe should use, if
91           different from the one specified in the 'Database' section. Note
92           that the step in the RRD files is fixed when they are originally
93           generated, and if you change the step parameter afterwards, you'll
94           have to delete the old RRD files or somehow convert them. (This
95           variable is only applicable if the variable 'concurrentprobes' is
96           set in the 'General' section.)
97
98           Example value: 300
99
100       Supported target-specific variables:
101
102       /^influx_.+/
103           This is a tag that will be sent to influxdb and has no impact on
104           the probe measurement. The tag name will be sent without the
105           "influx_" prefix, which will be replaced with "tag_" instead. Tags
106           can be used for filtering.
107
108           Example value: influx_location = In the basement
109
110       extraopts
111           Any extra options specified here will be passed unmodified to
112           echoping(1).
113
114           Example value: -some-letter-the-author-did-not-think-of
115
116       fill
117           The "-f" echoping(1) option.
118
119           Example value: A
120
121       ipversion
122           The IP protocol used. Possible values are "4" and "6".  Passed to
123           echoping(1) as the "-4" or "-6" options.
124
125           Example value: 4
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       priority
137           The "-p" echoping(1) option.
138
139           Example value: 6
140
141       size
142           The "-s" echoping(1) option.
143
144           Example value: 510
145
146       timeout
147           The "-t" echoping(1) option.
148
149           Example value: 1
150
151           Default value: 5
152
153       tos The "-P" echoping(1) option.
154
155           Example value: 0xa0
156
157       udp The "-u" echoping(1) option. Values other than '0' and 'no' enable
158           UDP.
159
160           Example value: no
161
162       waittime
163           The "-w" echoping(1) option.
164
165           Example value: 1
166

AUTHORS

168       Niko Tyni <ntyni@iki.fi>
169

BUGS

171       Should we test the availability of the service at startup? After that
172       it's too late to complain.
173
174       The location of the echoping binary should probably be a global
175       variable instead of a probe-specific one. As things are, every EchoPing
176       -derived probe has to declare it if the default (/usr/bin/echoping)
177       isn't correct.
178