Smokeping_probes_SipSak(3)

NAME
Smokeping::probes::SipSak - tests sip server

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

SYNOPSIS
 *** 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

DESCRIPTION
The probe uses the sipsak <http://sipsak.org/> tool to measure sip server latency by sending an OPTIONS message.

The sipsak command supports a large number of additional parameters to fine-tune its operation. Use the params variable to configure them.

VARIABLES
Supported probe-specific variables:

binary
    The location of your echoping binary.

    Default value: /usr/bin/sipsak

forks
    Run this many concurrent processes at maximum

    Example value: 5

    Default value: 5

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.)

    Example value: 50%

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.)

    Example value: 300

timeout
    How long a single 'ping' takes at maximum

    Example value: 15

    Default value: 5

Supported target-specific variables:

/^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.

    Example value: influx_location = In the basement

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

    Example value: yes

params
    additional sipsak options. The options will get split on space.

    Example value: --numeric --password=mysecret

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.

    Example value: 5

port
    usa non-default port for the sip connection.

    Example value: 5061

sipsak_timeout
    Timeout for sipsak in seconds (fractional)

    Default value: 2

user
    User to use for sip connection.

    Example value: nobody

AUTHORS
Tobias Oetiker <tobi@oetiker.ch> sponsored by ANI Networks