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        /^influx_.+/ = influx_location = In the basement
26        pings = 5
27
28        # [...]
29
30        *** Targets ***
31
32        probe = Qstat # if this should be the default probe
33
34        # [...]
35
36        + mytarget
37        # probe = Qstat # if the default probe is something else
38        host = my.host
39        /^influx_.+/ = influx_location = In the basement
40        pings = 5
41

DESCRIPTION

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

VARIABLES

53       Supported probe-specific variables:
54
55       binary
56           The location of your quakestat binary.
57
58           Example value: /usr/bin/quakestatba
59
60           This setting is mandatory.
61
62       forks
63           Run this many concurrent processes at maximum
64
65           Example value: 5
66
67           Default value: 5
68
69       game
70           What game type to check, from the -default flag of quakestat
71
72           Example value: nexuizs
73
74           Default value: q3s
75
76       mininterval
77           The minimum amount of time between sending a ping packet to the
78           target.
79
80           Example value: 0.1
81
82           Default value: 0.5
83
84       offset
85           If you run many probes concurrently you may want to prevent them
86           from hitting your network all at the same time. Using the probe-
87           specific offset parameter you can change the point in time when
88           each probe will be run. Offset is specified in % of total interval,
89           or alternatively as 'random', and the offset from the 'General'
90           section is used if nothing is specified here. Note that this does
91           NOT influence the rrds itself, it is just a matter of when data
92           acquisition is initiated.  (This variable is only applicable if the
93           variable 'concurrentprobes' is set in the 'General' section.)
94
95           Example value: 50%
96
97       port
98           The game server port to check. It can also be overridden by adding
99           :port to the host parameter in the Target config.
100
101           Example value: 27970
102
103       sourceaddress
104           The quakestat "-srcip" parameter . From quakestat(1):
105
106           Send packets using this IP address
107
108           Example value: 192.168.0.1
109
110       sourceport
111           The quakestat "-srcport" parameter . From quakestat(1):
112
113           Send packets from these network ports
114
115           Example value: 9923-9943
116
117       step
118           Duration of the base interval that this probe should use, if
119           different from the one specified in the 'Database' section. Note
120           that the step in the RRD files is fixed when they are originally
121           generated, and if you change the step parameter afterwards, you'll
122           have to delete the old RRD files or somehow convert them. (This
123           variable is only applicable if the variable 'concurrentprobes' is
124           set in the 'General' section.)
125
126           Example value: 300
127
128       timeout
129           How long a single 'ping' takes at maximum
130
131           Example value: 15
132
133           Default value: 5
134
135       Supported target-specific variables:
136
137       /^influx_.+/
138           This is a tag that will be sent to influxdb and has no impact on
139           the probe measurement. The tag name will be sent without the
140           "influx_" prefix, which will be replaced with "tag_" instead. Tags
141           can be used for filtering.
142
143           Example value: influx_location = In the basement
144
145       pings
146           How many pings should be sent to each target, if different from the
147           global value specified in the Database section. Note that the
148           number of pings in the RRD files is fixed when they are originally
149           generated, and if you change this parameter afterwards, you'll have
150           to delete the old RRD files or somehow convert them.
151
152           Example value: 5
153

AUTHORS

155       Walter Huf <hufman@gmail.com>
156
157
158
1592.8.2                             2022-07-23         Smokeping_probes_Qstat(3)
Impressum