=head1 NAME

Smokeping::probes::EchoPingHttps - an echoping(1) probe for SmokePing

=head1 OVERVIEW

Measures HTTPS (HTTP over SSL) roundtrip times (web servers and caches) for
SmokePing.

=head1 SYNOPSIS

 *** Probes ***

 +EchoPingHttps

 binary = /usr/bin/echoping
 forks = 5
 offset = 50%
 step = 300

 # The following variables can be overridden in each target section
 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

 # [...]

 *** Targets ***

 probe = EchoPingHttps # if this should be the default probe

 # [...]

 + mytarget
 # probe = EchoPingHttps # if the default probe is something else
 host = my.host
 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

=head1 DESCRIPTION

As EchoPingHttp(3pm), but SSL-enabled.

=head1 VARIABLES

Supported probe-specific variables:

=over

=item binary

The location of your echoping binary.

Default value: /usr/bin/echoping

=item forks

Run this many concurrent processes at maximum

Example value: 5

Default value: 5

=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 acqusition is initiated.
(This variable is only applicable if the variable 'concurrentprobes' is set
in the 'General' section.)

Example value: 50%

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

Example value: 300

=back

Supported target-specific variables:

=over

=item extraopts

Any extra options specified here will be passed unmodified to echoping(1).

Example value: -some-letter-the-author-did-not-think-of

=item ignore_cache

The echoping(1) "-A" option: force the proxy to ignore the cache.
Enabled if the value is anything other than 'no' or '0'.

Example value: yes

=item ipversion

The IP protocol used. Possible values are "4" and "6". 
Passed to echoping(1) as the "-4" or "-6" options.

Example value: 4

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

Example value: 5

=item port

The TCP port to use.

Example value: 80

=item priority

The "-p" echoping(1) option.

Example value: 6

=item revalidate_data

The echoping(1) "-a" option: force the proxy to revalidate data with original 
server. Enabled if the value is anything other than 'no' or '0'.

Example value: no

=item timeout

The "-t" echoping(1) option.

Example value: 1

Default value: 5

=item tos

The "-P" echoping(1) option.

Example value: 0xa0

=item url

The URL to be requested from the web server or cache. Can be either relative
(/...) for web servers or absolute (http://...) for caches.

Default value: /

=item waittime

The "-w" echoping(1) option.

Example value: 1

=back


=head1 AUTHORS

Niko Tyni <ntyni@iki.fi>

=head1 NOTES

You should consider setting a lower value for the C<pings> variable than the
default 20, as repetitive URL fetching may be quite heavy on the server.

=head1 SEE ALSO

L<Smokeping::probes::EchoPingHttp>

=cut