StackState Self-hosted v5.0.x
This page describes StackState version 5.0.
The VMWare vSphere StackPack is used to create a near real-time synchronization with VMWare vSphere. This StackPack provides functionality that allows monitoring of the following resources:
The VMware StackPack collects all topology data for the components and relations between them as well as telemetry and events.
- StackState Agent V2 connects to the configured VMWare vSphere instance:
- Topology data and tags are retrieved for the configured resources.
- Metrics data is retrieved for the configured resources.
- The Agent watches the vCenter Event Manager for events related to the configured resources.
- StackState Agent V2 pushes retrieved data and events to StackState:
- Tags defined in VMWare vSphere are added to components and relations in StackState. Any defined StackState tags are used by StackState when the topology is retrieved.
To set up the StackState VMWare vSphere integration, you need to have:
- StackState Agent V2 installed on a single machine with HTTPS connection to both vSphere vCenter and StackState.
- A running vSphere vCenter instance.
The VMWare vSphere StackPack can be installed from the StackState UI StackPacks > Integrations screen. You will need to provide the following parameters:
- VSphere Host Name - The VMWare vSphere host name from which data will be collected.
To enable the VMWare vSphere check and begin collecting data from your vSphere vCenter instance:
- 1.Edit the Agent integration configuration file
/etc/stackstate-agent/conf.d/vsphere.d/conf.yamlto include details of your vSphere vCenter instance:
- name - aA unique key representing your vCenter instance.
- host - The same as the
VSphere Host Nameused when the StackPack was installed.
- username - The username to use when connecting to VMWare vSphere.
- password - Use secrets management to store passwords outside of the configuration file.# Section used for global vsphere check configinit_config:instances:- name: <name> # for example main-vcenterhost: <host_name> # for example vcenter.domain.comusername: <username>password: <password>
- 4.Once the Agent has restarted, wait for the Agent to collect the data and send it to StackState.
The advanced configuration items described below can optionally be added to the VMWare vSphere check configuration file. Further details can be found in the example configuration file (github.com).
Specify the metrics to retrieve using a data collection level (docs.vmware.com) (a number between 1 and 4). Note that when using both
The absolute file path of a directory containing CA certificates in PEM format.
Use a regex pattern to only fetch metrics for these ESXi hosts and the VMs running on them.
Use a regex to include only VMs that match the specified pattern.
To check the status of the VMWare vSphere integration, run the status subcommand and look for vSphere under
sudo stackstate-agent status
The VMWare vSphere integration retrieves the following data:
VMWare vSphere events are sent to StackState in a telemetry stream. These can be mapped to components and relations in the StackState topology, however, they will not be visible in the StackState Events Perspective.
The VMWare vSphere check watches the vCenter Event Manager for the events listed below and makes these available in StackState in the generic events topic telemetry stream:
- TaskEvent:Initialize powering On
- TaskEvent:Power Off virtual machine
- TaskEvent:Power On virtual machine
- TaskEvent:Reconfigure virtual machine
- TaskEvent:Relocate virtual machine
- TaskEvent:Suspend virtual machine
- TaskEvent:Migrate virtual machine
The metrics retrieved from VMWare vSphere can be configured in the Agent check configuration file using the configuration items collection_level and all_metrics. For details see the section advanced configuration of the VMWare vSphere check (above) and the vmware docs on Data Collection Levels (docs.vmware.com).
All tags defined in VMWare vSphere will be retrieved and added to the associated components and relations in StackState.
The VMWare vSphere integration also understands StackState common tags. These StackState tags can be assigned to elements in VMWare vSphere to influence the way that the resulting topology is built in StackState. For example, by placing a component in a specific layer or domain.
The VMWare vSphere integration retrieves the following topology data:
The VMWare vSphere integration understands StackState common tags. These StackState tags can be assigned to elements in VMWare vSphere to influence the way that the resulting topology is built in StackState. For example, by placing a component in a specific layer or domain.
The VMWare vSphere integration does not retrieve any traces data.
The VMWare vSphere integration connects to VMWare vSphere using the VMWare vSphere client library and Python modules
pyVmomi. No API endpoints are used.
The code for the StackState VMware vSphere check is open source and available on GitHub at:
To uninstall the VMWare vSphere StackPack and disable the VMWare vSphere check:
- 1.Go to the StackState UI StackPacks > Integrations > VMWare vSphere screen and click UNINSTALL.
- All VMWare vSphere specific configuration will be removed from StackState.
- 2.Remove or rename the Agent integration configuration file, for example:mv vsphere.d/conf.yaml vsphere.d/conf.yaml.bak
VMWare vSphere StackPack v2.3.3 (2022-06-03)
- Improvement: Updated documentation
VMWare vSphere StackPack v2.3.2 (2022-04-20)
- Improvement: Added collection level setting info.
VMWare vSphere StackPack v2.3.1 (2021-04-12)
- Improvement: Common bumped from 2.5.0 to 2.5.1