| Server IP : 78.140.185.180 / Your IP : 216.73.216.45 Web Server : LiteSpeed System : Linux cpanel13.v.fozzy.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : builderbox ( 1072) PHP Version : 7.3.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/builderbox/www/vendor/rackspace/php-opencloud/doc/_build/html/services/monitoring/ |
Upload File : |
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Checks — php-opencloud 1.12.1 documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="top" title="php-opencloud 1.12.1 documentation" href="../../index.html"/>
<link rel="up" title="Monitoring v1" href="index.html"/>
<link rel="next" title="Alarms" href="alarms.html"/>
<link rel="prev" title=" Entities" href="entities.html"/>
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../../index.html" class="fa fa-home"> php-opencloud</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../autoscale/index.html">Auto Scale v2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../compute/index.html">Compute v2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../compute/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../compute/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../compute/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../compute/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Databases v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../database/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dns/index.html">DNS v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../dns/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dns/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dns/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dns/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../identity/index.html">Identity v2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../identity/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../identity/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../identity/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../identity/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../image/index.html">Images v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../image/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../image/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../image/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../image/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../load-balancer/index.html">Load Balancer v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Monitoring v1</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="index.html#setup">Setup</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../networking/index.html">Networking v2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../networking/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../networking/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../networking/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../networking/index.html#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../object-store/index.html">Object Store v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orchestration/index.html">Orchestration v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../queues/index.html">Queues v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../queues/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../queues/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../queues/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../queues/index.html#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../volume/index.html">Volumes v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../volume/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../volume/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../volume/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../volume/index.html#further-links">Further links</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../debugging.html">Debugging</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../debugging.html#strategy-1-meaningful-exception-handling">Strategy 1: Meaningful exception handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../debugging.html#strategy-2-wire-logging">Strategy 2: Wire logging</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../caching-creds.html">Caching credentials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../caching-creds.html#filesystem-example">Filesystem example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../iterators.html">Iterators</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../iterators.html#common-behaviour">Common behaviour</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../iterators.html#very-important-note">Very important note</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../iterators.html#using-paginated-collections">Using paginated collections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../iterators.html#setting-up-a-paginatediterator">Setting up a PaginatedIterator</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../regions.html">Rackspace regions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../url-types.html">URL types</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../url-types.html#internalurl">internalURL</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../url-types.html#publicurl">publicURL</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../logging.html">Logging</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../logging.html#logger-injection">Logger injection</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../http-clients.html">HTTP Clients</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#default-http-headers">Default HTTP headers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#user-agents">User agents</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#other-functionality">Other functionality</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../auth.html">Authentication</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../auth.html#service-catalog">Service Catalog</a></li>
</ul>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">php-opencloud</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li><a href="index.html">Monitoring v1</a> »</li>
<li>Checks</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/services/monitoring/checks.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section" id="checks">
<h1>Checks<a class="headerlink" href="#checks" title="Permalink to this headline">¶</a></h1>
<p>A check is one of the foundational building blocks of the monitoring
system. The check determines the parts or pieces of the entity that you
want to monitor, the monitoring frequency, how many monitoring zones are
originating the check, and so on. When you create a new check in the
monitoring system, you specify the following information:</p>
<ul class="simple">
<li>A name for the check</li>
<li>The check’s parent entity</li>
<li>The type of check you’re creating</li>
<li>Details of the check</li>
<li>The monitoring zones that will launch the check</li>
</ul>
<p>The check, as created, will not trigger alert messages until you create
an alarm to generate notifications, to enable the creation of a single
alarm that acts upon multiple checks (e.g. alert if any of ten different
servers stops responding) or multiple alarms off of a single check.
(e.g. ensure both that a HTTPS server is responding and that it has a
valid certificate).</p>
<div class="section" id="create-a-check">
<h2>Create a check<a class="headerlink" href="#create-a-check" title="Permalink to this headline">¶</a></h2>
<p>There are various attributes available to you when creating a new monitoring
check:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$params</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'remote.http'</span><span class="p">,</span>
<span class="s1">'details'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'url'</span> <span class="o">=></span> <span class="s1">'http://example.com'</span><span class="p">,</span>
<span class="s1">'method'</span> <span class="o">=></span> <span class="s1">'GET'</span>
<span class="p">),</span>
<span class="s1">'monitoring_zones_poll'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span><span class="s1">'mzlon'</span><span class="p">),</span>
<span class="s1">'period'</span> <span class="o">=></span> <span class="s1">'100'</span><span class="p">,</span>
<span class="s1">'timeout'</span> <span class="o">=></span> <span class="s1">'30'</span><span class="p">,</span>
<span class="s1">'target_alias'</span> <span class="o">=></span> <span class="s1">'default'</span><span class="p">,</span>
<span class="s1">'label'</span> <span class="o">=></span> <span class="s1">'Website check 1'</span>
<span class="p">);</span>
</pre></div>
</div>
<p>For a full list of available attributes, consult the list below.</p>
<div class="section" id="attributes">
<h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this headline">¶</a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="7%" />
<col width="62%" />
<col width="7%" />
<col width="24%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
<th class="head">Required?</th>
<th class="head">Data type</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>type</td>
<td>The type of check.</td>
<td>Required</td>
<td>Valid check type. String (1..25 chars)</td>
</tr>
<tr class="row-odd"><td>details</td>
<td>Details specific to the check type.</td>
<td>Optional</td>
<td>Array</td>
</tr>
<tr class="row-even"><td>disabled</td>
<td>Disables the check.</td>
<td>Optional</td>
<td>Boolean</td>
</tr>
<tr class="row-odd"><td>label</td>
<td>A friendly label for a check.</td>
<td>Optional</td>
<td>String (1..255 chars)</td>
</tr>
<tr class="row-even"><td>metadata</td>
<td>Arbitrary key/value pairs.</td>
<td>Optional</td>
<td>Array</td>
</tr>
<tr class="row-odd"><td>period</td>
<td>The period in seconds for a check. The value must be greater than the minimum period set on your account.</td>
<td>Optional</td>
<td>Integer (30..1800)</td>
</tr>
<tr class="row-even"><td>timeout</td>
<td>The timeout in seconds for a check. This has to be less than the period.</td>
<td>Optional</td>
<td>Integer (2..1800)</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="optional-attributes-to-be-used-with-remote-checks">
<h3>Optional attributes to be used with remote checks<a class="headerlink" href="#optional-attributes-to-be-used-with-remote-checks" title="Permalink to this headline">¶</a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="11%" />
<col width="60%" />
<col width="5%" />
<col width="24%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
<th class="head">Required?</th>
<th class="head">Data type</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>monitoring_zones_poll</td>
<td>List of monitoring zones to poll from. Note: This argument is only required for remote (non-agent) checks</td>
<td>Optional</td>
<td>Array</td>
</tr>
<tr class="row-odd"><td>target_alias</td>
<td>A key in the entity’s <tt class="docutils literal"><span class="pre">ip_addresses</span></tt> hash used to resolve this check to an IP address. This parameter is mutually exclusive with target_hostname.</td>
<td>Optional</td>
<td>String (1..64 chars)</td>
</tr>
<tr class="row-even"><td>target_hostname</td>
<td>The hostname this check should target. This parameter is mutually exclusive with <tt class="docutils literal"><span class="pre">target_alias</span></tt>.</td>
<td>Optional</td>
<td>Valid FQDN, IPv4 or IPv6 address. String (1..256 chars).</td>
</tr>
<tr class="row-odd"><td>target_resolver</td>
<td>Determines how to resolve the check target.</td>
<td>Optional</td>
<td><tt class="docutils literal"><span class="pre">IPv4</span></tt> or <tt class="docutils literal"><span class="pre">IPv6</span></tt></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="test-parameters">
<h2>Test parameters<a class="headerlink" href="#test-parameters" title="Permalink to this headline">¶</a></h2>
<p>Sometimes it can be useful to test out the parameters before sending them as a
create call. To do this, pass in the <tt class="docutils literal"><span class="pre">$params</span></tt> like so:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$response</span> <span class="o">=</span> <span class="nv">$entity</span><span class="o">-></span><span class="na">testNewCheckParams</span><span class="p">(</span><span class="nv">$params</span><span class="p">);</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="o">-></span><span class="na">timestamp</span><span class="p">;</span> <span class="c1">// When was it executed?</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="o">-></span><span class="na">available</span><span class="p">;</span> <span class="c1">// Was it available?</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="o">-></span><span class="na">status</span><span class="p">;</span> <span class="c1">// Status code</span>
</pre></div>
</div>
<div class="section" id="send-parameters">
<h3>Send parameters<a class="headerlink" href="#send-parameters" title="Permalink to this headline">¶</a></h3>
<p>Once you are satisfied with your configuration parameters, you can complete the
operation and send it to the API like so:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$entity</span><span class="o">-></span><span class="na">createCheck</span><span class="p">(</span><span class="nv">$params</span><span class="p">);</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="test-existing-check">
<h2>Test existing Check<a class="headerlink" href="#test-existing-check" title="Permalink to this headline">¶</a></h2>
<div class="highlight-php"><div class="highlight"><pre><span class="c1">// Set arg to TRUE for debug information</span>
<span class="nv">$response</span> <span class="o">=</span> <span class="nv">$check</span><span class="o">-></span><span class="na">test</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
<span class="k">echo</span> <span class="nv">$response</span><span class="o">-></span><span class="na">debug_info</span><span class="p">;</span>
</pre></div>
</div>
</div>
<div class="section" id="list-checks">
<h2>List Checks<a class="headerlink" href="#list-checks" title="Permalink to this headline">¶</a></h2>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$checks</span> <span class="o">=</span> <span class="nv">$entity</span><span class="o">-></span><span class="na">getChecks</span><span class="p">();</span>
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$checks</span> <span class="k">as</span> <span class="nv">$check</span><span class="p">)</span> <span class="p">{</span>
<span class="k">echo</span> <span class="nv">$check</span><span class="o">-></span><span class="na">getId</span><span class="p">();</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="update-check">
<h2>Update Check<a class="headerlink" href="#update-check" title="Permalink to this headline">¶</a></h2>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$check</span><span class="o">-></span><span class="na">update</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="s1">'period'</span> <span class="o">=></span> <span class="mi">500</span><span class="p">));</span>
</pre></div>
</div>
</div>
<div class="section" id="delete-check">
<h2>Delete check<a class="headerlink" href="#delete-check" title="Permalink to this headline">¶</a></h2>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$check</span><span class="o">-></span><span class="na">delete</span><span class="p">();</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="check-types">
<h1>Check types<a class="headerlink" href="#check-types" title="Permalink to this headline">¶</a></h1>
<p>Each check within the Rackspace Cloud Monitoring has a designated check
type. The check type instructs the monitoring system how to check the
monitored resource. <strong>Note:</strong> Users cannot create, update or delete
check types.</p>
<p>Check types for commonly encountered web protocols, such as HTTP
(<tt class="docutils literal"><span class="pre">remote.http</span></tt>), IMAP (<tt class="docutils literal"><span class="pre">remote.imap-banner</span></tt>) , SMTP
(<tt class="docutils literal"><span class="pre">remote.stmp</span></tt>), and DNS (<tt class="docutils literal"><span class="pre">remote.dns</span></tt>) are provided. Monitoring
commonly encountered infrastructure servers like MySQL
(<tt class="docutils literal"><span class="pre">remote.mysql-banner</span></tt>) and PostgreSQL (<tt class="docutils literal"><span class="pre">remote.postgresql-banner</span></tt>)
are also available. Monitoring custom server uptime can be accomplished
with the remote.tcp banner check to check for a protocol-defined banner
at the beginning of a connection. Gathering metrics from server software
to create alerts against can be accomplished using the remote.http check
type and the ‘extract’ attribute to define the format.</p>
<p>In addition to the standard Cloud Monitoring check types, you can also
use agent check types if the Monitoring Agent is installed on the server
you are monitoring. For a list of available check types, see the
<a class="reference external" href="http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/appendix-check-types.html">official API
documentation</a>.</p>
<p>Checks generate metrics that alarms will alert based upon. The metrics
generated often times depend on the check’s parameters. For example,
using the ‘extract’ attribute on the remote.http check, however the
default metrics will always be present. To determine the exact metrics
available, the Test Check API is provided.</p>
<div class="section" id="find-an-existing-check-s-type">
<h2>Find an existing check’s type<a class="headerlink" href="#find-an-existing-check-s-type" title="Permalink to this headline">¶</a></h2>
<p>If you want to see the type for an existing Check resource:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="sd">/** @var \OpenCloud\CloudMonitoring\Resource\CheckType */</span>
<span class="nv">$checkType</span> <span class="o">=</span> <span class="nv">$check</span><span class="o">-></span><span class="na">getCheckType</span><span class="p">();</span>
</pre></div>
</div>
</div>
<div class="section" id="list-all-possible-check-types">
<h2>List all possible check types<a class="headerlink" href="#list-all-possible-check-types" title="Permalink to this headline">¶</a></h2>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$checkTypes</span> <span class="o">=</span> <span class="nv">$service</span><span class="o">-></span><span class="na">getCheckTypes</span><span class="p">();</span>
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$checkTypes</span> <span class="k">as</span> <span class="nv">$checkType</span><span class="p">)</span> <span class="p">{</span>
<span class="k">echo</span> <span class="nv">$checkType</span><span class="o">-></span><span class="na">getId</span><span class="p">();</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="retrieve-details-about-a-type-by-its-id">
<h2>Retrieve details about a Type by its ID<a class="headerlink" href="#retrieve-details-about-a-type-by-its-id" title="Permalink to this headline">¶</a></h2>
<p>Alternatively, you can retrieve a specific type based on its ID:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$checkTypeId</span> <span class="o">=</span> <span class="s1">'remote.dns'</span><span class="p">;</span>
<span class="nv">$checkType</span> <span class="o">=</span> <span class="nv">$service</span><span class="o">-></span><span class="na">getCheckType</span><span class="p">(</span><span class="nv">$checkTypeId</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id1">
<h2>Attributes<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>Once you have access to a <tt class="docutils literal"><span class="pre">OpenCloud\CloudMonitoring\Resource\CheckType</span></tt> object,
you can query these attributes:</p>
<table border="1" class="docutils">
<colgroup>
<col width="9%" />
<col width="73%" />
<col width="5%" />
<col width="12%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
<th class="head">Data type</th>
<th class="head">Method</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>type</td>
<td>The name of the supported check type.</td>
<td>String</td>
<td><tt class="docutils literal"><span class="pre">getType()</span></tt></td>
</tr>
<tr class="row-odd"><td>fields</td>
<td>Check type fields.</td>
<td>Array</td>
<td><tt class="docutils literal"><span class="pre">getFields()</span></tt></td>
</tr>
<tr class="row-even"><td>supported_platforms</td>
<td>Platforms on which an agent check type is supported. This is advisory information only - the check may still work on other platforms, or report that check execution failed at runtime</td>
<td>Array</td>
<td><tt class="docutils literal"><span class="pre">getSupportedPlatforms()</span></tt></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="alarms.html" class="btn btn-neutral float-right" title="Alarms"/>Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="entities.html" class="btn btn-neutral" title=" Entities"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015, Jamie Hannaford, Shaunak Kashyap.
</p>
</div>
<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'1.12.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>