To display metrics of a deployed VM with metrics enabled, click the Metrics symbol on the VM icon.

To refresh metrics data, click the circular arrows refresh button on the right.

To toggle the display of metrics, click Available metrics on the right, and select the desired metrics.

To filter metrics, click the funnel symbol. Enter the Granularity, Statistics, Period, and/or Dimensions.

To configure the display of metrics at the virtual appliance level, do these steps.

1. Select a Virtual appliance and go to Monitoring
2. Optionally configure the refresh interval. To do this, select the Refresh data every checkbox and enter a number of minutes
3. Choose the metrics you wish to display and filter by metric statistics.

To refresh the display with the latest data from the API, click the round arrow refresh button.

Before you begin:

1. Create your VM with a template that is compatible with cloud-init version 0.7.9 or above, or cloudbase-init, or a similar system
2. In private cloud, the platform will create an ISO disk for Configuration drive

To add a VM bootstrap configuration or script in private or public cloud:

1. Go to create or edit VM → Bootstrap script
2. Paste your configuration or script in the Bootstrap script text box
3. Continue to configure the VM or click Save to finish

Before you deploy a VM, you can set guest variables to pass user data to your VM. This functionality uses cloud-init and requires appropriate templates. In private cloud, the templates must have the guest setup flag set to cloud init. The administrator can add default variables for the VM template.

To add VM variables:

1. Go to Virtual datacenters → edit a VM that is not deployed → Variables

2. Enter each Key and Value

   1. The length of these can be up to 255 characters each 

3. Click Add

   
   

4. To delete a variable click the trash can symbol beside the Key. To edit the Value of a variable, click the pencil edit button beside the Value

5. To apply changes to variables, and other changes to the VM, click Save

Introduction

Abiquo supports collectd with an integration in the multi-cloud platform.

This enables 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 and automation based on your custom metrics. For example, you can automatically scale out your VMs based on your application metrics. 

After you configure collectd and the Abiquo collectd plugin, the plugin will automatically push the values from collectd to the Abiquo API using the Abiquo API endpoints for collectd.

The endpoints may be for a VM, or a group of VMs in a VApp, or for a scaling group.
The Abiquo API then pushes the collectd metrics to the Abiquo Monitoring Server. 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 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 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 Define a scaling group 
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.
   
   
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

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

To configure an automatic response to changing demands for resources, you can scale out VMs or scale them in, which is also called horizontal autoscaling. To scale out, the platform clones the base VM and deploys the clones. To scale in, the platform will delete clone VMs and undeploy the base VM. Scaling operations are subject to all standard platform constraints, such as privileges and allocation limits.

Screenshot: A scaling group with VMs deployed automatically.

• Limitations:
  • Autoscaling does not clone captured VMs, so to use scaling groups with a captured VM, create an instance and recreate the VM. Create instances to save VM disks to templates
  • VApp specs do not support scaling groups. See What do specs save and create

  • Scaling groups have aggregate alarms that are associated with the base VM. This means that you can push custom metrics for clone VMs but you cannot create alarms for cloned VMs that are part of a scaling group. 

• State of base VM: A scaling group with a deployed base VM would be destroyed if the base VM were deleted directly on the hypervisor. In contrast, a scaling group with an undeployed base VM is not vulnerable to interference at the hypervisor level

The platform enables you to automatically scale out (add more VMs) or scale up (add more resources to existing VMs).

To use autoscaling do these steps:

1. Create a base VM, which can be deployed or undeployed
2. Configure the VM and enable metrics
3. Define a scaling group with rules for scaling the VM.
   The checkbox to automatically create a scaling action, will create the following automatically:
   1. Standard alarms and alerts for the selected metrics
   2. Action plans with scaling actions for the VM and triggers for the action plans, which are monitoring alerts
   You can customize the elements the platform creates, or you can create your own configuration.

Related pages:

• Manage Scaling Groups
  
  

Before you begin:

