|
|
@ -15,20 +15,20 @@ If the request body looks like a UTF-8 string, SITE_NAME stores the request body |
|
|
|
<p>Successful responses will have the "200 OK" HTTP response status code and a short |
|
|
|
and simple string "OK" in the response body.</p> |
|
|
|
<h2>Signal Success ("ping")</h2> |
|
|
|
<div class="highlight"><pre><span></span>HEAD|GET|POST PING_ENDPOINT{uuid} |
|
|
|
</pre></div> |
|
|
|
<div class="highlight"><pre><span></span><code>HEAD|GET|POST PING_ENDPOINT{uuid} |
|
|
|
</code></pre></div> |
|
|
|
|
|
|
|
|
|
|
|
<p>Signals to SITE_NAME that the job has completed successfully (or, for |
|
|
|
continuously running processes, is still running and healthy). The <code>uuid</code> parameter |
|
|
|
is unique for each check.</p> |
|
|
|
<p><strong>Example</strong></p> |
|
|
|
<div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.0</span> |
|
|
|
<div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.0</span> |
|
|
|
<span class="na">Host</span><span class="o">:</span> <span class="l">hc-ping.com</span> |
|
|
|
</pre></div> |
|
|
|
</code></pre></div> |
|
|
|
|
|
|
|
|
|
|
|
<div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> |
|
|
|
<div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> |
|
|
|
<span class="na">Server</span><span class="o">:</span> <span class="l">nginx</span> |
|
|
|
<span class="na">Date</span><span class="o">:</span> <span class="l">Wed, 29 Jan 2020 09:58:23 GMT</span> |
|
|
|
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">text/plain; charset=utf-8</span> |
|
|
@ -37,23 +37,23 @@ is unique for each check.</p> |
|
|
|
<span class="na">Access-Control-Allow-Origin</span><span class="o">:</span> <span class="l">*</span> |
|
|
|
|
|
|
|
OK |
|
|
|
</pre></div> |
|
|
|
</code></pre></div> |
|
|
|
|
|
|
|
|
|
|
|
<h2>Signal Failure</h2> |
|
|
|
<div class="highlight"><pre><span></span>HEAD|GET|POST PING_ENDPOINT{uuid}/fail |
|
|
|
</pre></div> |
|
|
|
<div class="highlight"><pre><span></span><code>HEAD|GET|POST PING_ENDPOINT{uuid}/fail |
|
|
|
</code></pre></div> |
|
|
|
|
|
|
|
|
|
|
|
<p>Signals to SITE_NAME that the job has failed. Actively signalling a failure |
|
|
|
minimizes the delay from your monitored service failing to you receiving an alert.</p> |
|
|
|
<p><strong>Example</strong></p> |
|
|
|
<div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278/fail</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.0</span> |
|
|
|
<div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278/fail</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.0</span> |
|
|
|
<span class="na">Host</span><span class="o">:</span> <span class="l">hc-ping.com</span> |
|
|
|
</pre></div> |
|
|
|
</code></pre></div> |
|
|
|
|
|
|
|
|
|
|
|
<div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> |
|
|
|
<div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> |
|
|
|
<span class="na">Server</span><span class="o">:</span> <span class="l">nginx</span> |
|
|
|
<span class="na">Date</span><span class="o">:</span> <span class="l">Wed, 29 Jan 2020 09:58:23 GMT</span> |
|
|
|
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">text/plain; charset=utf-8</span> |
|
|
@ -62,12 +62,12 @@ minimizes the delay from your monitored service failing to you receiving an aler |
|
|
|
<span class="na">Access-Control-Allow-Origin</span><span class="o">:</span> <span class="l">*</span> |
|
|
|
|
|
|
|
OK |
|
|
|
</pre></div> |
|
|
|
</code></pre></div> |
|
|
|
|
|
|
|
|
|
|
|
<h2>Signal a Start</h2> |
|
|
|
<div class="highlight"><pre><span></span>HEAD|GET|POST PING_ENDPOINT{uuid}/start |
|
|
|
</pre></div> |
|
|
|
<div class="highlight"><pre><span></span><code>HEAD|GET|POST PING_ENDPOINT{uuid}/start |
|
|
|
</code></pre></div> |
|
|
|
|
|
|
|
|
|
|
|
<p>Sends a "job has started!" message to SITE_NAME. This is |
|
|
@ -77,12 +77,12 @@ optional but enables a few extra features:</p> |
|
|
|
<li>SITE_NAME will detect if the job runs longer than its configured grace time</li> |
|
|
|
</ul> |
|
|
|
<p><strong>Example</strong></p> |
|
|
|
<div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278/start</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.0</span> |
|
|
|
<div class="highlight"><pre><span></span><code><span class="nf">GET</span> <span class="nn">/5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278/start</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.0</span> |
|
|
|
<span class="na">Host</span><span class="o">:</span> <span class="l">hc-ping.com</span> |
|
|
|
</pre></div> |
|
|
|
</code></pre></div> |
|
|
|
|
|
|
|
|
|
|
|
<div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> |
|
|
|
<div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span> |
|
|
|
<span class="na">Server</span><span class="o">:</span> <span class="l">nginx</span> |
|
|
|
<span class="na">Date</span><span class="o">:</span> <span class="l">Wed, 29 Jan 2020 09:58:23 GMT</span> |
|
|
|
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">text/plain; charset=utf-8</span> |
|
|
@ -91,4 +91,4 @@ optional but enables a few extra features:</p> |
|
|
|
<span class="na">Access-Control-Allow-Origin</span><span class="o">:</span> <span class="l">*</span> |
|
|
|
|
|
|
|
OK |
|
|
|
</pre></div> |
|
|
|
</code></pre></div> |