<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Smokeping/probes/EchoPingHttps</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:root@localhost" /> </head> <body style="background-color: white"> <p><a name="__index__"></a></p> <!-- INDEX BEGIN --> <!-- <ul> <li><a href="#name">NAME</a></li> <li><a href="#overview">OVERVIEW</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#description">DESCRIPTION</a></li> <li><a href="#variables">VARIABLES</a></li> <li><a href="#authors">AUTHORS</a></li> <li><a href="#notes">NOTES</a></li> <li><a href="#see_also">SEE ALSO</a></li> </ul> --> <!-- INDEX END --> <p> </p> <h1><a name="name">NAME</a></h1> <p>Smokeping::probes::EchoPingHttps - an <code>echoping(1)</code> probe for SmokePing</p> <p> </p> <hr /> <h1><a name="overview">OVERVIEW</a></h1> <p>Measures HTTPS (HTTP over SSL) roundtrip times (web servers and caches) for SmokePing.</p> <p> </p> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <pre> *** Probes ***</pre> <pre> +EchoPingHttps</pre> <pre> binary = /usr/bin/echoping forks = 5 offset = 50% step = 300</pre> <pre> # 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</pre> <pre> # [...]</pre> <pre> *** Targets ***</pre> <pre> probe = EchoPingHttps # if this should be the default probe</pre> <pre> # [...]</pre> <pre> + 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</pre> <p> </p> <hr /> <h1><a name="description">DESCRIPTION</a></h1> <p>As EchoPingHttp(3pm), but SSL-enabled.</p> <p> </p> <hr /> <h1><a name="variables">VARIABLES</a></h1> <p>Supported probe-specific variables:</p> <dl> <dt><strong><a name="item_binary">binary</a></strong> </dt><dd> <p>The location of your echoping binary.</p> <p>Default value: /usr/bin/echoping</p> </dd><dt><strong><a name="item_forks">forks</a></strong> </dt><dd> <p>Run this many concurrent processes at maximum</p> <p>Example value: 5</p> <p>Default value: 5</p> </dd><dt><strong><a name="item_offset">offset</a></strong> </dt><dd> <p>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.)</p> <p>Example value: 50%</p> </dd><dt><strong><a name="item_step">step</a></strong> </dt><dd> <p>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.)</p> <p>Example value: 300</p> </dd></dl> <p>Supported target-specific variables:</p> <dl> <dt><strong><a name="item_accept_redirects">accept_redirects</a></strong> </dt><dd> <p>The <code>echoping(1)</code> ``-R'' option: Accept HTTP status codes 3xx (redirections) as normal responses instead of treating them as errors. Note that this option is only available starting with Echoping 6.</p> <p>Enabled if the value is anything other than 'no' or '0'.</p> <p>Example value: yes</p> </dd><dt><strong><a name="item_extraopts">extraopts</a></strong> </dt><dd> <p>Any extra options specified here will be passed unmodified to echoping(1).</p> <p>Example value: -some-letter-the-author-did-not-think-of</p> </dd><dt><strong><a name="item_ignore_cache">ignore_cache</a></strong> </dt><dd> <p>The <code>echoping(1)</code> ``-A'' option: force the proxy to ignore the cache. Enabled if the value is anything other than 'no' or '0'.</p> <p>Example value: yes</p> </dd><dt><strong><a name="item_ipversion">ipversion</a></strong> </dt><dd> <p>The IP protocol used. Possible values are ``4'' and ``6''. Passed to <code>echoping(1)</code> as the ``-4'' or ``-6'' options.</p> <p>Example value: 4</p> </dd><dt><strong><a name="item_pings">pings</a></strong> </dt><dd> <p>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.</p> <p>Example value: 5</p> </dd><dt><strong><a name="item_port">port</a></strong> </dt><dd> <p>The TCP port to use.</p> <p>Example value: 80</p> </dd><dt><strong><a name="item_priority">priority</a></strong> </dt><dd> <p>The ``-p'' <code>echoping(1)</code> option.</p> <p>Example value: 6</p> </dd><dt><strong><a name="item_revalidate_data">revalidate_data</a></strong> </dt><dd> <p>The <code>echoping(1)</code> ``-a'' option: force the proxy to revalidate data with original server. Enabled if the value is anything other than 'no' or '0'.</p> <p>Example value: no</p> </dd><dt><strong><a name="item_timeout">timeout</a></strong> </dt><dd> <p>The ``-t'' <code>echoping(1)</code> option.</p> <p>Example value: 1</p> <p>Default value: 5</p> </dd><dt><strong><a name="item_tos">tos</a></strong> </dt><dd> <p>The ``-P'' <code>echoping(1)</code> option.</p> <p>Example value: 0xa0</p> </dd><dt><strong><a name="item_url">url</a></strong> </dt><dd> <p>The URL to be requested from the web server or cache. Can be either relative (/...) for web servers or absolute (http://...) for caches.</p> <p>Default value: /</p> </dd><dt><strong><a name="item_waittime">waittime</a></strong> </dt><dd> <p>The ``-w'' <code>echoping(1)</code> option.</p> <p>Example value: 1</p> </dd></dl> <p> </p> <hr /> <h1><a name="authors">AUTHORS</a></h1> <p>Niko Tyni <<a href="mailto:ntyni@iki.fi">ntyni@iki.fi</a>></p> <p> </p> <hr /> <h1><a name="notes">NOTES</a></h1> <p>You should consider setting a lower value for the <a href="#item_pings"><code>pings</code></a> variable than the default 20, as repetitive URL fetching may be quite heavy on the server.</p> <p> </p> <hr /> <h1><a name="see_also">SEE ALSO</a></h1> <p><a href="./../../Smokeping/probes/EchoPingHttp.html">the Smokeping::probes::EchoPingHttp manpage</a></p> </body> </html>