1. Configure the base VM that will be scaled
2. Ensure that you have enough resources in your virtual datacenter to deploy up to the maximum number of cloned VMs, especially IP addresses

To create a scaling group:

1. Go to Virtual datacenters → Virtual appliances
2. On the VM icon, from the options menu, select Define scaling group
3. Enter the scaling parameters and rules
4. Click Save

For more details see GUI Define scaling group

When you save the scaling group, Abiquo will mark the VM icon with the scaling group symbol and display the scaling group name.

• When the scaling group leaves maintenance mode, Abiquo will create clones of the base VM and deploy them to reach the minimum size. 
• The number in the bottom right-hand corner of the icon is the number of running VMs in the scaling group, including the base VM.

To open the scaling group and check its parameters, click the scaling group symbol at the top of the VM icon.

To configure automatic scaling actions:

1. When you define a scaling group, select Create autoscaling action and Save the scaling group
2. In the dialog, select a Metric to control an autoscaling action
   
3. To configure more options, including the thresholds for scaling in and scaling out, click Show more
   
4. To add this action, click Add
5. Add more actions as required 

The platform will automatically create the alarms, alerts, and action plan to automatically scale in or out according to your thresholds.

Before you begin:

1. Create a VM and a scaling group for the VM. See Define a scaling group
   1. If you create an automatic scaling action, then the VM metrics will trigger autoscaling when they cross the thresholds set for the actions

To enable autoscaling operations to run:

1. Create an action plan with a scaling action for the VM with the scaling group. See Create an action plan to automate VM actions
2. Create triggers to run the action plan. See Create a trigger for an action plan

When scaling, the platform will search for a scaling rule that is valid for the specific time range, or for a default rule. It will create or delete/undeploy the number of VMs in the rule, then wait for the cooldown period before accepting another scaling request.

To scale out, the platform does not deploy VMs that are undeployed in the scaling group. To clone the base VM, the platform will do the following:

1. Create disks using the following:
   
   1. Copies of content of disks from the VM template
   2. Empty disks or volumes for each additional disk used in the VM
   3. Disk controllers used in the VM
2. Apply ALL configuration used in the VM, for example:
   
   1. CPU and RAM
   2. Network connections of the same type (e.g. private network)
   3. Assignment of firewall policies and attachment to load balancers
   4. Chef recipes, backups, cloud-init, variables, and so on
   5. Metrics. The group of metrics from clone VMs and the base VM (if it is deployed) can activate alarms in the base VM, even if it is not deployed
   6. Exception – Alarms: the scaling group has only one set of alarms in the base VM

To scale in,  Abiquo currently selects the VMs to delete or undeploy using first in, first out (FIFO). The platform deletes and undeploys VMs without requesting user confirmation when there are disks that are not stored in the Apps library (ISO configuration drive or additional hard disk). 

To make changes to your VMs in a scaling group (manually deploy, undeploy, delete, etc.) and edit the scaling group, put it into maintenance mode, which will disable autoscaling. 

When you leave maintenance mode, the platform will apply your modifications to the scaling group, e.g. adding new rules. Then the platform will adjust the number of VMs in the group to within the minimum and maximum size range.

To put the scaling group in maintenance mode:

1. Go to Virtual datacenters → Virtual appliances → select VM
2. At the bottom of the VM icon, click the cog maintenance symbol at the bottom of the VM icon
   
   OR if the scaling group is open, click the spanner maintenance symbol in the top right corner
   

To leave maintenance mode

1. Click a maintenance button

To automatically manage maintenance mode

1. Trigger action plans with the action "Scaling group: start maintenance mode" or "Scaling group: end maintenance mode".

To delete the base VM, you must delete the scaling group first. 

To display scaling actions of a scaling group:

1. Go to Virtual datacenters → Virtual appliances → open virtual appliance
2. If the scaling group is not in maintenance mode, click the cog maintenance symbol 
3. Edit the scaling group and go to Autoscaling actions
4. To show or hide more details of a scaling action, click Show more or Show less

You can also display all the elements created for the automatic scaling action in the relevant sections of the UI, such as the Alarms tab, and the Control view. 

