vcsa

README

vCenter Server Appliance monitoring with Netdata

The vCenter Server Appliance using Health API is a preconfigured Linux virtual machine, which is optimized for running VMware vCenter Server® and the associated services on Linux.

This module collects health statistics from one or more vCenter Server Appliance servers, depending on your configuration.

Requirements

• vSphere 6.5+

Charts

• Overall System Health in status
• Components Health in status
• Software Updates Health in status

Health statuses

Overall System Health:

Numeric	Text	Description
-1	unknown	Module failed to decode status.
0	green	All components in the appliance are healthy.
1	yellow	One or more components in the appliance might become overloaded soon.
2	orange	One or more components in the appliance might be degraded.
3	red	One or more components in the appliance might be in an unusable status and the appliance might become unresponsive soon.
4	gray	No health data is available.

Components Health:

Numeric	Text	Description
-1	unknown	Module failed to decode status.
0	green	The component is healthy.
1	yellow	The component is healthy, but may have some problems.
2	orange	The component is degraded, and may have serious problems.
3	red	The component is unavailable, or will stop functioning soon.
4	gray	No health data is available.

Software Updates Health:

Numeric	Text	Description
-1	unknown	Module failed to decode status.
0	green	No updates available.
2	orange	Non-security patches might be available.
3	red	Security patches might be available.
4	gray	An error retrieving information on software updates.

Configuration

Edit the go.d/vsca.conf configuration file using edit-config from the your agent's config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/vsca.conf

Needs only url, username and password. Here is an example for 2 servers:

jobs:
  - name: vcsa1
    url: https://203.0.113.0
    username: admin@vsphere.local
    password: somepassword

  - name: vcsa2
    url: https://203.0.113.10
    username: admin@vsphere.local
    password: somepassword

For all available options please see module configuration file.

Troubleshooting

Check the module debug output. Run the following command as netdata user:

./go.d.plugin -d -m vcsa

Documentation

Index

• type Charts
• type Config
• type Dims
• type VCSA
  • func New() *VCSA
  • func (vc VCSA) Charts() *module.Charts
  • func (vc *VCSA) Check() bool
  • func (vc VCSA) Cleanup()
  • func (vc *VCSA) Collect() map[string]int64
  • func (vc *VCSA) Init() bool

Types

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Config

type Config struct {
	web.HTTP `yaml:",inline"`
}

Config is the VCSA module configuration.

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims

type VCSA

type VCSA struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

VCSA VCSA module.

func New

func New() *VCSA

New creates VCSA with default values.

func (VCSA) Charts

func (vc VCSA) Charts() *module.Charts

Charts returns Charts.

func (*VCSA) Check

func (vc *VCSA) Check() bool

Check makes check.

func (VCSA) Cleanup

func (vc VCSA) Cleanup()

Cleanup makes cleanup.

func (*VCSA) Collect

func (vc *VCSA) Collect() map[string]int64

Collect collects metrics.

func (*VCSA) Init

func (vc *VCSA) Init() bool

Init makes initialization.