1Smokeping_probes_TCPPing(3) SmokePing Smokeping_probes_TCPPing(3)
2
3
4
6 Smokeping::probes::TCPPing - TCPPing Probe for SmokePing
7
9 *** Probes ***
10
11 +TCPPing
12
13 binary = /usr/bin/tcpping # mandatory
14 forks = 5
15 offset = 50%
16 step = 300
17 timeout = 15
18
19 # The following variables can be overridden in each target section
20 /^influx_.+/ = influx_location = In the basement
21 pings = 5
22 port = 80
23
24 # [...]
25
26 *** Targets ***
27
28 probe = TCPPing # if this should be the default probe
29
30 # [...]
31
32 + mytarget
33 # probe = TCPPing # if the default probe is something else
34 host = my.host
35 /^influx_.+/ = influx_location = In the basement
36 pings = 5
37 port = 80
38
40 Integrates TCPPing as a probe into smokeping. The variable binary must
41 point to your copy of the TCPPing program. If it is not installed on
42 your system yet, you can get it from https://github.com/deajan/tcpping.
43
44 The (optional) port option lets you configure the port for the pings
45 sent. The TCPPing manpage has the following to say on this topic:
46
47 The problem is that with the widespread use of firewalls on the modern
48 Internet, many of the packets that traceroute(8) sends out end up being
49 filtered, making it impossible to completely trace the path to the
50 destination. However, in many cases, these firewalls will permit
51 inbound TCP packets to specific ports that hosts sitting behind the
52 firewall are listening for connections on. By sending out TCP SYN
53 packets instead of UDP or ICMP ECHO packets, tcptraceroute is able to
54 bypass the most common firewall filters.
55
56 It is worth noting that tcptraceroute never completely establishes a
57 TCP connection with the destination host. If the host is not listening
58 for incoming connections, it will respond with an RST indicating that
59 the port is closed. If the host instead responds with a SYN|ACK, the
60 port is known to be open, and an RST is sent by the kernel
61 tcptraceroute is running on to tear down the connection without
62 completing three-way handshake. This is the same half-open scanning
63 technique that nmap(1) uses when passed the -sS flag.
64
66 Supported probe-specific variables:
67
68 binary
69 The location of your tcpping script.
70
71 Example value: /usr/bin/tcpping
72
73 This setting is mandatory.
74
75 forks
76 Run this many concurrent processes at maximum
77
78 Example value: 5
79
80 Default value: 5
81
82 offset
83 If you run many probes concurrently you may want to prevent them
84 from hitting your network all at the same time. Using the probe-
85 specific offset parameter you can change the point in time when
86 each probe will be run. Offset is specified in % of total interval,
87 or alternatively as 'random', and the offset from the 'General'
88 section is used if nothing is specified here. Note that this does
89 NOT influence the rrds itself, it is just a matter of when data
90 acquisition is initiated. (This variable is only applicable if the
91 variable 'concurrentprobes' is set in the 'General' section.)
92
93 Example value: 50%
94
95 step
96 Duration of the base interval that this probe should use, if
97 different from the one specified in the 'Database' section. Note
98 that the step in the RRD files is fixed when they are originally
99 generated, and if you change the step parameter afterwards, you'll
100 have to delete the old RRD files or somehow convert them. (This
101 variable is only applicable if the variable 'concurrentprobes' is
102 set in the 'General' section.)
103
104 Example value: 300
105
106 timeout
107 How long a single 'ping' takes at maximum
108
109 Example value: 15
110
111 Default value: 5
112
113 Supported target-specific variables:
114
115 /^influx_.+/
116 This is a tag that will be sent to influxdb and has no impact on
117 the probe measurement. The tag name will be sent without the
118 "influx_" prefix, which will be replaced with "tag_" instead. Tags
119 can be used for filtering.
120
121 Example value: influx_location = In the basement
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 port
133 The TCP port the probe should measure.
134
135 Example value: 80
136
138 Norman Rasmussen <norman@rasmussen.co.za> Patched for Smokeping 2.x
139 compatibility by Anton Chernev <maznio@doom.bg>
140
141
142
1432.8.2 2022-07-23 Smokeping_probes_TCPPing(3)