Abiquo can display custom metrics for your scaling groups and built-in metrics for the VMs in the scaling group.

Scaling groups also have built-in metrics that are a composite of the VM metrics, and which have the same names as the VM metrics. The Abiquo UI does not display the built-in scaling group metrics but you can access them through the Abiquo API. 

To display metrics for a scaling group:

1. On the Scaling group icon, click the Monitoring symbol in the top right-hand corner
   
   OR Open a Scaling group and click the Monitoring symbol 
2. Select the Scaling group or Virtual machines page

You can configure the display of metrics at this level.

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

To manage tags for a scaling group: 

1. Go to Virtual appliances → Virtual machines
2. Select a scaling group and put it into maintenance mode
3. Open and edit the scaling group → Tags
4. Add tags 
   
   For more details see GUI Edit template Tags

To move a scaling group to another virtual appliance in the same virtual datacenter:

1. Put the scaling group in maintenance mode
2. Click the Move button
   
3. Select the new virtual appliance

To move a scaling group to a restricted virtual appliance, do these steps:

1. Click the cog or wrench maintenance symbol to put the scaling group into maintenance mode
2. Click the cross arrows move button
3. Select the checkbox to Move to a restricted virtual appliance, or 
   Select a restricted virtual appliance, or 
   Create a new VApp and select the Restrict virtual appliance checkbox

When you delete a scaling group, the platform will place all the VMs in the virtual appliance as regular VMs and the scaling group constraints will no longer exist. 

To delete a scaling group:

1. Go to Virtual datacenters → Virtual appliances
2. Open the scaling group
3. Click the wrench maintenance button to put the scaling group into maintenance mode
4. Click the trash can delete button

An alarm activates when a metric passes a certain threshold. If you imagine a dashboard for your metrics, alarms are like red lights that light up when conditions change, for example, when there is a problem. 

If you would like the platform to notify you when an alarm activates, create an Alert for it in Control view.

• Alerts are a group of one or more alarms. They are like a worker monitoring a group of alarms; when all the lights for the group are lit up, then the worker takes action and activates the alert. Alerts can also trigger action plans to perform automated actions when their alarms activate. After you create an alert, create an action plan in Control view with the alert as a trigger.

You can create alarms for built-in VM metrics or scaling group metrics, as well as custom metrics created using the API for VMs, scaling groups, virtual appliances, and virtual datacenters. 

• You cannot create alarms for cloned VMs that are part of a scaling group. This is because scaling groups have aggregate alarms that are associated with the base VM. 

To display alarms in virtual datacenters:

1. Go to Virtual datacenters 
2. Select a virtual datacenter or All virtual datacenters
3. Go to Alarms

Before you begin:

1. Configure the metrics you will use in the alarm. See VM monitoring and metrics and Custom Metrics Resources.

To create an alarm:

1. Go to Virtual datacenter → Alarms
2. Select virtual datacenter, virtual appliance, scaling group, or VM
3. Click the + add button
4. Enter the alarm details
   
   
   
   For more details see GUI Create alarm
   
   
5. Click Save

The platform will create the alarm for the metric. If you would like the platform to notify you when an alarm is triggered, create an Alert.

For API documentation about alarms on an entity, see the API documentation for the entity's resource. For example, for VMs, see VirtualMachinesResource.

When you edit an alarm, you cannot modify the metric or the entity.

When you edit an alarm, there is an extra field, "Active", that shows if the alarm is activated or not.

After you save the alarm, the platform will start to evaluate it again with new data when it receives the next set of metrics datapoints.

You can delete any alarm at any time, even if it is part of one or more alerts. The platform will not warn you that the alarm is used in an alert. However, you can check this in Control view. After you delete an alarm, you cannot recover it.

You can also remove an alarm from an alert.

To delete an alarm:

1. Go to Virtual datacenters or Infrastructure →  Alarms
2. Select the alarm and delete it by clicking on the trash bin delete button

To remove an alarm from an alert:

