LogoLogo
StackState.comDownloadSupportExplore playground
StackState v5.1
StackState v5.1
  • Welcome to the StackState docs!
  • StackState self-hosted v5.1 docs
  • Getting Started
  • 🚀Setup
    • Install StackState
      • Requirements
      • Kubernetes / OpenShift
        • Kubernetes install
        • OpenShift install
        • Required Permissions
        • Non-high availability setup
        • Override default configuration
        • Configure storage
        • Configure Ingress
        • Install from custom image registry
        • Migrate from Linux install
      • Linux
        • Before you install
        • Download
        • Install StackState
        • Install with production configuration
        • Install with development configuration
        • Install with POC configuration
        • Set up a reverse proxy
        • Set up TLS without reverse proxy
      • Initial run guide
      • Troubleshooting
    • Upgrade StackState
      • Steps to upgrade
      • Version specific upgrade instructions
      • StackPack versions
      • StackState release notes
    • StackState Agent
      • About StackState Agent V3
      • Docker
      • Kubernetes / OpenShift
      • Linux
      • Windows
      • Advanced Agent configuration
      • Use an HTTP/HTTPS proxy
      • Agent V1 (legacy)
      • Migrate Agent V1 to Agent V2
        • Linux
        • Docker
    • StackState CLI
      • CLI: sts
      • CLI: stac (deprecated)
      • Comparison between CLIs
    • Data management
      • Backup and Restore
        • Kubernetes backup
        • Linux backup
        • Configuration backup
      • Data retention
      • Clear stored data
  • 👤Use
    • Concepts
      • The 4T data model
      • Components
      • Relations
      • Health state
      • Layers, Domains and Environments
      • Perspectives
      • Anomaly detection
      • StackState architecture
    • StackState UI
      • Explore mode
      • Filters
      • Views
        • About views
        • Configure the view health
        • Create and edit views
        • Visualization settings
      • Perspectives
        • Topology Perspective
        • Events Perspective
        • Traces Perspective
        • Metrics Perspective
      • Timeline and time travel
      • Analytics
      • Keyboard shortcuts
    • Checks and monitors
      • Checks
      • Add a health check
      • Anomaly health checks
      • Monitors
      • Manage monitors
    • Problem analysis
      • About problems
      • Problem lifecycle
      • Investigate a problem
      • Problem notifications
    • Metrics
      • Telemetry streams
      • Golden signals
      • Top metrics
      • Add a telemetry stream
      • Browse telemetry
      • Set telemetry stream priority
    • Events
      • About events
      • Event notifications
      • Manage event handlers
    • Glossary
  • 🧩StackPacks
    • About StackPacks
    • Add-ons
      • Autonomous Anomaly Detector
      • Health Forecast
    • Integrations
      • About integrations
      • 💠StackState Agent V2
      • 💠AWS
        • AWS
        • AWS ECS
        • AWS X-ray
        • StackState/Agent IAM role: EC2
        • StackState/Agent IAM role: EKS
        • Policies for AWS
        • AWS (legacy)
        • Migrate AWS (legacy) to AWS
      • 💠Dynatrace
      • 💠Kubernetes
      • 💠OpenShift
      • 💠OpenTelemetry
        • About instrumentations
        • AWS NodeJS Instrumentation
        • Manual Instrumentation
          • Prerequisites
          • Tracer and span mappings
          • Relations between components
          • Span health state
          • Merging components
          • Code examples
      • 💠ServiceNow
      • 💠Slack
      • 💠Splunk
        • Splunk
        • Splunk Events
        • Splunk Health
        • Splunk Metrics
        • Splunk Topology
      • 💠VMWare vSphere
      • Apache Tomcat
      • Azure
      • Cloudera
      • Custom Synchronization
      • DotNet APM
      • Elasticsearch
      • Humio
      • Java APM
      • JMX
      • Logz.io
      • MySQL
      • Nagios
      • OpenMetrics
      • PostgreSQL
      • Prometheus
      • SAP
      • SCOM
      • SolarWinds
      • Static Health
      • Static Topology
      • Traefik
      • WMI
      • Zabbix
    • Develop your own StackPacks
  • 🔧Configure
    • Topology
      • Component actions
      • Identifiers
      • Topology naming guide
      • Topology sources
      • Create a topology manually
      • Configure topology synchronizations
      • Enable email event notifications
      • Send topology data over HTTP
      • Set the topology filtering limit
      • Use a proxy for event handlers
      • Use tags
      • Tune topology synchronization
      • Debug topology synchronization
    • Telemetry
      • Add telemetry during topology synchronization
      • Data sources
        • Elasticsearch
        • Prometheus mirror
      • Send events over HTTP
      • Send metrics data over HTTP
      • Set the default telemetry interval
      • Debug telemetry synchronization
    • Traces
      • Set up traces
      • Advanced configuration for traces
    • Health
      • Health synchronization
      • Send health data over HTTP
        • Send health data
        • Repeat Snapshots JSON
        • Repeat States JSON
        • Transactional Increments JSON
      • Debug health synchronization
    • Anomaly Detection
      • Export anomaly feedback
      • Scale the AAD up and down
      • The AAD status UI
    • Security
      • Authentication
        • Authentication options
        • File based
        • LDAP
        • Open ID Connect (OIDC)
        • KeyCloak
        • Service tokens
      • RBAC
        • Role-based Access Control
        • Permissions
        • Roles
        • Scopes
        • Subjects
      • Secrets management
      • Self-signed certificates
      • Set up a security backend for Linux
      • Set up a security backend for Windows
    • Logging
      • Kubernetes logs
      • Linux logs
      • Enable logging for functions
  • 📖Develop
    • Developer guides
      • Agent checks
        • About Agent checks
        • Agent check API
        • Agent check state
        • How to develop Agent checks
        • Connect an Agent check to StackState
      • Custom functions and scripts
        • StackState functions
        • Check functions
        • Component actions
        • Event handler functions
        • ID extractor functions
        • Mapping functions
        • Monitor functions
        • Propagation functions
        • Template functions
        • View health state configuration functions
      • Custom Synchronization StackPack
        • About the Custom Synchronization StackPack
        • How to customize elements created by the Custom Synchronization StackPack
        • How to configure a custom synchronization
      • Integrate external services
      • Mirroring Telemetry
      • Monitors
        • Create monitors
        • Monitor STJ file format
      • StackPack development
        • How to create a StackPack
        • Packaging
        • How to get a template file
        • How to make a multi-instance StackPack
        • Prepare a multi-instance provisioning script
        • Upload a StackPack file
        • Prepare a shared template
        • Customize a StackPack
        • Prepare instance template files
        • Prepare a StackPack provisioning script
        • Resources in a StackPack
        • StackState Common Layer
      • Synchronizations and templated files
    • Reference
      • StackState OpenAPI docs
      • StackState Template JSON (STJ)
        • Using STJ
        • Template functions
      • StackState Markup Language (STML)
        • Using STML
        • STML Tags
      • StackState Query Language (STQL)
      • StackState Scripting Language (STSL)
        • Scripting in StackState
        • Script result: Async
        • Script result: Streaming
        • Time in scripts
        • Script APIs
          • Async - script API
          • Component - script API
          • HTTP - script API
          • Prediction - script API
          • StackPack - script API
          • Telemetry - script API
          • Time - script API
          • Topology - script API
          • UI - script API
          • View - script API
    • Tutorials
      • Create a simple StackPack
      • Push data to StackState from an external system
      • Send events to StackState from an external system
      • Set up a mirror to pull telemetry data from an external system
