Smokeping_probes_EchoPingIcp(3)

1Smokeping_probes_EchoPingIcp(3)    SmokePing   Smokeping_probes_EchoPingIcp(3)
2
3
4

NAME

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

OVERVIEW

9       Measures ICP (Internet Cache Protocol, spoken by web caches) roundtrip
10       times for SmokePing.
11

SYNOPSIS

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

VARIABLES

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

AUTHORS

152       Niko Tyni <ntyni@iki.fi>
153

NOTES

155       The fill, size and udp EchoPing variables are not valid.
156

NAME

OVERVIEW

SYNOPSIS

VARIABLES

AUTHORS

NOTES

SEE ALSO