1. Go to Control → Alerts → edit alert

2. Select the alarm, click the trash bin delete button, and confirm
   The platform will remove it from this alert, but it will remain in all other alerts that it is associated with

Alerts are a group of one or more alarms. An alert can notify the user when it activates and it can also trigger action plans. An alert activates when all its alarms are activated. An alarm activates when a metric passes a certain threshold. 

If you imagine a dashboard for your metrics, alarms are like red lights that light up when conditions change, for example, when there is a problem. Alerts are like a worker monitoring a group of alarms; when all the lights for the group are lit up, then the worker takes action and activates the alert. 

To display and manage alerts:

1. Go to Control → Alerts

An alert will trigger when all its alarms are activated. You can use the alert to trigger actions. See Manage Action Plans.

Before you begin:

1. Retrieve VM built-in metrics, by editing VMs and enabling monitoring (see VM monitoring and metrics) or create custom metrics
2. Create one or more metric alarms (see Manage cloud alarms and Infrastructure Alarms). You cannot save an alert without an alarm

To create an alert:

1. Go to Control → Alerts
2. Click the + add button

3. Enter the alert details and assign alarms as described below

4. Click Save

You can delete any alarm at any time, even if it is part of one or more alerts. The platform will not warn you that the alarm is used in an alert. However, you can check this in Control view. After you delete an alarm, you cannot recover it.

You can also remove an alarm from an alert.

To delete an alarm:

1. Go to Virtual datacenters or Infrastructure →  Alarms
2. Select the alarm and delete it by clicking on the trash bin delete button

To remove an alarm from an alert:

1. Go to Control → Alerts → edit alert

2. Select the alarm, click the trash bin delete button, and confirm
   The platform will remove it from this alert, but it will remain in all other alerts that it is associated with

To enable more control over cloud operations, users can create action plans that will automatically run tasks on VMs and scaling groups, and to run general tasks. 

Action plans are an important automation functionality of the platform. They can combine general tasks with tasks that run on VMs and scaling groups in different providers and have multiple triggers including alerts from custom metrics or built-in metrics and schedules. Each VM or scaling group can have multiple action plans.

To display action plans:

1. Go to Control → Action plans

Before you create an action plan, consider the elements that you wish to automate with the action plan. Create VMs or scaling groups, fetch metrics, and create alarms and alerts.

To create an action plan:

1. Go to Control → Action plans, and click the + add button 
2. Enter the action plan details
   
3. Go to Actions to add actions: 
   
   
   1. Click the + add button
   2. Enter action details
      1. Type: Select a general action or select a VM or scaling group
      2. Decrease CPU/RAM: you cannot use this with hot-reconfigure and you must check that the OS is compatible

      3. Instance: Name for Instance (clone) template. The platform will append the date to the name supplied

      4. Webhook action - Expected HTTP status code: If this status code is returned, continue running the action plan. Default: 204 No Content

      5. Email action - To, CC: Enter email addresses as a comma separated list

   For more details, see UI reference: GUI Create action plan
4. Put the actions in run order using the arrow buttons

To run the action plan automatically, go to the Triggers tab and create an alert or schedule trigger. 

To run an action plan immediately to test it, do these steps:

1. Go to Control → Action plans
2. Select the action plan 
3. On the Actions panel, click the Run action plan button  

Abiquo recommends that you run an action plan manually to test it before you create a trigger to run it automatically

The platform supports two types of triggers to run action plans: Alerts and Schedules.

To run your action plan based on metrics, select an existing alert with these steps:

1. Go to Control → Action plans
2. Select an action plan
3. Below the Alerts panel, click the + add button
4. Select an alert. For details about creating an alert, see Manage Alerts

To run your action plan automatically at selected dates and times, create a schedule trigger with these steps:

1. Go to Control → Action plans
2. Select an action plan
3. Below the Schedules panel, click the + add button
4. Enter the details of the schedule using the calendar or time and repeat interval.
   
   For more details see GUI Edit action plan Schedules