openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
15f7be9a526d209fb7f0940cbf6b8e7cc481c0dd
deb-python-pyvmomi/docs/vim/PerformanceManager.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

21 KiB
Raw Blame History

vim.PerformanceManager

This managed object type provides the service interface for obtaining statistical data about various aspects of system performance, as generated and maintained by the system's performance providers. A "performance provider" ( PerfProviderSummary ) is any managed object that generates utilization or other performance metrics. Performance providers include managed entities , such as hosts , virtual machines , compute resources , resource pools , datastores , and networks . Performance providers also include physical or virtual devices associated with these objects, such as virtual host-bus adapters and network-interface controllers (NICs)Performance CountersEach performance providerthe instrumented device or entityhas its own set of counters that provides metadata about its available metrics . Each counter has a unique key , referred to as the counterId. The actual performance metrics generated at runtime are identified by this counterId . Counters are organized by groups of finite system resources, such as memory , CPU , disk , and so on. The links in this list contain documentation for performance counters, by group . Each page contains a table that includes data extracted from instances of the PerfCounterInfo data object, including the counter name, its Label, Unit, StatsType, RollupType, and Level:

Attributes

description (vim.PerformanceDescription):
privilege: System.View

The static description strings.

historicalInterval (vim.HistoricalInterval):
privilege: System.View

A list of intervals configured on the system.

perfCounter (vim.PerformanceManager.CounterInfo):
privilege: System.View

A list of all supported performance counters in the system.

Methods

QueryPerfProviderSummary(entity):

Retrieves the PerfProviderSummary data object that defines the capabilities of the specified managed object with respect to statistics, such as whether it supports current or summary statistics

Privilege:

System.Read

Args:
entity (vmodl.ManagedObject):

Reference to a managed object that provides performance data. If the entity specified by managed object reference is not a performance provider, an "InvalidArgument" exception is thrown.

Returns:
vim.PerformanceManager.ProviderSummary:

A data object containing metadata about the entity as a performance provider, such as the type of metrics (real-time, summary, or both) it generates and the refreshRate .

QueryAvailablePerfMetric(entity, beginTime, endTime, intervalId):

Retrieves all performance counters for the specified managed object generated during a specified period of time. The time period can be specified using beginTime, endTime, or by interval ID.

Privilege:

System.Read

Args:
entity (vmodl.ManagedObject):

The managed object that provides performance metrics.

beginTime (datetime, optional):

Starting time (server time) for a period of time from which to return available metrics. If not specified, defaults to oldest available metric for the specified entity.

endTime (datetime, optional):

Ending time (server time) for a period of time from which to return available performance metrics. If not specified, defaults to the most recently generated metric for the specified entity.

intervalId (int, optional):
Period of time from which to retrieve metrics, defined by intervalId (rather than beginTime or endTime). Valid intervalIds include:
Returns:
vim.PerformanceManager.MetricId:

An array of metrics, each of which comprises a counterId and an name .

Raises:

vmodl.fault.InvalidArgument:

if the set of arguments passed to the function is not specified correctly.

QueryPerfCounter(counterId):

Retrieves counter information for the specified list of counter IDs.

Privilege:

System.View

Args:
counterId (int):

An array of one or more counterIds representing performance counters for which information is being retrieved.

Returns:
vim.PerformanceManager.CounterInfo:

An array consisting of performance counter information for the specified counterIds.

Raises:

vmodl.fault.InvalidArgument:

if the set of arguments passed to the function is not specified correctly.

QueryPerfCounterByLevel(level):

Retrieves the set of counters that are available at a specified collection level . The collection level determines the statistics that get stored in VirtualCenter. See PerfInterval for more information about VirtualCenter Server historical statistics collection. since: VI API 2.5

Privilege:

System.View

Args:
level (int):

A number between 1 and 4 that specifies the collection level.

Returns:
vim.PerformanceManager.CounterInfo:

An array of PerfCounterInfo objects that define the set of counters having the specified level number available for the entity.

Raises:

vmodl.fault.InvalidArgument:

if an invalid level is specified.

QueryPerf(querySpec):

