[inputs.vsphere] Resolved issue 4790 (Resource whitelisting)

plugins/inputs/vsphere/README.md

@@ -27,6 +27,7 @@ vm_metric_exclude = [ "*" ]
 
   ## VMs
   ## Typical VM metrics (if omitted or empty, all metrics are collected)
+  # vm_include = [ "/*/vm/**"] # Inventory path to VMs to collect (by default all are collected)
   vm_metric_include = [
     "cpu.demand.average",
     "cpu.idle.summation",
@@ -68,6 +69,7 @@ vm_metric_exclude = [ "*" ]
 
   ## Hosts 
   ## Typical host metrics (if omitted or empty, all metrics are collected)
+  # host_include = [ "/*/host/**"] # Inventory path to hosts to collect (by default all are collected)
   host_metric_include = [
     "cpu.coreUtilization.average",
     "cpu.costop.summation",
@@ -120,16 +122,19 @@ vm_metric_exclude = [ "*" ]
   # host_instances = true ## true by default
 
   ## Clusters 
+  # cluster_include = [ "/*/host/**"] # Inventory path to clusters to collect (by default all are collected)
   # cluster_metric_include = [] ## if omitted or empty, all metrics are collected
   # cluster_metric_exclude = [] ## Nothing excluded by default
   # cluster_instances = false ## false by default 
 
   ## Datastores 
+  # cluster_include = [ "/*/datastore/**"] # Inventory path to datastores to collect (by default all are collected)
   # datastore_metric_include = [] ## if omitted or empty, all metrics are collected
   # datastore_metric_exclude = [] ## Nothing excluded by default
   # datastore_instances = false ## false by default 
 
   ## Datacenters
+  # datacenter_include = [ "/*/host/**"] # Inventory path to clusters to collect (by default all are collected)
   datacenter_metric_include = [] ## if omitted or empty, all metrics are collected
   datacenter_metric_exclude = [ "*" ] ## Datacenters are not collected by default.
   # datacenter_instances = false ## false by default 
@@ -196,6 +201,48 @@ For setting up concurrency, modify `collect_concurrency` and `discover_concurren
   # discover_concurrency = 1
 ```
 
+### Inventory Paths
+Resources to be monitored can be selected using Inventory Paths. This treats the vSphere inventory as a tree structure similar
+to a file system. A vSphere inventory has a structure similar to this:
+
+```
+<root>
++-DC0 # Virtual datacenter
+   +-datastore # Datastore folder (created by system)
+   | +-Datastore1
+   +-host # Host folder (created by system)
+   | +-Cluster1
+   | | +-Host1
+   | | | +-VM1
+   | | | +-VM2
+   | | | +-hadoop1
+   | +-Host2 # Dummy cluster created for non-clustered host
+   | | +-Host2
+   | | | +-VM3
+   | | | +-VM4
+   +-vm # VM folder (created by system)
+   | +-VM1
+   | +-VM2
+   | +-Folder1
+   | | +-hadoop1
+   | | +-NestedFolder1
+   | | | +-VM3
+   | | | +-VM4
+```
+
+#### Using Inventory Paths
+Using familiar UNIX-style paths, one could select e.g. VM2 with the path ```/DC0/vm/VM2```.
+
+Often, we want to select a group of resource, such as all the VMs in a folder. We could use the path ```/DC0/vm/Folder1/*``` for that. 
+
+Another possibility is to select objects using a partial name, such as ```/DC0/vm/Folder1/hadoop*``` yielding all vms in Folder1 with a name starting with "hadoop".
+
+Finally, due to the arbitrary nesting of the folder structure, we need a "recursive wildcard" for traversing multiple folders. We use the "**" symbol for that. If we want to look for a VM with a name starting with "hadoop" in any folder, we could use the following path: ```/DC0/vm/**/hadoop*```
+
+#### Multiple paths to VMs
+As we can see from the example tree above, VMs appear both in its on folder under the datacenter, as well as under the hosts. This is useful when you like to select VMs on a specific host. For example, ```/DC0/host/Cluster1/Host1/hadoop*``` selects all VMs with a name starting with "hadoop" that are running on Host1. 
+
+We can extend this to looking at a cluster level: ```/DC0/host/Cluster1/*/hadoop*```. This selects any VM matching "hadoop*" on any host in Cluster1.
 ## Performance Considerations
 
 ### Realtime vs. historical metrics

plugins/inputs/vsphere/client.go

@@ -74,7 +74,7 @@ func (cf *ClientFactory) GetClient(ctx context.Context) (*Client, error) {
 	ctx1, cancel1 := context.WithTimeout(ctx, cf.parent.Timeout.Duration)
 	defer cancel1()
 	if _, err := methods.GetCurrentTime(ctx1, cf.client.Client); err != nil {
-		log.Printf("I! [input.vsphere]: Client session seems to have time out. Reauthenticating!")
+		log.Printf("I! [inputs.vsphere]: Client session seems to have time out. Reauthenticating!")
 		ctx2, cancel2 := context.WithTimeout(ctx, cf.parent.Timeout.Duration)
 		defer cancel2()
 		if cf.client.Client.SessionManager.Login(ctx2, url.UserPassword(cf.parent.Username, cf.parent.Password)) != nil {
@@ -102,7 +102,7 @@ func NewClient(ctx context.Context, u *url.URL, vs *VSphere) (*Client, error) {
 		u.User = url.UserPassword(vs.Username, vs.Password)
 	}
 
-	log.Printf("D! [input.vsphere]: Creating client: %s", u.Host)
+	log.Printf("D! [inputs.vsphere]: Creating client: %s", u.Host)
 	soapClient := soap.NewClient(u, tlsCfg.InsecureSkipVerify)
 
 	// Add certificate if we have it. Use it to log us in.
@@ -173,9 +173,9 @@ func NewClient(ctx context.Context, u *url.URL, vs *VSphere) (*Client, error) {
 	if err != nil {
 		return nil, err
 	}
-	log.Printf("D! [input.vsphere] vCenter says max_query_metrics should be %d", n)
+	log.Printf("D! [inputs.vsphere] vCenter says max_query_metrics should be %d", n)
 	if n < vs.MaxQueryMetrics {
-		log.Printf("W! [input.vsphere] Configured max_query_metrics is %d, but server limits it to %d. Reducing.", vs.MaxQueryMetrics, n)
+		log.Printf("W! [inputs.vsphere] Configured max_query_metrics is %d, but server limits it to %d. Reducing.", vs.MaxQueryMetrics, n)
 		vs.MaxQueryMetrics = n
 	}
 	return client, nil
@@ -199,7 +199,7 @@ func (c *Client) close() {
 		defer cancel()
 		if c.Client != nil {
 			if err := c.Client.Logout(ctx); err != nil {
-				log.Printf("E! [input.vsphere]: Error during logout: %s", err)
+				log.Printf("E! [inputs.vsphere]: Error during logout: %s", err)
 			}
 		}
 	})
@@ -228,7 +228,7 @@ func (c *Client) GetMaxQueryMetrics(ctx context.Context) (int, error) {
 			if s, ok := res[0].GetOptionValue().Value.(string); ok {
 				v, err := strconv.Atoi(s)
 				if err == nil {
-					log.Printf("D! [input.vsphere] vCenter maxQueryMetrics is defined: %d", v)
+					log.Printf("D! [inputs.vsphere] vCenter maxQueryMetrics is defined: %d", v)
 					if v == -1 {
 						// Whatever the server says, we never ask for more metrics than this.
 						return absoluteMaxMetrics, nil
@@ -239,17 +239,17 @@ func (c *Client) GetMaxQueryMetrics(ctx context.Context) (int, error) {
 			// Fall through version-based inference if value isn't usable
 		}
 	} else {
-		log.Println("D! [input.vsphere] Option query for maxQueryMetrics failed. Using default")
+		log.Println("D! [inputs.vsphere] Option query for maxQueryMetrics failed. Using default")
 	}
 
 	// No usable maxQueryMetrics setting. Infer based on version
 	ver := c.Client.Client.ServiceContent.About.Version
 	parts := strings.Split(ver, ".")
 	if len(parts) < 2 {
-		log.Printf("W! [input.vsphere] vCenter returned an invalid version string: %s. Using default query size=64", ver)
+		log.Printf("W! [inputs.vsphere] vCenter returned an invalid version string: %s. Using default query size=64", ver)
 		return 64, nil
 	}
-	log.Printf("D! [input.vsphere] vCenter version is: %s", ver)
+	log.Printf("D! [inputs.vsphere] vCenter version is: %s", ver)
 	major, err := strconv.Atoi(parts[0])
 	if err != nil {
 		return 0, err