1Smokeping_probes_Qstat(3)          SmokePing         Smokeping_probes_Qstat(3)
2
3
4

NAME

6       Smokeping::probes::Qstat - Qstat Probe for SmokePing
7

SYNOPSIS

9        *** Probes ***
10
11        +Qstat
12
13        binary = /usr/bin/quakestatba # mandatory
14        forks = 5
15        game = nexuizs
16        mininterval = 0.1
17        offset = 50%
18        port = 27970
19        sourceaddress = 192.168.0.1
20        sourceport = 9923-9943
21        step = 300
22        timeout = 15
23
24        # The following variables can be overridden in each target section
25        pings = 5
26
27        # [...]
28
29        *** Targets ***
30
31        probe = Qstat # if this should be the default probe
32
33        # [...]
34
35        + mytarget
36        # probe = Qstat # if the default probe is something else
37        host = my.host
38        pings = 5
39

DESCRIPTION

41       Integrates Qstat as a probe into smokeping. The variable binary must
42       point to your copy of the Qstat program.
43
44       Make sure to set your pings to 10, most Quake servers seem to throttle
45       after 10 rapid pings.
46
47       Set the game parameter to one of the valid options to check a different
48       type
49

VARIABLES

51       Supported probe-specific variables:
52
53       binary
54           The location of your quakestat binary.
55
56           Example value: /usr/bin/quakestatba
57
58           This setting is mandatory.
59
60       forks
61           Run this many concurrent processes at maximum
62
63           Example value: 5
64
65           Default value: 5
66
67       game
68           What game type to check, from the -default flag of quakestat
69
70           Example value: nexuizs
71
72           Default value: q3s
73
74       mininterval
75           The minimum amount of time between sending a ping packet to the
76           target.
77
78           Example value: 0.1
79
80           Default value: 0.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           acqusition 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       port
96           The game server port to check. It can also be overriden by adding
97           :port to the host parameter in the Target config.
98
99           Example value: 27970
100
101       sourceaddress
102           The quakestat "-srcip" parameter . From quakestat(1):
103
104           Send packets using this IP address
105
106           Example value: 192.168.0.1
107
108       sourceport
109           The quakestat "-srcport" parameter . From quakestat(1):
110
111           Send packets from these network ports
112
113           Example value: 9923-9943
114
115       step
116           Duration of the base interval that this probe should use, if
117           different from the one specified in the 'Database' section. Note
118           that the step in the RRD files is fixed when they are originally
119           generated, and if you change the step parameter afterwards, you'll
120           have to delete the old RRD files or somehow convert them. (This
121           variable is only applicable if the variable 'concurrentprobes' is
122           set in the 'General' section.)
123
124           Example value: 300
125
126       timeout
127           How long a single 'ping' takes at maximum
128
129           Example value: 15
130
131           Default value: 5
132
133       Supported target-specific variables:
134
135       pings
136           How many pings should be sent to each target, if different from the
137           global value specified in the Database section. Note that the
138           number of pings in the RRD files is fixed when they are originally
139           generated, and if you change this parameter afterwards, you'll have
140           to delete the old RRD files or somehow convert them.
141
142           Example value: 5
143

AUTHORS

145       Walter Huf <hufman@gmail.com>
146
147
148
1492.7.3                             2021-07-23         Smokeping_probes_Qstat(3)