Chat now with support
Chat with Support

Foglight for VMware 5.8.2 - Installation Guide

Setting the Black List properties

In some rare cases, the VMware Performance Agent can encounter ESX hosts and virtual machines for which it cannot collect data. To prevent these problems, the VMware Performance Agent detects these entities, excludes them from data collection, and adds them to the agent black list.

Any metrics associated with these objects are not included in roll up performance metrics. When an entity is added to the agent black list, an agent message and alarm are generated makes you aware of the problem so that you can investigate it further in the monitored VMware environment. When the issue with the entity is resolved, it can be removed from the agent black list. The next available performance collection includes this entity in the data collection request.

In addition to the list that is populated by the agent, there is a user-populated black list. You populate this list by adding ESX hosts and virtual machines that you want to exclude from data collection. This feature enables Foglight administrators to disable data collection for certain ESX hosts and virtual machines, which also prevents their performance metrics from being submitted to Foglight.

 
* 
CAUTION: Black listing an ESX host disables data collection for that ESX host, including the collection of virtual machine, storage, and network metrics for that host.

Any metrics associated with black listed objects are submitted as part of roll up metrics. For example, if a virtual machine that appears on the user-populated black list is part of a resource pool, the virtual machine performance metrics are included with the performance metrics of other virtual machines from the same resource pool. This resource pool performance data is collected and submitted to Foglight. At the same time, the black-listed virtual machine object will not appear to have any performance metrics stored for this object. ESX hosts are handled the same way in terms of rolling up performance data for clusters, datacenters, or the Virtual Center.

Each ESX host or virtual machine entry in the user black list should include the Managed Object Reference (MOR) value. The MOR value is assigned to monitored objects in the monitored VMware environment and is collected by Foglight for VMware. This value is stored in the Managed Object Reference property of ESX host and virtual machine objects. You can use the Data Browser to find out the MOR values for those ESX hosts or virtual machines that you want to exclude from data collection.

The agent checks both lists during data collection. You can remove entities from either list, as required. For example, if you resolve an issue with a virtual machine that causes data collection problems, you can remove the virtual machine from the black list.

For any ESX hosts or virtual machines that you want to exclude from data collection an entry should exist in the agent or user black lists. While you can add entries to the user lists, agent black lists should only be populated by the VMware Performance Agent. Any ESX hosts or virtual machines for which you want to enable data collection must have their entries removed from either black lists.

Every VMware Performance Agent instance is associated with an agent and a user black list. Each agent instance should maintain a unique pair of these lists. Because list properties in Foglight (also known as secondary properties) are shareable properties, meaning that they are accessible to all agent instances of the type in which they are defined, you should clone an agent and a user black list for each agent instance and give them unique names.

Entities included in these lists are not included in the collection of performance metrics. Other collections are not affected by their contents.

To set the black list properties:
1
Locate the VMware Performance Agent’s BlackList properties.
2
Associate this agent instance with a user black list.
a
Choose the user black list that you want to use for this agent instance. Click the User BlackListed MORs list, and select the black list. The default list is userBlackList.
b
Clone the selected list to create a unique user black list for this agent instance. Click Clone on the right.
The Clone userBlackList dialog box appears.
c
In the Clone userBlackList dialog box, type the name of the user black list. It is recommended to use a syntax that makes the list name unique and easily associated with this agent instance. For example: <list_name>_<agent_name>
d
Click OK to close the Clone userBlackList dialog box.
The newly cloned user black list is now associated with this agent instance.
3
Edit the user black list to disable or enable data collection for particular ESX hosts or virtual machines.
 
* 
IMPORTANT: For any ESX hosts or virtual machines that you want to exclude from data collection, an entry should exist in the agent or user black lists. While you can add entries to the user lists, agent black lists should only be populated by the VMware Performance Agent. Any ESX hosts or virtual machines for which you want to enable data collection must have their entries removed from either black lists.
a
Click Edit on the right of the User BlackListed MORs list.
The VMwarePerformance - userBlackList dialog box appears.
b
To disable data collection for an ESX host or virtual machine, add it to the list.
 
