.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "doc::Smokeping::probes::EchoPingHttps 3"
.TH doc::Smokeping::probes::EchoPingHttps 3 "2008-07-24" "2.4.2" "SmokePing"
.SH "NAME"
Smokeping::probes::EchoPingHttps \- an echoping(1) probe for SmokePing
.SH "OVERVIEW"
.IX Header "OVERVIEW"
Measures \s-1HTTPS\s0 (\s-1HTTP\s0 over \s-1SSL\s0) roundtrip times (web servers and caches) for
SmokePing.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& *** Probes ***
.Ve
.PP
.Vb 1
\& +EchoPingHttps
.Ve
.PP
.Vb 4
\& binary = /usr/bin/echoping
\& forks = 5
\& offset = 50%
\& step = 300
.Ve
.PP
.Vb 13
\& # The following variables can be overridden in each target section
\& accept_redirects = yes
\& extraopts = \-some\-letter\-the\-author\-did\-not\-think\-of
\& ignore_cache = yes
\& ipversion = 4
\& pings = 5
\& port = 80
\& priority = 6
\& revalidate_data = no
\& timeout = 1
\& tos = 0xa0
\& url = /
\& waittime = 1
.Ve
.PP
.Vb 1
\& # [...]
.Ve
.PP
.Vb 1
\& *** Targets ***
.Ve
.PP
.Vb 1
\& probe = EchoPingHttps # if this should be the default probe
.Ve
.PP
.Vb 1
\& # [...]
.Ve
.PP
.Vb 15
\& + mytarget
\& # probe = EchoPingHttps # if the default probe is something else
\& host = my.host
\& accept_redirects = yes
\& extraopts = \-some\-letter\-the\-author\-did\-not\-think\-of
\& ignore_cache = yes
\& ipversion = 4
\& pings = 5
\& port = 80
\& priority = 6
\& revalidate_data = no
\& timeout = 1
\& tos = 0xa0
\& url = /
\& waittime = 1
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
As \fIEchoPingHttp\fR\|(3pm), but SSL\-enabled.
.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/echoping
.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 \s-1NOT\s0 influence the rrds itself,
it is just a matter of when data acqusition 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 \s-1RRD\s0 files is fixed when they are originally generated, and if you
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
files or somehow convert them. (This variable is only applicable if
the variable 'concurrentprobes' is set in the 'General' section.)
.Sp
Example value: 300
.PP
Supported target-specific variables:
.IP "accept_redirects" 4
.IX Item "accept_redirects"
The \fIechoping\fR\|(1) \*(L"\-R\*(R" option: Accept  \s-1HTTP\s0  status  codes  3xx (redirections) 
as normal responses instead of treating them as errors. Note that this option
is only available starting with Echoping 6.
.Sp
Enabled if the value is anything other than 'no' or '0'.
.Sp
Example value: yes
.IP "extraopts" 4
.IX Item "extraopts"
Any extra options specified here will be passed unmodified to \fIechoping\fR\|(1).
.Sp
Example value: \-some\-letter\-the\-author\-did\-not\-think\-of
.IP "ignore_cache" 4
.IX Item "ignore_cache"
The \fIechoping\fR\|(1) \*(L"\-A\*(R" option: force the proxy to ignore the cache.
Enabled if the value is anything other than 'no' or '0'.
.Sp
Example value: yes
.IP "ipversion" 4
.IX Item "ipversion"
The \s-1IP\s0 protocol used. Possible values are \*(L"4\*(R" and \*(L"6\*(R". 
Passed to \fIechoping\fR\|(1) as the \*(L"\-4\*(R" or \*(L"\-6\*(R" options.
.Sp
Example value: 4
.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 \s-1RRD\s0 files is fixed when they are originally generated, and if you
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
files or somehow convert them.
.Sp
Example value: 5
.IP "port" 4
.IX Item "port"
The \s-1TCP\s0 port to use.
.Sp
Example value: 80
.IP "priority" 4
.IX Item "priority"
The \*(L"\-p\*(R" \fIechoping\fR\|(1) option.
.Sp
Example value: 6
.IP "revalidate_data" 4
.IX Item "revalidate_data"
The \fIechoping\fR\|(1) \*(L"\-a\*(R" option: force the proxy to revalidate data with original 
server. Enabled if the value is anything other than 'no' or '0'.
.Sp
Example value: no
.IP "timeout" 4
.IX Item "timeout"
The \*(L"\-t\*(R" \fIechoping\fR\|(1) option.
.Sp
Example value: 1
.Sp
Default value: 5
.IP "tos" 4
.IX Item "tos"
The \*(L"\-P\*(R" \fIechoping\fR\|(1) option.
.Sp
Example value: 0xa0
.IP "url" 4
.IX Item "url"
The \s-1URL\s0 to be requested from the web server or cache. Can be either relative
(/...) for web servers or absolute (http://...) for caches.
.Sp
Default value: /
.IP "waittime" 4
.IX Item "waittime"
The \*(L"\-w\*(R" \fIechoping\fR\|(1) option.
.Sp
Example value: 1
.SH "AUTHORS"
.IX Header "AUTHORS"
Niko Tyni <ntyni@iki.fi>
.SH "NOTES"
.IX Header "NOTES"
You should consider setting a lower value for the \f(CW\*(C`pings\*(C'\fR variable than the
default 20, as repetitive \s-1URL\s0 fetching may be quite heavy on the server.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Smokeping::probes::EchoPingHttp