Retrieves the performance metrics for the specified entity (or entities) based on the properties specified in the PerfQuerySpec data object.Query Performance for VirtualCenter Server

Privilege:

System.View

Args:
querySpec (vim.PerformanceManager.QuerySpec):

An array of PerfQuerySpec objects. Each PerfQuerySpec object specifies a managed object reference for an entity, plus optional criteria for filtering results. Only metrics for entities that can be resolved and that are valid performance providers are returned in any result.Each PerfQuerySpec object in the array submitted in this operation can query for different metrics. Or, select all types of statistics for a single managed entity.Raw data feed workaround: Normally, QueryPerf will return performance statistics stored in the VirtualCenter database. However this may not be suitable for certain applications. For example, applications that treat VirtualCenter as a raw data source, query for performance statistics regularly (say every 5 minutes) and extract the data for external archival and reporting. Such applications need better query performance. These applications should query statistics using QueryPerf for the base historical interval (5 minutes by default) having a start and end time range within 30 minutes from the current VirtualCenter server system time. These QueryPerf calls will have better performance than other QueryPerf calls.

Returns:
vim.PerformanceManager.EntityMetricBase:

The metric values for the specified entity or entities.

Raises:

vmodl.fault.InvalidArgument:

if the set of arguments passed to the function is not specified correctly.

QueryPerfComposite(querySpec):

Retrieves a PerfCompositeMetric data object that comprises statistics for the specified entity and its children entities. Only metrics for the first level of descendents are included in the PerfCompositeMetric object.Use this operation to obtain statistics for a host and its associated virtual machines , for example.Requiressystem.readprivilege for every virtual machine on the target host, or the query fails with theNoPermissionfault. Suported for HostSystem managed entities only.

Privilege:

System.View

Args:
querySpec (vim.PerformanceManager.QuerySpec):

A PerfQuerySpec object specifying the query parameters. This PerfQuerySpec object specifies a managed object for which composite statistics should be retrieved, with specific optional criteria for filtering the results.This PerfQuerySpec requires a valid metricId property that specifies a metric that is available, in common, to the entity and its children. If the specified metricId is not available to the entity and its children, it is ignored.

Returns:
vim.PerformanceManager.CompositeEntityMetric:

The metric values for the specified entity and its associated entities for a single interval.

Raises:

vmodl.fault.InvalidArgument:

if the set of arguments passed to the function is not specified correctly.

CreatePerfInterval(intervalId):

Adds a new historical interval. Sampling period for new interval must be a multiple of an existing interval; must comprise a longer period of time; and must be uniquely named.

Privilege:

Performance.ModifyIntervals

Args:
intervalId (vim.HistoricalInterval):

A custom interval, specified as the number of seconds to hold data in the database, a user-specified unique name, and a sampling period (in seconds).

Returns:

None

Raises:

vmodl.fault.InvalidArgument:

if the set of arguments passed to the function is not specified correctly.

RemovePerfInterval(samplePeriod):

Removes an interval from the list.

Privilege:

Performance.ModifyIntervals

Args:
samplePeriod (int):

The sampling period, in seconds, for the specified interval being removed.

Returns:

None

Raises:

vmodl.fault.InvalidArgument:

if the set of arguments passed to the function is not specified correctly.

UpdatePerfInterval(interval):

Modifies VirtualCenter Server's built-in historical intervals , within certain limits.Supported ModificationskeysamplingPeriodlengthnamelevel [1]enabled [2]1300 [3]86400 [4]Pastday1true21800604800Pastweek1true372002592000Pastmonth1true46640031536000 [5]Pastyear1true[1]The collection level for the historical intervals can be changed. However, the level specified for a lower-numbered interval cannot be smaller than that of a larger interval.[2]An interval can be disabled. By default, all four intervals are enabled. Disabling an interval disables all higher intervals. For example, disabling interval 3 (Past month) also disables interval 4 (Past year).[3]Can reduce this intervals samplingPeriod from 5 minutes to 1, 2, or 3 minutes.[4]Can increase this intervals length from 1 day to 2 or 3 days.[5]Can increase intervals length from 1 year to 2 or 3 years.See PerfInterval for information about the four default intervals for VirtualCenter Server.

