1Smokeping_probes_SipSak(3)         SmokePing        Smokeping_probes_SipSak(3)
2
3
4

NAME

6       Smokeping::probes::SipSak - tests sip server
7

OVERVIEW

9       This probe sends OPTIONS messages to a sip server testing the latency.
10

SYNOPSIS

12        *** Probes ***
13
14        +SipSak
15
16        binary = /usr/bin/sipsak
17        forks = 5
18        offset = 50%
19        step = 300
20        timeout = 15
21
22        # The following variables can be overridden in each target section
23        /^influx_.+/ = influx_location = In the basement
24        keep_second = yes
25        params = --numeric --password=mysecret
26        pings = 5
27        port = 5061
28        sipsak_timeout = 2
29        user = nobody
30
31        # [...]
32
33        *** Targets ***
34
35        probe = SipSak # if this should be the default probe
36
37        # [...]
38
39        + mytarget
40        # probe = SipSak # if the default probe is something else
41        host = my.host
42        /^influx_.+/ = influx_location = In the basement
43        keep_second = yes
44        params = --numeric --password=mysecret
45        pings = 5
46        port = 5061
47        sipsak_timeout = 2
48        user = nobody
49

DESCRIPTION

51       The probe uses the sipsak <http://sipsak.org/> tool to measure sip
52       server latency by sending an OPTIONS message.
53
54       The sipsak command supports a large number of additional parameters to
55       fine-tune its operation. Use the params variable to configure them.
56

VARIABLES

58       Supported probe-specific variables:
59
60       binary
61           The location of your echoping binary.
62
63           Default value: /usr/bin/sipsak
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       timeout
97           How long a single 'ping' takes at maximum
98
99           Example value: 15
100
101           Default value: 5
102
103       Supported target-specific variables:
104
105       /^influx_.+/
106           This is a tag that will be sent to influxdb and has no impact on
107           the probe measurement. The tag name will be sent without the
108           "influx_" prefix, which will be replaced with "tag_" instead. Tags
109           can be used for filtering.
110
111           Example value: influx_location = In the basement
112
113       keep_second
114           If OPTIONS is actually implemented by the server, SipSak will
115           receive two responses. If this option is set, the timing from the
116           second, final response will be counter
117
118           Example value: yes
119
120       params
121           additional sipsak options. The options will get split on space.
122
123           Example value: --numeric --password=mysecret
124
125       pings
126           How many pings should be sent to each target, if different from the
127           global value specified in the Database section. Note that the
128           number of pings in the RRD files is fixed when they are originally
129           generated, and if you change this parameter afterwards, you'll have
130           to delete the old RRD files or somehow convert them.
131
132           Example value: 5
133
134       port
135           usa non-default port for the sip connection.
136
137           Example value: 5061
138
139       sipsak_timeout
140           Timeout for sipsak in seconds (fractional)
141
142           Default value: 2
143
144       user
145           User to use for sip connection.
146
147           Example value: nobody
148

AUTHORS

150       Tobias Oetiker <tobi@oetiker.ch> sponsored by ANI Networks
151
152
153
1542.8.2                             2022-07-23        Smokeping_probes_SipSak(3)
Impressum