| Server IP : 78.140.185.180 / Your IP : 18.221.79.24 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/public_html/vendor/rackspace/php-opencloud/doc/services/monitoring/ |
Upload File : |
Checks
======
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:
- A name for the check
- The check's parent entity
- The type of check you're creating
- Details of the check
- The monitoring zones that will launch the check
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).
Create a check
--------------
There are various attributes available to you when creating a new monitoring
check:
.. code-block:: php
$params = array(
'type' => 'remote.http',
'details' => array(
'url' => 'http://example.com',
'method' => 'GET'
),
'monitoring_zones_poll' => array('mzlon'),
'period' => '100',
'timeout' => '30',
'target_alias' => 'default',
'label' => 'Website check 1'
);
For a full list of available attributes, consult the list below.
Attributes
~~~~~~~~~~
+------------+-------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------+
| Name | Description | Required? | Data type |
+============+=============================================================================================================+=============+==========================================+
| type | The type of check. | Required | Valid check type. String (1..25 chars) |
+------------+-------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------+
| details | Details specific to the check type. | Optional | Array |
+------------+-------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------+
| disabled | Disables the check. | Optional | Boolean |
+------------+-------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------+
| label | A friendly label for a check. | Optional | String (1..255 chars) |
+------------+-------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------+
| metadata | Arbitrary key/value pairs. | Optional | Array |
+------------+-------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------+
| period | The period in seconds for a check. The value must be greater than the minimum period set on your account. | Optional | Integer (30..1800) |
+------------+-------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------+
| timeout | The timeout in seconds for a check. This has to be less than the period. | Optional | Integer (2..1800) |
+------------+-------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------+
Optional attributes to be used with remote checks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------+
| Name | Description | Required? | Data type |
+===========================+========================================================================================================================================================+=============+============================================================+
| monitoring_zones_poll | List of monitoring zones to poll from. Note: This argument is only required for remote (non-agent) checks | Optional | Array |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------+
| target_alias | A key in the entity's ``ip_addresses`` hash used to resolve this check to an IP address. This parameter is mutually exclusive with target\_hostname. | Optional | String (1..64 chars) |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------+
| target_hostname | The hostname this check should target. This parameter is mutually exclusive with ``target_alias``. | Optional | Valid FQDN, IPv4 or IPv6 address. String (1..256 chars). |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------+
| target_resolver | Determines how to resolve the check target. | Optional | ``IPv4`` or ``IPv6`` |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------+
Test parameters
---------------
Sometimes it can be useful to test out the parameters before sending them as a
create call. To do this, pass in the ``$params`` like so:
.. code-block:: php
$response = $entity->testNewCheckParams($params);
echo $response->timestamp; // When was it executed?
echo $response->available; // Was it available?
echo $response->status; // Status code
Send parameters
~~~~~~~~~~~~~~~
Once you are satisfied with your configuration parameters, you can complete the
operation and send it to the API like so:
.. code-block:: php
$entity->createCheck($params);
Test existing Check
-------------------
.. code-block:: php
// Set arg to TRUE for debug information
$response = $check->test(true);
echo $response->debug_info;
List Checks
-----------
.. code-block:: php
$checks = $entity->getChecks();
foreach ($checks as $check) {
echo $check->getId();
}
Update Check
------------
.. code-block:: php
$check->update(array('period' => 500));
Delete check
------------
.. code-block:: php
$check->delete();
Check types
===========
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. **Note:** Users cannot create, update or delete
check types.
Check types for commonly encountered web protocols, such as HTTP
(``remote.http``), IMAP (``remote.imap-banner``) , SMTP
(``remote.stmp``), and DNS (``remote.dns``) are provided. Monitoring
commonly encountered infrastructure servers like MySQL
(``remote.mysql-banner``) and PostgreSQL (``remote.postgresql-banner``)
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.
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
`official API
documentation <http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/appendix-check-types.html>`__.
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.
Find an existing check's type
-----------------------------
If you want to see the type for an existing Check resource:
.. code-block:: php
/** @var \OpenCloud\CloudMonitoring\Resource\CheckType */
$checkType = $check->getCheckType();
List all possible check types
-----------------------------
.. code-block:: php
$checkTypes = $service->getCheckTypes();
foreach ($checkTypes as $checkType) {
echo $checkType->getId();
}
Retrieve details about a Type by its ID
---------------------------------------
Alternatively, you can retrieve a specific type based on its ID:
.. code-block:: php
$checkTypeId = 'remote.dns';
$checkType = $service->getCheckType($checkTypeId);
Attributes
----------
Once you have access to a ``OpenCloud\CloudMonitoring\Resource\CheckType`` object,
you can query these attributes:
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+-------------------------------+
| Name | Description | Data type | Method |
+========================+==========================================================================================================================================================================================+=============+===============================+
| type | The name of the supported check type. | String | ``getType()`` |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+-------------------------------+
| fields | Check type fields. | Array | ``getFields()`` |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+-------------------------------+
| supported_platforms | 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 | Array | ``getSupportedPlatforms()`` |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+-------------------------------+