Powered by GitBook
LogoLogo

Legal notices

  • Privacy
  • Cookies
  • Responsible disclosure
  • SOC 2/SOC 3
On this page
  • Overview
  • Setup
  • Prerequisites
  • Install
  • Configure
  • Status
  • Integration details
  • Data retrieved
  • REST API endpoints
  • Open source
  • Troubleshooting
  • Uninstall
  • Release notes
  • See also
  1. StackPacks
  2. Integrations

VMWare vSphere

StackState Self-hosted v5.1.x

PreviousSplunk TopologyNextApache Tomcat

Last updated 1 year ago

Overview

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:

  • Hosts

  • VirtualMachines

  • ComputeResources

  • ClusterComputeResources

  • DataStores

  • DataCenters

VMWare vSphere is a .

The VMware StackPack collects all topology data for the components and relations between them as well as telemetry and events.

  • StackState Agent V3 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 V3 pushes retrieved data and events to StackState:

Setup

Prerequisites

To set up the StackState VMWare vSphere integration, you need to have:

  • A running vSphere vCenter instance.

Install

The VMWare vSphere StackPack can be installed from the StackState UI StackPacks > Integrations screen. You will need to enter the following details:

  • VSphere Host Name - The VMWare vSphere host name from which data will be collected.

Configure

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.yaml to include details of your vSphere vCenter instance:

    • name - aA unique key representing your vCenter instance.

    • host - The same as the VSphere Host Name used when the StackPack was installed.

    • username - The username to use when connecting to VMWare vSphere.

    • # Section used for global vsphere check config
      init_config:
      
      instances:
      - name: <name> # for example main-vcenter
      
        host: <host_name> # for example vcenter.domain.com
      
        username: <username>
        password: <password>
  2. Once the Agent has restarted, wait for the Agent to collect the data and send it to StackState.

