Smokeping_probes_EchoPingDiscard(3)

1Smokeping_probes_EchoPingDiscard(3)SmokePingSmokeping_probes_EchoPingDiscard(3)
2
3
4

NAME

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

OVERVIEW

9       Measures TCP or UDP discard (port 9) roundtrip times for SmokePing.
10

SYNOPSIS

12        *** Probes ***
13
14        +EchoPingDiscard
15
16        binary = /usr/bin/echoping
17        forks = 5
18        offset = 50%
19        step = 300
20
21        # The following variables can be overridden in each target section
22        /^influx_.+/ = influx_location = In the basement
23        extraopts = -some-letter-the-author-did-not-think-of
24        fill = A
25        ipversion = 4
26        pings = 5
27        priority = 6
28        size = 510
29        timeout = 1
30        tos = 0xa0
31        udp = no
32        waittime = 1
33
34        # [...]
35
36        *** Targets ***
37
38        probe = EchoPingDiscard # if this should be the default probe
39
40        # [...]
41
42        + mytarget
43        # probe = EchoPingDiscard # if the default probe is something else
44        host = my.host
45        /^influx_.+/ = influx_location = In the basement
46        extraopts = -some-letter-the-author-did-not-think-of
47        fill = A
48        ipversion = 4
49        pings = 5
50        priority = 6
51        size = 510
52        timeout = 1
53        tos = 0xa0
54        udp = no
55        waittime = 1
56

VARIABLES

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

AUTHORS

164       Niko Tyni <ntyni@iki.fi>
165

NAME

OVERVIEW

SYNOPSIS

VARIABLES

AUTHORS

SEE ALSO