Changeset 3cf4259c9a6bd208946be66ee72df20ce2a9ed17

Show
Ignore:
Timestamp:
08/30/11 12:00:27 (3 years ago)
Author:
Theo Schlossnagle <jesus@omniti.com>
git-committer:
Theo Schlossnagle <jesus@omniti.com> 1314705627 -0400
git-parent:

[f1ce404f9e0e999fd53584c096f4f305dfef8a20]

git-author:
Dan Di Spaltro <dan@cloudkick.com> 1314679461 -0700
Message:

Add the docs for check_test

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • src/modules/check_test.xml

    rbb10f44 r3cf4259  
     1<module> 
     2    <name>check_test</name> 
     3    <description> 
     4        <para> 
     5            This module exposes an API endpoint to  
     6            allow users to run a check once in transient mode to  
     7            return the results inline back to the client. 
     8        </para> 
     9        <para> 
     10            The check runs once however it behaves almost exactly like a /check/set</para></description> 
     11    <loader>C</loader> 
     12    <image>check_test.so</image> 
     13    <moduleconfig> 
     14    </moduleconfig> 
     15    <checkconfig /> 
     16    <examples> 
     17        <example> 
     18            <title>Loading the check_test module.</title> 
     19            <para>This example loads the check_test module.</para> 
     20            <programlisting><![CDATA[ 
     21      <noit> 
     22        <modules> 
     23          <generic image="check_test" name="check_test" /> 
     24        </modules> 
     25      </noit> 
     26    ]]></programlisting> 
     27        </example> 
     28    </examples> 
     29    <section> 
     30        <!-- Should this be moved to the wire protocol?  And then linked from here? --> 
     31        <title>REST Endpoint</title> 
     32        <section> 
     33            <title>/checks/test</title> 
     34            <variablelist> 
     35                <varlistentry> 
     36                    <term>method</term> 
     37                    <listitem><code>POST</code></listitem> 
     38                </varlistentry> 
     39                <varlistentry> 
     40                    <term>uri</term> 
     41                    <listitem><code>/checks/test</code></listitem> 
     42                </varlistentry> 
     43            </variablelist> 
     44            <para> 
     45                This call accepts a document describing a check.  In the same request, the check will   
     46                execute and return the results back to the user.  The check passes through the same validation 
     47                as the /check/set PUT REST call.  The check is marked as transient and won't appear  
     48                in any persistent log streams. 
     49            </para> 
     50            <para> 
     51                On success, a HTTP 200 is returned and an XML documented that matches the 
     52                format of the <code>/check/show</code> REST command. It is a simpler set of 
     53                output as some of the results wouldn't make sense in this context. 
     54            </para> 
     55            <example> 
     56                <title>REST /checks/test XML input.</title> 
     57                <programlisting><![CDATA[ 
     58<?xml version="1.0" encoding="utf8"?> 
     59<check> 
     60  <attributes> 
     61    <name>http</name> 
     62    <module>http</module> 
     63    <target>8.8.38.5</target> 
     64    <period>60000</period> 
     65    <timeout>5000</timeout> 
     66    <filterset>default</filterset> 
     67  </attributes> 
     68  <config> 
     69    <code>200</code> 
     70    <url>https://labs.omniti.com/</url> 
     71  </config> 
     72</check> 
     73    ]]></programlisting> 
     74            </example> 
     75        </section> 
     76    </section> 
     77</module>