Use collectd plugin for custom metrics

Abiquo supports collectd with an integration in the multi-cloud platform to enable you to easily work with custom VM monitoring and metrics in public cloud providers, including Amazon, Azure, and Google Cloud, as well as VMware vCenter.

In the Abiquo multi-cloud platform you can create alerts (see Manage alerts) and automation (see Manage action plans ) based on your custom metrics. For example, you can automatically scale out your VMs based on your application metrics. See Manage scaling groups

After you configure collectd and the Abiquo collectd plugin, the plugin will automatically push the values from collectd to the Abiquo API (see https://wiki.abiquo.com/api/latest/) using the Abiquo API endpoints for collectd. For example, for a VM, or a group of VMs in a virtual appliance, or for a scaling group.
The Abiquo API then pushes the collectd metrics to the Configure VM monitoring and metrics . Users can then display metrics through the UI or use them for automation.

How to install and configure collected for VMs in Abiquo

The following steps are a general guide:

1. In Abiquo, create an OAuth application in Abiquo for collectd. See Add an application for OAuth  

   1. Assign the privilege to  Allow user to push own metrics

2. Install collectd on your VM

3. Install the Abiquo collectd plugin from source (or using automation an automation similar to the example shown in the Abiquo Chef cookbook).

   1. Configure the Abiquo API path to push the metrics to the VM in Abiquo. Check the correct format of the API path in the Abiquo API documentation

4. Configure your metrics in collectd

The Abiquo collectd plugin will automatically push all collectd metrics to the Abiquo API in PUTVAL JSON format.

To display the VM metrics in Abiquo:

1. Edit your VM and go to Monitoring

2. Select Fetch metrics data. 

3. Optionally select the monitoring level on providers that support it, e.g. AWS 

4. Select the metrics to display from the custom metrics and the built-in metrics of the cloud provider or hypervisor
   

   

5. Save your changes to the VM. Optionally, define a scaling group to increase the number of VMs running your application automatic scaling actions. See Manage scaling groups 

6. If your VM is not running, deploy to launch the VM. Wait several minutes for the server to return metrics

7. On the VM icon near the top right corner, click the metrics symbol.
   Or in the Virtual appliance, go to Monitoring → Virtual machines 

   

8. Configure the metrics to display the required statistic, frequency, dimensions, and so on.

   

   The platform will display the configured metrics.

   

9. Create alarms to set metric thresholds and alerts on groups of alarms, to notify or respond to changing application conditions with automation using action plans. See Cloud VM automation guide

Automate the install of collectd using Chef

This is an example use case with Chef using the Abiquo Chef cookbook.

1. In Abiquo, the administrator creates an OAuth application in Abiquo for collectd. See Add an application for OAuth 

   1. Assign the privilege to  “Allow user to push own metrics”

2. On the Chef server, the administrator creates a role with the following:

   1. The monitoring recipes to install the Abiquo collectd plugin

   2. The OAuth tokens for the application configured

3. In Abiquo, users edit the VM and go to Chef, then select the appropriate collectd role.

Abiquo recommends this kind of automation because the OAuth application belongs to the tenant administrator. This means that the administrator prepares the configuration for users, it is easy to apply it automatically on a large scale, and the administrator can protect the configuration from accidental changes when users load their own Chef recipes, etc.

Related links

• Collectd website: http://collectd.org/

• Abiquo-collectd plugin: https://github.com/abiquo/collectd-abiquo

• Abiquo Chef cookbook for the collectd plugin: https://github.com/abiquo/collectd-abiquo-cookbook

• Abiquo API documentation of VM resource: VirtualMachinesResource

• Push collected data to a VM: https://wiki.abiquo.com/api/latest/VirtualMachinesResource.html#push-collectd-values-on-a-virtual-machine

• Example collectd metrics push: POST_cld_vdcs_X_vapps_X_vms_X_collectd_CT_app_j

• API how to for working with metrics: How to enable VM monitoring and metrics via API

Example collectd data object

Here is an example of a data entity to update a virtual machine with the collectd metrics specification.

[
  {
    "datasourceNames": [
      "933cc3bb-ce9b-4529-8854-c2e0b3db8f15", 
      "e62ded09-cb81-4f84-b952-0e1670caafb4"
    ], 
    "datasourcetypes": [
      "ABSOLUTE", 
      "GAUGE"
    ], 
    "dsnames": [
      "933cc3bb-ce9b-4529-8854-c2e0b3db8f15", 
      "e62ded09-cb81-4f84-b952-0e1670caafb4"
    ], 
    "host": "0d5be059-3489-40b2-8ca9-2eb06ac380ee", 
    "long_time": 1479997080, 
    "plugin_instance": "4877672f-1e7d-4aba-9fea-e27f04edb0ba", 
    "pluginInstance": "4877672f-1e7d-4aba-9fea-e27f04edb0ba", 
    "dstypes": [
      "ABSOLUTE", 
      "GAUGE"
    ], 
    "plugin": "454dbbf3-1b8d-48e6-873b-013186aab177", 
    "interval": 10, 
    "typeInstance": "e105b17d-c6ba-4ba3-a767-79fc7de1abc9", 
    "length": 2, 
    "long_interval": 10, 
    "values": [
      "10373115", 
      "12863138"
    ], 
    "time": 1479997080, 
    "type_instance": "e105b17d-c6ba-4ba3-a767-79fc7de1abc9", 
    "type": "5c707508-a1f2-4318-aa35-3f91b74378c3"
  }, 
  {
    "datasourceNames": [
      "71d83476-7906-47d9-a053-f7cf2080f809"
    ], 
    "datasourcetypes": [
      "ABSOLUTE"
    ], 
    "dsnames": [
      "71d83476-7906-47d9-a053-f7cf2080f809"
    ], 
    "host": "78c620c2-8b48-405c-b2b0-39d22527b9ef", 
    "long_time": 1479997080, 
    "plugin_instance": "c8d66a06-bf36-4f8d-ae4d-3c1dc9868662", 
    "pluginInstance": "c8d66a06-bf36-4f8d-ae4d-3c1dc9868662", 
    "dstypes": [
      "ABSOLUTE"
    ], 
    "plugin": "e4d3ba5b-e322-4e18-8856-29f3db6240f5", 
    "interval": 10, 
    "typeInstance": "6d90f553-100a-4137-816b-695663cbc621", 
    "length": 1, 
    "long_interval": 10, 
    "values": [
      "1857444"
    ], 
    "time": 1479997080, 
    "type_instance": "6d90f553-100a-4137-816b-695663cbc621", 
    "type": "e9553cea-9930-40aa-a89d-96d937ea50e0"
  }, 
  {
    "datasourceNames": [
      "d1d67266-b3e8-489b-bd8d-9cfc2bc22322"
    ], 
    "datasourcetypes": [
      "ABSOLUTE"
    ], 
    "dsnames": [
      "d1d67266-b3e8-489b-bd8d-9cfc2bc22322"
    ], 
    "host": "dafdcd40-1ad9-4fa1-ab89-6821ec3dc7b5", 
    "long_time": 1479997080, 
    "plugin_instance": "9c63a050-c6f2-461f-8380-a6ec96c476b7", 
    "pluginInstance": "9c63a050-c6f2-461f-8380-a6ec96c476b7", 
    "dstypes": [
      "ABSOLUTE"
    ], 
    "plugin": "946f66fb-c230-4ded-a2ac-4f130520d5c8", 
    "interval": 10, 
    "typeInstance": "befc79ea-49ba-4bf1-bff5-fe7f04bacb65", 
    "length": 1, 
    "long_interval": 10, 
    "values": [
      "5177812"
    ], 
    "time": 1479997080, 
    "type_instance": "befc79ea-49ba-4bf1-bff5-fe7f04bacb65", 
    "type": "9ad979ed-3cc1-4339-8e76-59f6c1adf073"
  }, 
  {
    "datasourceNames": [
      "f28d1829-d3de-4f50-b604-33b79422645c"
    ], 
    "datasourcetypes": [
      "COUNTER"
    ], 
    "dsnames": [
      "f28d1829-d3de-4f50-b604-33b79422645c"
    ], 
    "host": "0d835519-bdc6-4b52-8ccd-0970f2ac252b", 
    "long_time": 1479997080, 
    "plugin_instance": "0b84221f-f282-4662-9f3c-198d9facbb51", 
    "pluginInstance": "0b84221f-f282-4662-9f3c-198d9facbb51", 
    "dstypes": [
      "COUNTER"
    ], 
    "plugin": "bcd3327c-2c00-4651-9ad7-51caccadd6f7", 
    "interval": 10, 
    "typeInstance": "1882cdaf-d99d-4494-b7a4-527d0e6e3c98", 
    "length": 1, 
    "long_interval": 10, 
    "values": [
      "3023252"
    ], 
    "time": 1479997080, 
    "type_instance": "1882cdaf-d99d-4494-b7a4-527d0e6e3c98", 
    "type": "5f25fa66-8484-4e98-8169-edf2d6cf22f9"
  }, 
  {
    "datasourceNames": [
      "e786a610-7c90-451a-9955-078e90071969"
    ], 
    "datasourcetypes": [
      "DERIVE"
    ], 
    "dsnames": [
      "e786a610-7c90-451a-9955-078e90071969"
    ], 
    "host": "7af8662b-33a3-4cb0-afed-f68340d43b62", 
    "long_time": 1479997080, 
    "plugin_instance": "4b3e9685-7e7d-4f6f-8256-6a22f8e3308c", 
    "pluginInstance": "4b3e9685-7e7d-4f6f-8256-6a22f8e3308c", 
    "dstypes": [
      "DERIVE"
    ], 
    "plugin": "1023cd92-7f4b-4462-ad8a-305312aa9e94", 
    "interval": 10, 
    "typeInstance": "803f1271-7cac-426f-9951-33379c49bba8", 
    "length": 1, 
    "long_interval": 10, 
    "values": [
      "9775473"
    ], 
    "time": 1479997080, 
    "type_instance": "803f1271-7cac-426f-9951-33379c49bba8", 
    "type": "30529502-f812-4386-8d7b-9076ccf72d5b"
  }
]

Custom metrics entities

Abiquo enables you to easily manage custom metrics for many platform resources, including:

• Public cloud region (from cloud/locations and admin/publiccloudregions)

• Datacenter (from cloud/locations and admin/datacenters)

• Machine

• Rack

• Virtual appliance

• Scaling group

  • Virtual machines

• Virtual machine

• Services

Custom metrics display in the UI

The Abiquo UI enables users to display custom metrics for the following entities:

• Virtual appliance

• Scaling group

• Virtual machine

Display custom metrics for a virtual appliance

Abiquo can display custom metrics for your virtual appliance and metrics for the group of VMs in the virtual appliance.

To display custom metrics for the virtual appliance:

• On a Virtual appliance card, click the Monitoring button OR

• Open a Virtual appliance and go to Monitoring tab → Virtual appliance metrics page.

To configure the display of metrics:

• For the refresh interval, select the Refresh data every checkbox and enter a number of minutes. 

• To filter metric statistics, click on the Filter button and select the granularity, statistic, time frame, and dimension, as required.