Advanced configuration

Options
Required?
Description

all_metrics

No

Default false. Set to true to collect every metric. This will collect a LOT of metrics that you probably don't need. When set to false (default), a selected set of metrics that are interesting to monitor will be collected. Note that when using both all_metrics and collection_level setting all_metrics will be ignored.

collection_level

No

ssl_verify

No

Set to false to disable SSL verification when connecting to vCenter.

ssl_capath

No

The absolute file path of a directory containing CA certificates in PEM format.

host_include_only_regex

No

Use a regex pattern to only fetch metrics for these ESXi hosts and the VMs running on them.

vm_include_only_regex

No

Use a regex to include only VMs that match the specified pattern.

include_only_marked

No

Set to true, if you would like to only collect metrics on vSphere VMs that are marked by a custom field with the value StackStateMonitored. To set this custom field with PowerCLI, use the command: `Get-VM

collect_vcenter_alarms

No

set to true to send vCenter alarms as events.

Status

To check the status of the VMWare vSphere integration, run the status subcommand and look for vSphere under Running Checks:

sudo stackstate-agent status

Integration details

Data retrieved

The VMWare vSphere integration retrieves the following data:

Events

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 won't 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:

  • AlarmStatusChangedEvent:Gray

  • VmBeingHotMigratedEvent

  • VmReconfiguredEvent

  • VmPoweredOnEvent

  • VmMigratedEvent

  • 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

  • VmMessageEvent

  • VmSuspendedEvent

  • VmPoweredOffEvent

Metrics

Tags

All tags defined in VMWare vSphere will be retrieved and added to the associated components and relations in StackState.

Topology

The VMWare vSphere integration retrieves the following topology data:

  • Components

  • Relations

Traces

The VMWare vSphere integration doesn't retrieve any traces data.

REST API endpoints

The VMWare vSphere integration connects to VMWare vSphere using the VMWare vSphere client library and Python modules pyvim and pyVmomi. No API endpoints are used.

Open source

The code for the StackState VMware vSphere check is open source and available on GitHub at:

Troubleshooting

Uninstall

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

Release notes

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

See also

is translated into components and relations.

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.

is automatically mapped to associated components and relations in StackState.

are available as a telemetry stream in StackState.

installed on a single machine with HTTPS connection to both vSphere vCenter and StackState.

password - Use to store passwords outside of the configuration file.

If required, you can customise the integration using the .

to publish the configuration changes.

The advanced configuration items described below can optionally be added to the VMWare vSphere check configuration file. Further details can be found in the .

Specify the metrics to retrieve using a (a number between 1 and 4). Note that when using both all_metrics and collection_level setting all_metrics will be ignored.

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 (above) and the vmware docs on .

The VMWare vSphere integration also understands StackState . 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 understands StackState . 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.

Troubleshooting steps for any known issues can be found in the .

to apply the configuration changes.

🧩
💠
StackState
secrets management
example configuration file (github.com)
https://github.com/StackVista/stackstate-agent-integrations/tree/master/vsphere
StackState support Knowledge base
StackState
Secrets management
StackState Agent integrations - VMWare vSphere (github.com)
Example VMWare vSphere check configuration file (github.com)
Data Collection Levels (docs.vmware.com)
Topology data
Tags
Metrics data
Events
advanced configuration options
Events
Metrics
Tags
Topology
Data Collection Levels (docs.vmware.com)
advanced configuration of the VMWare vSphere check
data collection level (docs.vmware.com)
StackState core integration
Restart StackState
Restart StackState
Data flow
common tags
common tags