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        keep_second = yes
24        params = --numeric --password=mysecret
25        pings = 5
26        port = 5061
27        sipsak_timeout = 2
28        user = nobody
29
30        # [...]
31
32        *** Targets ***
33
34        probe = SipSak # if this should be the default probe
35
36        # [...]
37
38        + mytarget
39        # probe = SipSak # if the default probe is something else
40        host = my.host
41        keep_second = yes
42        params = --numeric --password=mysecret
43        pings = 5
44        port = 5061
45        sipsak_timeout = 2
46        user = nobody
47

DESCRIPTION

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

VARIABLES

56       Supported probe-specific variables:
57
58       binary
59           The location of your echoping binary.
60
61           Default value: /usr/bin/sipsak
62
63       forks
64           Run this many concurrent processes at maximum
65
66           Example value: 5
67
68           Default value: 5
69
70       offset
71           If you run many probes concurrently you may want to prevent them
72           from hitting your network all at the same time. Using the probe-
73           specific offset parameter you can change the point in time when
74           each probe will be run. Offset is specified in % of total interval,
75           or alternatively as 'random', and the offset from the 'General'
76           section is used if nothing is specified here. Note that this does
77           NOT influence the rrds itself, it is just a matter of when data
78           acqusition is initiated.  (This variable is only applicable if the
79           variable 'concurrentprobes' is set in the 'General' section.)
80
81           Example value: 50%
82
83       step
84           Duration of the base interval that this probe should use, if
85           different from the one specified in the 'Database' section. Note
86           that the step in the RRD files is fixed when they are originally
87           generated, and if you change the step parameter afterwards, you'll
88           have to delete the old RRD files or somehow convert them. (This
89           variable is only applicable if the variable 'concurrentprobes' is
90           set in the 'General' section.)
91
92           Example value: 300
93
94       timeout
95           How long a single 'ping' takes at maximum
96
97           Example value: 15
98
99           Default value: 5
100
101       Supported target-specific variables:
102
103       keep_second
104           If OPTIONS is actually implemented by the server, SipSak will
105           receive two responses. If this option is set, the timeing from the
106           second, final response will be counter
107
108           Example value: yes
109
110       params
111           additional sipsak options. The options will get split on space.
112
113           Example value: --numeric --password=mysecret
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       port
125           usa non-default port for the sip connection.
126
127           Example value: 5061
128
129       sipsak_timeout
130           Timeout for sipsak in seconds (fractional)
131
132           Default value: 2
133
134       user
135           User to use for sip connection.
136
137           Example value: nobody
138

AUTHORS

140       Tobias Oetiker <tobi@oetiker.ch> sponsored by ANI Networks
141
142
143
1442.7.2                             2019-02-02        Smokeping_probes_SipSak(3)