* 
IMPORTANT: Black listing an ESX host disables data collection for that ESX host, including the collection of virtual machine, storage, and network metrics for that host.
To black list an ESX host or virtual machine, click Add Row, and in the new row that appears, in the BlackList Item column, specify the ESX host or virtual machine using the following syntax:
<host|vm>-<MOR>
Where:
•
host: Indicates that the black list item is an ESX host.
•
vm: Indicates that the black list item is a virtual machine.
•
MOR: The value of the Managed Object Reference property of the ESX host or virtual machine that you want to exclude from data collection.
For example: vm-20123
 
* 
TIP: You can use the Data Browser to find out the MOR values for those ESX hosts or virtual machines that you want to exclude from data collection.
c
To enable data collection for an ESX host or virtual machine, remove it from the list. Select the ESX host or virtual machine entry in the list, and click Delete Selected Row(s).
The list refreshes, no longer showing the deleted entry.
4
Associate this agent instance with an agent black list.
a
Choose the agent black list that you want to use for this agent instance. Click the Agent BlackListed MORs list, and select the black list. The default list is blackList.
b
Clone the selected list to create a unique agent black list for this agent instance. Click Clone on the right.
The Clone blackList dialog box appears.
c
In the Clone blackList dialog box, type the name of the agent black list. It is recommended to use a syntax that makes the list name unique and easily associated with this agent instance. For example: <list_name>_<agent_name>
d
Click OK to close the Clone blackList dialog box.
The newly cloned agent black list is now associated with this agent instance. The agent populates this list by adding ESX host or virtual machine entries that cause problems in data collection.
5
Edit the agent black list to enable data collection for particular ESX hosts or virtual machines.
 
* 
IMPORTANT: For any ESX hosts or virtual machines that you want to exclude from data collection, an entry should exist in the agent or user black lists. While you can add entries to the user lists, agent black lists should only be populated by the VMware Performance Agent. Any ESX hosts or virtual machines for which you want to enable data collection must have their entries removed from either black lists.
a
Click Edit on the right of the Agent BlackListed MORs list.
The VMwarePerformance - blackList dialog box appears.
b
To enable data collection for an ESX host or virtual machine, remove it from the list. For example, if an issue with a virtual machine is resolved, you can remove its entry from the agent black list. Select the ESX host or virtual machine entry in the list, and click Delete Selected Row(s).
The list refreshes, no longer showing the deleted entry.
6
Click Save.

Setting the Data Collection Scheduler properties

Use the Data Collection Scheduler properties to adjust how frequently the VMware Performance Agent collects data from the monitored server.

To set the data collection properties:
1
Locate the VMware Performance Agent’s Data Collection Scheduler properties.
2
Set the Data Collection Scheduler properties as follows:
a
Select a collection configuration list. You can select or clone an existing collection configuration list, and edit it, as required.
b
Add, remove, or edit collectors in the list.
c
For each collector, set its properties as follows:
•
Collector Name: The name of the collector. A collector is a component that captures specific type of metrics. Existing collectors are: Relationship And Hierarchy Data, Inventory Entity Properties, Performance Metrics, and Events Collection.
•
Default Collection Interval: Contains the length of the default collection interval. The default collection intervals for the existing collectors are:
Relationship and Hierarchy: 2 minutes
Inventory Entity Properties: 5 minutes
Performance Metrics: 5 minutes
Events Collection: 3 minutes
•
Time Unit: Contains the time unit for measuring the default collection interval: milliseconds, seconds, minutes, hours, or days.
•
Fast-Mode Collection Interval: Contains the length of the collection interval when the agent is running in fast mode.
•
Fast-Mode Time Unit: Contains the length of the collection interval when the agent is running in fast mode.
•
Fast-Mode Max Count: Contains the maximum count of entries when the agent is running in fast mode.

Upgrading Foglight for VMware

The latest version of Foglight for VMware is 5.7.3. For complete information about the upgrade procedure, refer to the Foglight Upgrade Guide.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating