nimsoft monitor cloudstack...
TRANSCRIPT
Legal Notices Copyright © 2012, CA. All rights reserved.
Warranty
The material contained in this document is provided "as is," and is subject to being changed, without notice, in future editions. Further, to the maximum extent permitted by applicable law, Nimsoft LLC disclaims all warranties, either express or implied, with regard to this manual and any information contained herein, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. Nimsoft LLC shall not be liable for errors or for incidental or consequential damages in connection with the furnishing, use, or performance of this document or of any information contained herein. Should Nimsoft LLC and the user have a separate written agreement with warranty terms covering the material in this document that conflict with these terms, the warranty terms in the separate agreement shall control.
Technology Licenses
The hardware and/or software described in this document are furnished under a license and may be used or copied only in accordance with the terms of such license.
No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Nimsoft LLC as governed by United States and international copyright laws.
Restricted Rights Legend
If software is for use in the performance of a U.S. Government prime contract or subcontract, Software is delivered and licensed as "Commercial computer software" as defined in DFAR 252.227-7014 (June 1995), or as a "commercial item" as defined in FAR 2.101(a) or as "Restricted computer software" as defined in FAR 52.227-19 (June 1987) or any equivalent agency regulation or contract clause. Use, duplication or disclosure of Software is subject to Nimsoft LLC’s standard commercial license terms, and non-DOD Departments and Agencies of the U.S. Government will receive no greater than Restricted Rights as defined in FAR 52.227-19(c)(1-2) (June 1987). U.S. Government users will receive no greater than Limited Rights as defined in FAR 52.227-14 (June 1987) or DFAR 252.227-7015 (b)(2) (November 1995), as applicable in any technical data.
Trademarks
Nimsoft is a trademark of CA.
Adobe®, Acrobat®, Acrobat Reader®, and Acrobat Exchange® are registered trademarks of Adobe Systems Incorporated.
Intel® and Pentium® are U.S. registered trademarks of Intel Corporation.
Java(TM) is a U.S. trademark of Sun Microsystems, Inc.
Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.
Netscape(TM) is a U.S. trademark of Netscape Communications Corporation.
Oracle® is a U.S. registered trademark of Oracle Corporation, Redwood City, California.
UNIX® is a registered trademark of the Open Group.
ITIL® is a Registered Trade Mark of the Office of Government Commerce in the United Kingdom and other countries.
All other trademarks, trade names, service marks and logos referenced herein belong to their respective companies.
For information on licensed and public domain software, see the Nimsoft Monitor Third-Party Licenses and Terms of Use document at: http://docs.nimsoft.com/prodhelp/en_US/Library/index.htm?toc.htm?1981724.html.
Contact Nimsoft
For your convenience, Nimsoft provides a single site where you can access information about Nimsoft products.
At http://support.nimsoft.com/, you can access the following:
■ Online and telephone contact information for technical assistance and customer services
■ Information about user communities and forums
■ Product and documentation downloads
■ Nimsoft Support policies and guidelines
■ Other helpful resources appropriate for your product
Provide Feedback
If you have comments or questions about Nimsoft product documentation, you can send a message to [email protected].
Contents 5
Contents
Chapter 1: cloudstack 1.0 7
Overview ...................................................................................................................................................................... 7
Documentation Changes .............................................................................................................................................. 7
Chapter 2: cloudstack Probe Deployment 9
Prerequisites and System Requirements ..................................................................................................................... 9
Prerequisites ......................................................................................................................................................... 9
System Requirements ........................................................................................................................................... 9
Software Requirements ...................................................................................................................................... 10
Supported Platforms ........................................................................................................................................... 10
Chapter 3: cloudstack Configuration 11
Probe Configuration Interface Installation ................................................................................................................. 11
Monitoring Capabilities .............................................................................................................................................. 12
Templates ................................................................................................................................................................... 12
Probe GUI ................................................................................................................................................................... 12
Configuration Interface Navigation ..................................................................................................................... 13
The Toolbar Buttons ............................................................................................................................................ 13
The Navigation (Left) Pane .................................................................................................................................. 13
The Content (Right) Pane .................................................................................................................................... 15
Probe Configuration ................................................................................................................................................... 16
General Setup ..................................................................................................................................................... 16
Create a New Resource ....................................................................................................................................... 16
Message Pool Manager ....................................................................................................................................... 17
Create New Template ......................................................................................................................................... 19
Chapter 4: Adding Monitors 21
Manually Selecting Monitors to be Measured ........................................................................................................... 21
Enabling the Monitors for QoS and Alarming ..................................................................................................... 22
To Edit Monitor Properties ................................................................................................................................. 22
Using Templates ......................................................................................................................................................... 25
To Create a New Template .................................................................................................................................. 25
To Add Monitors to a Template .......................................................................................................................... 26
To Apply a Template ........................................................................................................................................... 26
Using Automatic Configurations ................................................................................................................................ 26
6 cloudstack Guide
Adding a Template to the Auto Configurations Node ......................................................................................... 27
Adding a Monitor to the Auto Configurations Node ........................................................................................... 28
Exploring the Contents of the Auto Configurations Node .................................................................................. 28
Checking the Auto Monitors Node ...................................................................................................................... 28
Chapter 5: QoS and Alarm Threshold Metrics 29
cloudstack Metrics ..................................................................................................................................................... 29
Alert Threshold Metrics .............................................................................................................................................. 32
Appendix A: Troubleshooting 33
Out of Memory Errors ................................................................................................................................................ 33
Probe Cannot Connect to CloudStack ........................................................................................................................ 34
Chapter 1: cloudstack 1.0 7
Chapter 1: cloudstack 1.0
This description applies to the CA Nimsoft cloudstack probe version 1.0.
This section contains the following topics:
Overview (see page 7) Documentation Changes (see page 7)
Overview
Apache CloudStack and Citrix CloudPlatform Powered by Apache CloudStack, referred to in this document as CloudStack, are comprehensive software platform suites used to create Infrastructure as a Service (IaaS) for private, public, or hybrid clouds.
The CA Nimsoft cloudstack monitoring probe automates all common monitoring and data collection tasks for the CloudStack environment, and lets you focus on problems as they arise.
The cloudstack probe collects and stores data about zones, pods, clusters, hosts, storage, logs, and VMs.
You can define alarms to be raised and propagated to the Alarm Console when specified thresholds are breached.
Documentation Changes
This table describes the version history for the cloudstack document.
Version Date What's New?
1.0 December 2012 Initial Release
Note: Serial releases within a version do not affect the documentation for the series. For example, v1.0 documentation would apply to release 1.01.
Documentation Changes
8 cloudstack Guide
Related Documentation
Documentation for other versions of the cloudstack probe
The Release Notes for the cloudstack probe
Getting Started with CA Nimsoft® Probes
Monitor Metrics Reference Information for CA Nimsoft Probes
Chapter 2: cloudstack Probe Deployment 9
Chapter 2: cloudstack Probe Deployment
Successful distribution of the cloudstack probe package relies on the Java package installed with the Nimsoft Management Server.
The cloudstack probe supports monitoring for the following:
■ Apache CloudStack 2.2.x or 3.0.x environment using the CloudStack Root Admin REST API
■ Citrix CloudPlatform Powered by Apache CloudStack
This section contains the following topics:
Prerequisites and System Requirements (see page 9)
Prerequisites and System Requirements
This section contains the prerequisites and system requirements for the cloudstack probe.
Prerequisites
The cloudstack probe requires the following type of account access to the CloudStack management server API:
■ API key and Secret/Share Key for the Root Admin account using the REST API port 8080 or 80.
Note: This probe does not talk directly to the CloudStack host hypervisors. CA Nimsoft has other hypervisor-related probes for monitoring hypervisors in detail.
System Requirements
The cloudstack probe should be installed on systems with the following minimum resources:
■ Memory: 2-4 GB of RAM. This probe OOTB configuration requires 256 MB of RAM.
■ CPU: 3 GHz dual-core processor, 32-bit or 64-bit
Prerequisites and System Requirements
10 cloudstack Guide
Software Requirements
The cloudstack probe requires the following software environment:
■ Nimsoft Monitor Server 5.1.1 or later
■ Nimsoft robot version 5.23 or later
■ Java Virtual Machine version 1.6 or later (deployed as part of the probe package)
■ Infrastructure Manager v4.02 or later
■ Microsoft .NET Framework 3.5 on the hardware running the Infrastructure Manager application and the cloudstack probe GUI
Supported Platforms
The cloudstack probe supports the same set of operating systems and databases as supported by the Nimsoft Server solution. Please refer to the Nimsoft Compatibility Support Matrix for the latest information on supported platforms.
Chapter 3: cloudstack Configuration 11
Chapter 3: cloudstack Configuration
This section describes the configuration concepts and procedures for setting up the cloudstack probe.
After installing the cloudstack probe, you must define what to monitor. At a high level there are three steps:
1. Connect to the CloudStack environment.
2. Add monitors (checkpoints). See the description in the section Adding Monitors (Checkpoints).
3. Configure the properties for the checkpoints, in which you define QoS data, and define alarms to be sent if specified thresholds are breached.
Note: You must always click the Apply button to activate any configuration changes.
This section contains the following topics:
Probe Configuration Interface Installation (see page 11) Monitoring Capabilities (see page 12) Templates (see page 12) Probe GUI (see page 12) Probe Configuration (see page 16)
Probe Configuration Interface Installation
The probe configuration interface is automatically downloaded and installed by the Nimsoft Infrastructure Manager when the probe is deployed on a robot.
Monitoring Capabilities
12 cloudstack Guide
Monitoring Capabilities
The cloudstack probe can monitor the following entities:
■ Resources
■ Zones
■ Pods
■ Hosts
■ Clusters
■ VM Templates
■ Primary Storage
■ Secondary Storage
■ System VMs
■ All VMs (Instances)
Templates
Templates let you define reusable sets of monitors to apply to the various cloudstack components. After you create a template and define a set of checkpoints belonging to that template, you can either:
■ Drag and drop the template into the cloudstack resource hierarchy where you want to monitor the checkpoints defined for the template. This creates a static monitor for that resource component and its children (recursively) based on the template contents at the time the static monitor is created.
■ Drag and drop the template into the Auto Configuration to add the template contents to the list of auto configuration monitors.
See the section Using Templates (see page 25) for details.
Probe GUI
This section contains the basic GUI information for the cloudstack probe.
The cloudstack probe collects and stores data and information from the monitored components within a CloudStack environment.
Double-click the line representing the cloudstack probe in the Infrastructure Manager to launch the cloudstack probe configuration interface. It initially appears with the Resources hierarchy empty.
Probe GUI
Chapter 3: cloudstack Configuration 13
Configuration Interface Navigation
The configuration interface consists of a row of tool buttons above a window split into two parts:
■ The Navigation pane
■ The Content pane
In addition, a status bar at the bottom of the window shows version information and date and time when the probe was last started.
The Toolbar Buttons
The configuration interface contains a row of toolbar buttons:
■ The General Setup button allows you to configure the log level for the probe.
■ The New Resource button allows you to add a new resource.
■ The Message Pool Manager button allows you to add, remove or edit alarm messages.
■ The Create New Template button allows you to create a new template.
The Navigation (Left) Pane
The division on the left side of the window is the navigation pane. It displays the monitored Resources and any Templates you have created.
Resources
You can create a new Resource by clicking the New Resource button, or by right-clicking Resources and selecting New Resource.
The Resource is configured as a link to the Red Hat Enterprise Virtualization environment. Note the following icons for the Resource node:
= Resource is inactive
= Resource is marked for deletion
= Resource is unable to connect
= New resource (not yet saved)
Probe GUI
14 cloudstack Guide
= Resource is connected and inventory is ready to browse
= Resource is loading inventory. Not ready to browse
The Resources node contains the following sub-hierarchies:
■ The Auto Configurations node
One or more checkpoints (or templates) can be added to this node, using drag and drop. These checkpoints can to be used for auto configuring unmonitored devices. See the section Using Automatic Configurations (see page 26) for further information.
■ The Auto Monitors node
This is a list of the monitors that have been created based on the Auto-Configuration entries and the inventory available on the Resource.
See the section Using Automatic Configurations (see page 26) for further information.
■ The All Monitors node
This node contains the complete list of Monitors for the Resource. This includes Auto Monitors and manually configured Monitors. See the section Using Automatic Configurations (see page 26) for further information.
■ The cloudstack hierarchy
This is a list of the Zones and child components available in the CloudStack environment for monitoring.
Note: Typically there are a large number of components in a cloudstack hierarchy, such as many VM instances, and it may take a few minutes for the hierarchy tree to populate. For large CloudStack environments, ensure there is at least 300 MB of memory available on the Windows system where you are running the probe GUI.
Templates
Templates provided with the cloudstack probe let you define reusable sets of monitors for the various CloudStack resources.
■ To add a template, click the Create New Template button.
■ To edit or delete a template, click on the template name to select it, then right-click and select the action you want.
The properties for a template are Name and Description. See the section Using Templates (see page 25) for details.
Probe GUI
Chapter 3: cloudstack Configuration 15
This node contains the following default templates:
■ Zones Monitoring
■ VMs Monitoring
■ System VM Monitoring
■ Pods Monitoring
■ Hosts Monitoring
■ Secondary Storage Monitoring
■ Primary Storage Monitoring
Navigation Pane Updates
A right-click with the mouse pointer in the navigation pane over the hostname or IP address node opens a pop-up menu with menu items for managing the selected object or creating new objects of its type. Options typically include: New, Edit, Delete, Deactivate, and Refresh.
Note: When available, the Refresh menu item retrieves updated values and refreshes the display.
The Content (Right) Pane
The content of the right pane depends on the current selection in the navigation pane.
If you select a Resources node in the navigation pane, the content pane lists the CloudStack environments.
If you select a Resource, Zone, or child component in the navigation pane, the content pane lists the available monitors. Active Monitors are check-marked. The following icons can appear there:
Indicates that the monitor is active but not enabled to send alarms. The Enable Monitoring checkbox was not selected for this monitor.
Black: Indicates that the monitor is NOT activated. The Action option is not set in the properties dialog for the monitor.
Green: Indicates that the monitor is activated for monitoring and, if an alarm threshold is set, the threshold value defined in the properties dialog for the monitor is not exceeded.
Gray: Indicates that the monitor is an inactive static monitor.
Probe Configuration
16 cloudstack Guide
Other colors: Indicates that the monitor is activated for monitoring and the threshold value defined in the properties dialog for the monitor is exceeded. The color reflects the message token selected in the properties dialog for the monitor.
This icon represents a monitor where no value has been measured.
Note: Any monitor name in italics indicates that the monitor has been modified and you must apply the changes before the monitor results are updated.
Content Pane Updates
A right-click with the mouse pointer on objects in the content pane opens a pop-up menu with menu items for managing the selected object type (Edit, Delete, and Add to Template).
Note: When available, the Refresh menu item fetches updated values and refreshes the display.
Probe Configuration
This section contains specific configuration information for the cloudstack probe.
General Setup
Click the General Setup button to set the level of details written to the log file for the cloudstack probe. Set the log level to the smallest value possible during normal operation to minimize disk consumption. This is a sliding scale with the range of information logged being fatal errors all the way to extremely detailed information used for debugging purposes.
Click the Apply button to implement the new log level immediately.
Note: The probe allows you to change the log level without restarting the probe.
Create a New Resource
There are two ways to create a Resource:
■ Click the New Resource button on the toolbar.
■ Right click Resources in the navigation pane and select New Resource.
The Resource (New) dialog box appears. Enter the appropriate field information:
Hostname or IP Address
The hostname or IP address of the CloudStack system to monitor.
Probe Configuration
Chapter 3: cloudstack Configuration 17
Port
The port number for the CloudStack REST API environment. Default is 8080.
Active
Select this checkbox to activate or deactivate monitoring of the Resource.
API Key
The API Key for the root admin for the CloudStack environment you are connecting to.
Secret Key
The corresponding root admin secret key for the CloudStack environment you are connecting to.
Alarm Message
Select the alarm message to be sent if the Resource does not respond.
Note: You can edit the message or define a new message using the Message Pool Manager.
Check Interval
The check interval defines how often the probe checks the values of the monitors. This can be set in seconds, minutes or hours. We recommend polling once every 10 minutes. The polling interval should be greater than the time required to collect the data.
Test button
Click the Test button to verify the connection to the Resource.
After completing the fields and testing that the connection works, click OK to add the Resource. The initial data collection/polling cycle starts. The resource hierarchy will populate once the polling cycle has completed.
Message Pool Manager
You can add, remove, or modify alarm messages. These are the messages sent when a QoS threshold has been breached.
Add a New Alarm Message
To add a new alarm message:
1. Click the Message Pool Manager button on the toolbar.
The Message Pool dialog appears.
Probe Configuration
18 cloudstack Guide
2. Click the Add button.
The Message Properties dialog appears.
3. Complete the field information:
Identification Name
The name of the message.
Token
The type of alarm, either "monitor_error" or "resource_error".
Error Alarm Text
The alarm text sent when a violation occurs. Variables can be used in this field.
Example: $monitor
This variable resolves to the actual monitor name in the alarm text. There are several available variables: $resource, $host, $port, $descr, $key, $unit, $value, $oper, and $thr.
Clear Alarm Text (OK)
The text sent when an alarm is cleared.
Error Severity
Severity of the alarm.
Subsystem string/id
The NAS subsystem ID for the CloudStack system.
4. Click OK to save the new message.
Delete an Alarm Message
To delete an alarm message:
1. Click the Message Pool Manager button on the toolbar.
The Message Pool dialog appears.
2. Select the message to remove.
3. Click the Remove button.
The alarm message is removed.
4. Close the Message Pool Manager window and click Apply to implement the changes.
Probe Configuration
Chapter 3: cloudstack Configuration 19
Edit an Alarm Message
To edit an alarm message:
1. Click the Message Pool Manager button on the toolbar.
The Message Pool dialog appears.
2. Select a message id in the list.
3. Click the Edit button.
The Message Properties dialog appears.
4. Update the message properties as needed.
5. Click OK.
6. Close the Message Pool Manager window and click Apply to implement the changes.
Create New Template
There are two ways to create a new template:
■ Click the New Template button on the toolbar.
■ Right click the Templates node in the navigation pane and select New Template.
See the section Using Templates (see page 25) for more information.
Chapter 4: Adding Monitors 21
Chapter 4: Adding Monitors
There are three different ways to add monitors to CloudStack entities:
Manually select the monitors
To manually select and enable monitors, navigate to the target entity within the Resource. This lists its monitors in the right pane. Use the available check-boxes to enable QoS monitoring for the selected metrics. To enable Alarm thresholding, you will need to launch the Edit Monitor dialog. See the section Manually Selecting Monitors to be Measured (see page 21).
Use Templates
Templates let you define reusable sets of monitors to apply to various CloudStack monitored entities.
See the section Using Templates (see page 25) for further information.
Use Auto Configurations
Auto Configuration is a powerful way to automatically add monitors to be measured. Monitors are created for new devices (that is, ones not currently monitored) that would otherwise need manual configuration to be monitored.
Example: Auto Configuration contains an auto-monitor for VM 'CPU Used'. When a new VM is created within CloudStack the Auto Configuration feature creates a monitor automatically for monitoring the VM.
See the section Using Automatic Configurations (see page 26) for further information.
This section contains the following topics:
Manually Selecting Monitors to be Measured (see page 21) Using Templates (see page 25) Using Automatic Configurations (see page 26)
Manually Selecting Monitors to be Measured
To select a monitor you want to be measured for a Resource, click the Resource node in the navigation pane, and navigate through the Resources hierarchy. Select a folder in the hierarchy to see the monitors for it, listed in the right pane. Click the check box beside the Monitors you want to be active.
Note: You can also add monitors to be measured using templates (see the section Using Templates (see page 25)).
Manually Selecting Monitors to be Measured
22 cloudstack Guide
Select the All Monitors node to list all monitors currently being measured in the right pane. You can select or deselect monitors here as well.
■ Green icon - the monitor is configured and active
■ Gray icon - the monitor is configured but not active
■ Black icon - the monitor is not configured
Note: If a monitor name is in italics you have changed the configuration however have not applied the changes.
Enabling the Monitors for QoS and Alarming
You can now see the current values for the monitors in the Values column in the monitor list. Selecting the checkbox next to a monitor name only enables the monitor. To configure the probe to send QoS data and/or send alarms you must modify the properties for each monitor.
Double-click a monitor (or right-click and select Edit) to launch the monitor’s properties dialog. See To Edit Monitor Properties for further information.
To Edit Monitor Properties
Double-click a monitor (or right-click and select Edit) to launch the monitor’s properties dialog.
Note the Type column when monitors are listed in the right pane. Monitors of type value and type event have different properties.
Monitors of Type Value
The properties for monitors of type value are as follows:
Name
This is the name of the monitor. The name will be inserted into this field when the monitor is retrieved from the CloudStack environment.
Key
This is a read-only field, describing the monitor key.
Description
This is a description of the monitor. This description will be inserted into this field when the monitor is retrieved from the CloudStack environment.
Manually Selecting Monitors to be Measured
Chapter 4: Adding Monitors 23
Value Definition
This drop-down list lets you select which value to be used, both for alarming and QoS:
You have the following options:
■ The current value. The most current value measured will be used.
■ The delta value (current – previous). The delta value calculated from the current and the previous measured sample will be used.
■ Delta per second. The delta value calculated from the samples measured within a second will be used.
■ The average value of the last and current sample: (current + previous) / 2.
■ The average value last ... The user specifies a count. The value is then averaged based on the last "count" items.
Active
This activates the monitoring of the probe.
Enable Alarming
Selecting this option activates the alarming.
Note that the monitor will also be selected in the list of monitors in the right window pane when this option is selected, and that you can enable or disable monitoring of the checkpoint from that list.
This section describes the alarm properties for the monitor.
You can define both a high and a low threshold.
Initially the high threshold is set to the current value. Set this value to match your needs.
The low threshold is initially disabled. If you want to use it, you must select another operator than "disabled" from the list and configure it to match your needs.
Operator
Select from the drop-down list the operator to be used when setting the alarm threshold for the measured value.
Example:
>= 90 means the monitor is in alarm condition if the measured value is equal to or above 90.
= 90 means the monitor is in alarm condition if the measured value is exactly 90.
Threshold
The alarm threshold value. An alarm message is sent when this threshold is violated.
Manually Selecting Monitors to be Measured
24 cloudstack Guide
Unit
This field specifies the unit of the monitored value (for example %, Mbytes etc.). The field is read-only.
Message ID
Select the alarm message to be issued if the specified threshold value is breached. These messages reside in the message pool. You can modify the messages in the Message Pool Manager.
Publish Quality of Service
Select this option if you want QoS messages to be issued on the monitor.
QoS Name
The unique QoS metric. This is a read-only field.
Monitors of Type Event
You can monitor CloudStack events on the Resource entity. The event is forwarded as an alarm message and the suppression key is based on the entity.
The properties for monitors of type event are:
Name
This is the name of the monitor. The name will be inserted into this field when the monitor is retrieved from the CloudStack environment, and you are allowed to modify the name.
Key
This is a read-only field, describing the monitor key.
Description
This is a description of the monitor. This description will be inserted into this field when the monitor is retrieved from the CloudStack environment. This is a read-only field.
Subscribe
Selecting this option, an alarm will be sent when this event has been triggered.
Operator
Select the operator to be used when setting the alarm threshold for the event.
This threshold refers to the event’s severity level in CloudStack.
Example: >= Warning means alarm condition if the event is triggered, and the severity level in CloudStack is equal to or higher than Warning.
Using Templates
Chapter 4: Adding Monitors 25
Severity
The threshold severity level for the event in CloudStack.
Message Token
Select the alarm message to be issued if the specified threshold value is breached. These messages are kept in the message pool. The messages can be modified in the Message Pool Manager.
Important! Monitoring events may cause a larger than expected increase in alarm messages and possibly a decrease in system performance.
Using Templates
Templates let you define reusable sets of monitors to be measured on multiple Resources. They provide an easy way to accomplish consistent monitoring of your CloudStack environment.
You can create your own templates and define a set of monitors belonging to each. You can then apply these templates to anything in the Resources or Auto Configurations hierarchies in the navigation pane by dragging the template and dropping it on the appropriate item. This assigns the template monitors to the drop point and everything below it.
If you apply a template to the Auto Configuration, its monitors are applied to all CloudStack monitored entities as they appear in the system. If you need a finer level of control, you can apply a template to anything in the Resources hierarchy; in this case the monitors are applied to the drop-point and everything subordinate to it. Any templates applied within the Resources hierarchy are static monitors. The static monitors override any auto monitors for that specific resource entity.
Note: You can do both, placing general-purpose templates in Auto Configuration, and applying special-purpose templates that override the Auto Configuration templates on specific nodes, for specific purposes.
See the Using Automatic Configurations (see page 26) section for details on Auto Configuration.
To Create a New Template
There are two ways to create a template:
■ Click the toolbar button for New Template ( ).
Using Automatic Configurations
26 cloudstack Guide
■ Right click the Templates node in the navigation pane, and choose New Template from the menu.
In the resulting Template Properties dialog, specify a Name and a Description for the new template.
Note that you can also edit an existing template: Select one of the templates defined under the Templates node in the navigation pane, right-click it, and select Edit from the menu.
To Add Monitors to a Template
There are two ways to add a monitor to a template:
■ Drag it from the content pane and drop it on the template in the navigation pane.
■ Right-click on a monitor in the content pane and select Add to Template.
You can edit the properties for monitors in the template as described in the section To Edit Monitor Properties.
To Apply a Template
Drag the template to the Auto Configuration node or to an entity within the Resource where you want it applied, and drop it there.
Note: You can drop the template on an object containing multiple subordinate objects. This applies the template to the entity and all its subordinate entities. A static monitor is created for this entity.
Using Automatic Configurations
Automatic configuration is an optional but powerful way to automatically add monitors to be measured. This is the preferred method for configuring your resources. When new CloudStack monitored entities are detected, "Auto Monitors" are created for devices that are not currently monitored using a static monitor.
Using Automatic Configurations
Chapter 4: Adding Monitors 27
The Auto Configuration feature consists of two sub-nodes located under the Resource node in the navigation pane:
Auto Configurations node
You can add contents from one or more templates or individual checkpoints to this node, using drag and drop. You must click the Apply button and restart the probe to activate the changes. The probe then searches through the CloudStack environment for applicable entities. Auto Monitors representing the monitor(s) under the Auto Configuration node are created (and listed under the Auto Monitor node, see below) for applicable entities where the metric does not already have a static monitor configured against it.
IMPORTANT: If you are experiencing performance problems, we recommend increasing the polling cycle and/or the memory configuration for the probe. Increase memory when the probe is running out of memory. Increase the polling cycle when the collection takes longer than the configured interval.
Auto Monitors node
This node lists Auto Monitors, created based on the contents added to the Auto Configuration node. The Auto Monitors are only created for content without a pre-existing static monitor.
Adding a Template to the Auto Configurations Node
You can add a template's content to the Auto Configurations as follows:
1. Click the Templates node in the navigation pane to list all available templates in the content pane.
2. Add a template to the Auto Configurations node by dragging the template from the list and dropping it on the Auto Configurations node in the navigation pane.
3. Click the Auto Configurations node to verify that the template's content was successfully added.
See the Using Templates (see page 25) section to learn more about templates.
Note: You must click the Apply button and restart the probe to activate configuration changes.
Using Automatic Configurations
28 cloudstack Guide
Adding a Monitor to the Auto Configurations Node
You can add a single monitor (checkpoint) to the Auto Configurations node.
To list available monitors:
1. Select the Resource node in the navigation pane and navigate to the point of interest.
2. Select an object to list its monitors in the right pane.
3. Add the monitor to the Auto Configurations node by dragging the monitor to the Auto Configurations node and dropping it there.
4. Click the Auto Configurations node and verify that the monitor was successfully added.
Note: You must click the Apply button and restart the probe to activate configuration changes.
Exploring the Contents of the Auto Configurations Node
To verify that the monitors were successfully added, click the Auto Configurations node in the navigation pane.
■ To edit the properties for a monitor, right-click in the list and choose Edit from the menu. See the section To Edit Monitor Properties (see page 22) for detailed information.
■ To delete a monitor from the list, right-click in the list and choose Delete from the menu.
Note: You must click the Apply button and restart the probe to activate configuration changes.
Checking the Auto Monitors Node
Note: When monitors have been added to the Auto Configurations node, you must click the Apply button and restart the probe to activate the Auto Configuration feature.
When you restart the probe, it searches through the Resource's entities. For each one that is currently not monitored, an Auto Monitor is created for each of the monitors listed under the Auto Configurations node.
All defined Auto Monitors are listed under the Auto Monitors node.
Chapter 5: QoS and Alarm Threshold Metrics 29
Chapter 5: QoS and Alarm Threshold Metrics
Many Nimsoft Monitor probes ship with default alarm threshold values set. The default threshold values provide an idea of the type of values to be entered in the fields and are not necessarily recommended best practice values. To aid in tuning thresholds and reducing false-positive alarms, this section describes the QoS metrics and provides the default alarm thresholds.
This section contains the following topics:
cloudstack Metrics (see page 29) Alert Threshold Metrics (see page 32)
cloudstack Metrics
This section contains the QoS metrics for the cloudstack probe.
Resource Entity Metric Name Unit Description
RESOURCE CloudStack Version String The Version of CloudStack
Event Integer An event for the Resource
ZONE Allocated Storage % Used Percent Percent of Allocated Storage Used
Allocated Storage Total MB Total amount Storage Allocated
Allocated Storage Used MB Used amount of Storage Allocated
CPU % Used Percent Percent of CPU Used
CPU Total GHz CPU Total
CPU Used GHz CPU Used
Direct Attached IP Total Count Direct Attached Public IPs Total
Direct Attached IP Used Count Direct Attached IPs Used
Direct IP % Used Percent Percent of Direct Attached Public IP Used
Memory % Used Percent Percent of Memory Used
Memory Total GB Memory Total
Memory Used GB Memory Used
Private IP % Used Percent Percent of Private IP Addresses Used
cloudstack Metrics
30 cloudstack Guide
Private IP Allocated Count Private IP Addresses Allocated
Private IP Used Count Private IP Addresses Used
Public IP % Used Percent Percent of Public IP Addresses Used
Public IP Allocated Count Public IP Addresses Allocated
Public IP Used Count Public IP Addresses Used
Secondary Storage % Used Percent Secondary Storage % Used
Secondary Storage Total MB Secondary Storage Total
Secondary Storage Used MB Secondary Storage Used
Storage % Used Percent Percent of Storage Used
Storage Total MB Storage Total
Storage Used MB Storage Used
SECONDARY STORAGE
Disk Size Total MB Storage Disk Size Total
Is Local Storage Active Boolean Is Local Storage Active
Storage Allocation State Integer
Secondary Storage Allocation State (Enabled = 0,PrepareForMaintenance = 10,Maintenance = 20,Creating = 30,Disabled = 40,ErrorInMaintenance = 50,Error = 60)
Storage Disk Size Allocated MB Storage Disk Size Allocated
Storage Resource State Integer
Secondary Storage Resource State (Enabled = 0,PrepareForMaintenance = 10,Maintenance = 20,Creating = 30,Disabled = 40,ErrorInMaintenance = 50,Error = 60)
Storage State Integer Secondary Storage State (up = 0,connecting = 10,disconnected = 20,creating = 30,rebalancing = 40,removed = 50,down = 60,alert = 70,error = 80)
STORAGEPOOL
Storage Pool State Integer
Storage Pool State (up = 0,PrepareForMaintenance = 10,Maintenance = 20,CancelMaintenance = 30,Removed = 40,ErrorInMaintenance = 50)
Total Disk Percent Allocated Percent Total Storage Pool Disk Percent Allocated
Total Disk Size MB Total Storage Pool Disk Size
Total Disk Size Allocated MB Storage Pool Disk Size Allocated
Total Disk Size Percent Used Percent Total Storage Pool Disk Size Percent Used
Total Disk Size Used MB Total Storage Pool Disk Size Used
HOST CPU Allocated Percent CPU Allocated
cloudstack Metrics
Chapter 5: QoS and Alarm Threshold Metrics 31
CPU Number Count Number of CPUs
CPU Speed GHz CPU Speed
CPU With Over Provisioning Percent CPU With Over Provisioning
Current CPU Average Load Count CPU Average Load
Current CPU Used Percent Percent CPU Used
Host Status Integer The status of the Host (up = 0,connecting = 10,disconnected = 20,creating = 30,rebalancing = 40,removed = 50,down = 60,alert = 70,error = 80);
Host Type String The type of HostSystem VM
Is Local Storage Active Boolean Is Local Storage Active
Memory Allocated MB Memory Allocated
Memory Total MB Memory Total
Memory Used MB Memory Used
Network Kbs Read KB Network KBs Read per second
Network Kbs Write KB Network KBs Written per second
VM CPU Number Count CPU Number
CPU Speed MHz CPU Speed
Current CPU Used Percent CPU Used
Memory MB Total Memory Allocated
Network Kbs Read KB Network KBs Read per Second
Network Kbs Write KB Network KBs Written per Second
VM Status Integer
The status of the VM (Unknown = -1,Running = 0,Starting = 10,Migrating = 20,Stopping = 30,Stopped = 40,Shutdowned = 50,Destroyed = 60,Expunging = 70,Error = 80)
POD CPU % Used Percent Percent of CPU Used
CPU Total GHz CPU Total
CPU Used GHz CPU Used
Memory % Used Percent Percent of Memory Used
Memory Total GB Memory Total
Memory Used GB Memory Used
Private IP % Used Percent Percent of Private IP Addresses Used
Private IP Allocated Count Private IP Addresses Allocated
Alert Threshold Metrics
32 cloudstack Guide
Private IP Used Count Private IP Addresses Used
Storage % Used Percent Percent of Storage Used
Storage Total MB Storage Total
Storage Used MB Storage Used
SYSTEM_VM State Integer
The state of the System VM (up = 0,connecting = 10,disconnected = 20,creating = 30,rebalancing = 40,removed = 50,down = 60,alert = 70,error = 80);
System VM Type String The type of System VM
Alert Threshold Metrics
The cloudstack probe will not have default QoS alert threshold values set. You must set the threshold values when you configure the probe. You can also use the default monitoring templates, which have best practices QoS metrics and alarms set.
Appendix A: Troubleshooting 33
Appendix A: Troubleshooting
This section contains troubleshooting tips for this cloudstack probe.
This section contains the following topics:
Out of Memory Errors (see page 33) Probe Cannot Connect to CloudStack (see page 34)
Out of Memory Errors
Symptom:
Out of memory/garbage collection errors.
Solution:
If you have more than 3000 virtual desktops for a CloudStack management server (represented as a resource in the cloudstack probe), you may need to increase the heap space for the probe. Heap space is allocated during probe startup. By default the heap space for the cloudstack probe is 256 MB.
You can increase the heap space setting for the cloudstack probe in the Raw Configure window for the probe.
Follow these steps:
1. Shift + right-click on the cloudstack probe in Infrastructure Manager.
2. Choose Raw Configure from the menu.
The Raw Configure dialog opens.
3. Click startup in the left pane.
4. Select the options key and open it for editing.
5. Enter a value similar to the following:
-Xms256m –Xmx<nnnn>m
where <nnnn> is heap space up to 2048 MB or greater. For example, to increase the heap space to 1024 MB, enter the following:
-Xms256m –Xmx1024m
Ensure the machine where the CA Nimsoft robot and probe are deployed has enough RAM.
6. Click OK and Apply.
Probe Cannot Connect to CloudStack
34 cloudstack Guide
Probe Cannot Connect to CloudStack
Symptom:
When I click the Test button in the Edit Resource dialog in the probe GUI, the probe fails to connect to the CloudStack environment.
Solution 1:
Verify that the IP address for the CloudStack management server is accessible and correct. If you have multiple servers in a high availability (HA) configuration, they must share a single IP address translated using NAT and appropriate API keys need to be synched.
Solution 2:
Verify that the API keys are correct. Also, the API key and related secret or share key must correspond to the root admin account and not the domain admin or a regular user account.