.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Smokeping_probes_SipSak 3"
.TH Smokeping_probes_SipSak 3 2024-02-04 2.8.2 SmokePing
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Smokeping::probes::SipSak \- tests sip server
.SH OVERVIEW
.IX Header "OVERVIEW"
This probe sends OPTIONS messages to a sip server testing the latency.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& *** Probes ***
\&
\& +SipSak
\&
\& binary = /usr/bin/sipsak
\& forks = 5
\& offset = 50%
\& step = 300
\& timeout = 15
\&
\& # The following variables can be overridden in each target section
\& /^influx_.+/ = influx_location = In the basement
\& keep_second = yes
\& params = \-\-numeric \-\-password=mysecret
\& pings = 5
\& port = 5061
\& sipsak_timeout = 2
\& user = nobody
\&
\& # [...]
\&
\& *** Targets ***
\&
\& probe = SipSak # if this should be the default probe
\&
\& # [...]
\&
\& + mytarget
\& # probe = SipSak # if the default probe is something else
\& host = my.host
\& /^influx_.+/ = influx_location = In the basement
\& keep_second = yes
\& params = \-\-numeric \-\-password=mysecret
\& pings = 5
\& port = 5061
\& sipsak_timeout = 2
\& user = nobody
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The probe uses the sipsak <http://sipsak.org/> tool to measure sip server latency by sending an OPTIONS message.
.PP
The sipsak command supports a large number of additional parameters to fine-tune its operation. Use the
params variable to configure them.
.SH VARIABLES
.IX Header "VARIABLES"
Supported probe-specific variables:
.IP binary 4
.IX Item "binary"
The location of your echoping binary.
.Sp
Default value: /usr/bin/sipsak
.IP forks 4
.IX Item "forks"
Run this many concurrent processes at maximum
.Sp
Example value: 5
.Sp
Default value: 5
.IP offset 4
.IX Item "offset"
If you run many probes concurrently you may want to prevent them from
hitting your network all at the same time. Using the probe-specific
offset parameter you can change the point in time when each probe will
be run. Offset is specified in % of total interval, or alternatively as
\&'random', and the offset from the 'General' section is used if nothing
is specified here. Note that this does NOT influence the rrds itself,
it is just a matter of when data acquisition is initiated.
(This variable is only applicable if the variable 'concurrentprobes' is set
in the 'General' section.)
.Sp
Example value: 50%
.IP step 4
.IX Item "step"
Duration of the base interval that this probe should use, if different
from the one specified in the 'Database' section. Note that the step in
the RRD files is fixed when they are originally generated, and if you
change the step parameter afterwards, you'll have to delete the old RRD
files or somehow convert them. (This variable is only applicable if
the variable 'concurrentprobes' is set in the 'General' section.)
.Sp
Example value: 300
.IP timeout 4
.IX Item "timeout"
How long a single 'ping' takes at maximum
.Sp
Example value: 15
.Sp
Default value: 5
.PP
Supported target-specific variables:
.IP /^influx_.+/ 4
.IX Item "/^influx_.+/"
This is a tag that will be sent to influxdb and has no impact on the probe measurement. The tag name will be sent without the "influx_" prefix, which will be replaced with "tag_" instead. Tags can be used for filtering.
.Sp
Example value: influx_location = In the basement
.IP keep_second 4
.IX Item "keep_second"
If OPTIONS is actually implemented by the server, SipSak will receive two responses. If this option is set, the timing from the second, final response will be counter
.Sp
Example value: yes
.IP params 4
.IX Item "params"
additional sipsak options. The options will get split on space.
.Sp
Example value: \-\-numeric \-\-password=mysecret
.IP pings 4
.IX Item "pings"
How many pings should be sent to each target, if different from the global
value specified in the Database section. Note that the number of pings in
the RRD files is fixed when they are originally generated, and if you
change this parameter afterwards, you'll have to delete the old RRD
files or somehow convert them.
.Sp
Example value: 5
.IP port 4
.IX Item "port"
usa non-default port for the sip connection.
.Sp
Example value: 5061
.IP sipsak_timeout 4
.IX Item "sipsak_timeout"
Timeout for sipsak in seconds (fractional)
.Sp
Default value: 2
.IP user 4
.IX Item "user"
User to use for sip connection.
.Sp
Example value: nobody
.SH AUTHORS
.IX Header "AUTHORS"
Tobias Oetiker <tobi@oetiker.ch> sponsored by ANI Networks