Privilege:

Performance.ModifyIntervals

Args:
interval (vim.HistoricalInterval):

The historical interval being modified, a complete data object comprising values for enabled , interval ID , length of time to maintain statistics for this interval in the database, level , name , and samplingPeriod properties.

Returns:

None

Raises:

vmodl.fault.InvalidArgument:

if the set of arguments passed to the function is not specified correctly or if the update does not conform to the rules mentioned above.

UpdateCounterLevelMapping(counterLevelMap):
Changes the level of data collection for a set of performance counters. See the performance counter tables for the default collection level for individual counters.Important:Consider the performance and storage consequences of using this method. You may cause a significant increase in data collection and storage, along with a corresponding decrease in performance. vCenter Server performance and database storage requirements depend on the collection levels defined for the performance intervals (PerformanceManager. historicalInterval ) and the collection levels specified for individual performance counters ( PerfCounterInfo . level ).Performance Counter Data CollectionvSphere defines four levels of data collection for performance counters. Each performance counter specifies a level for collection. The historical performance intervals (PerformanceManager. historicalInterval ) define the sampling period and length for a particular collection level.The amount of data collected for a performance counter depends on the performance interval and on the type of entity for which the counter is defined. For example, a datastore counter such as datastoreIops (the aggregate number of IO operations on the datastore) will generate a data set that corresponds to the number of datastores on a host. If a vCenter Server manages a large number of hosts with a large number of datastores, the Server will collect a large amount of data.There are other counters for which the vCenter Server collects a relatively smaller amount of data. For example, memory counters are collected as a single counter per virtual machine and a single counter per host.Performance Counter Data StorageThe performance interval collection level defines the set of counters for which the vCenter Server stores performance data. The Server will store data for counters at the specified level and for counters at all lower levels.By default, all the performance intervals specify collection level one. Using these defaults, the vCenter Server stores performance counter data in the vCenter database for all counters that specify collection level one. It does not store data for counters that specify collection levels two through four.Performance Manager Method InteractionYou can use the UpdateCounterLevelMapping method to change the collection level for individual counters. You can also use the UpdatePerfInterval method to change the collection level for the system-defined performance intervals. These methods can cause a significant increase in the amount of data collected and stored in the vCenter database.You may cause a significant increase in data collection and storage along with a corresponding decrease in performance under the following conditions:
  • By default the system-defined performance intervals use collection level one, storing data for all counters that specify collection level one. If you use the UpdateCounterLevelMapping method to change the collection level of performance counters to level one, you will increase the amount of stored performance data.
  • If you use the
  • UpdatePerfInterval
  • method to increase the collection level for the system-defined performance intervals, you will increase the amount of stored performance data.To restore counter levels to default settings use the ResetCounterLevelMapping method.

since: vSphere API 4.1

Privilege:

Performance.ModifyIntervals

Args:
counterLevelMap (vim.PerformanceManager.CounterLevelMapping):

An array of PerformanceManagerCounterLevelMapping objects. The levels for the counters passed in are changed to the passed in values. If the optional aggregateLevel field is left unset then only the perDeviceLevel is configured. If the optional perDeviceLevel is left unset then only the aggregateLevel is configured. If there are multiple entries in the passed in array for the same counterId being updated then the last entry containing the counterId takes effect.

Returns:

None

Raises:

vmodl.fault.InvalidArgument:

If the passed in counterId is invalid or if both the aggregateLevel and perDeviceLevel are unset or if the aggregateLevel field is not between 1-4 (valid values).

vmodl.fault.NotSupported:

If called directly on a host.

ResetCounterLevelMapping(counters):

Restores a set of performance counters to the default level of data collection. See the performance counter tables for the default collection level for individual counters. since: vSphere API 4.1

Privilege:

Performance.ModifyIntervals

Args:
counters (int):

An array of counter ids.

Returns:

None

Raises:

vmodl.fault.InvalidArgument:

If the passed in counterId is invalid.

vmodl.fault.NotSupported:

If called directly on a host.