diff --git a/plugins/inputs/vsphere/README.md b/plugins/inputs/vsphere/README.md index f69bd2862..6f2e35029 100644 --- a/plugins/inputs/vsphere/README.md +++ b/plugins/inputs/vsphere/README.md @@ -8,7 +8,7 @@ The VMware vSphere plugin uses the vSphere API to gather metrics from multiple v * Datastores ## Supported versions of vSphere -This plugin supports vSphere version 5.5 through 6.7. +This plugin supports vSphere version 5.5 through 6.7. ## Configuration @@ -125,7 +125,7 @@ vm_metric_exclude = [ "*" ] ] ## Collect IP addresses? Valid values are "ipv4" and "ipv6" # ip_addresses = ["ipv6", "ipv4" ] - + # host_metric_exclude = [] ## Nothing excluded by default # host_instances = true ## true by default @@ -138,8 +138,8 @@ vm_metric_exclude = [ "*" ] # cluster_instances = false ## false by default ## Datastores - # cluster_include = [ "/*/datastore/**"] # Inventory path to datastores to collect (by default all are collected) - # cluster_exclude = [] # Inventory paths to exclude + # datastore_include = [ "/*/datastore/**"] # Inventory path to datastores to collect (by default all are collected) + # datastore_exclude = [] # Inventory paths to exclude # datastore_metric_include = [] ## if omitted or empty, all metrics are collected # datastore_metric_exclude = [] ## Nothing excluded by default # datastore_instances = false ## false by default @@ -167,11 +167,6 @@ vm_metric_exclude = [ "*" ] # collect_concurrency = 1 # discover_concurrency = 1 - ## whether or not to force discovery of new objects on initial gather call before collecting metrics - ## when true for large environments this may cause errors for time elapsed while collecting metrics - ## when false (default) the first collection cycle may result in no or limited metrics while objects are discovered - # force_discover_on_init = false - ## the interval before (re)discovering objects subject to metrics collection (default: 300s) # object_discovery_interval = "300s" @@ -185,17 +180,17 @@ vm_metric_exclude = [ "*" ] ## the plugin. Setting this flag to "false" will send values as floats to ## preserve the full precision when averaging takes place. # use_int_samples = true - + ## Custom attributes from vCenter can be very useful for queries in order to slice the ## metrics along different dimension and for forming ad-hoc relationships. They are disabled ## by default, since they can add a considerable amount of tags to the resulting metrics. To ## enable, simply set custom_attribute_exlude to [] (empty set) and use custom_attribute_include - ## to select the attributes you want to include. - # by default, since they can add a considerable amount of tags to the resulting metrics. To - # enable, simply set custom_attribute_exlude to [] (empty set) and use custom_attribute_include - # to select the attributes you want to include. + ## to select the attributes you want to include. + ## By default, since they can add a considerable amount of tags to the resulting metrics. To + ## enable, simply set custom_attribute_exlude to [] (empty set) and use custom_attribute_include + ## to select the attributes you want to include. # custom_attribute_include = [] - # custom_attribute_exclude = ["*"] # Default is to exclude everything + # custom_attribute_exclude = ["*"] ## Optional SSL Config # ssl_ca = "/path/to/cafile" @@ -264,7 +259,7 @@ to a file system. A vSphere inventory has a structure similar to this: #### 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. +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". diff --git a/plugins/inputs/vsphere/vsphere.go b/plugins/inputs/vsphere/vsphere.go index bc4042980..141b25599 100644 --- a/plugins/inputs/vsphere/vsphere.go +++ b/plugins/inputs/vsphere/vsphere.go @@ -75,6 +75,8 @@ var sampleConfig = ` ## 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_exclude = [] # Inventory paths to exclude vm_metric_include = [ "cpu.demand.average", "cpu.idle.summation", @@ -116,6 +118,8 @@ var sampleConfig = ` ## 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_exclude [] # Inventory paths to exclude host_metric_include = [ "cpu.coreUtilization.average", "cpu.costop.summation", @@ -164,27 +168,35 @@ var sampleConfig = ` "storageAdapter.write.average", "sys.uptime.latest", ] - ## Collect IP addresses? Valid values are "ipv4" and "ipv6" + ## Collect IP addresses? Valid values are "ipv4" and "ipv6" # ip_addresses = ["ipv6", "ipv4" ] + # host_metric_exclude = [] ## Nothing excluded by default # host_instances = true ## true by default + ## Clusters + # cluster_include = [ "/*/host/**"] # Inventory path to clusters to collect (by default all are collected) + # cluster_exclude = [] # Inventory paths to exclude # 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 + # datastore_include = [ "/*/datastore/**"] # Inventory path to datastores to collect (by default all are collected) + # datastore_exclude = [] # Inventory paths to exclude # datastore_metric_include = [] ## if omitted or empty, all metrics are collected # datastore_metric_exclude = [] ## Nothing excluded by default - # datastore_instances = false ## false by default for Datastores only + # datastore_instances = false ## false by default ## Datacenters + # datacenter_include = [ "/*/host/**"] # Inventory path to clusters to collect (by default all are collected) + # datacenter_exclude = [] # Inventory paths to exclude 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 for Datastores only + # datacenter_instances = false ## false by default - ## Plugin Settings + ## Plugin Settings ## separator character to use for measurement and field names (default: "_") # separator = "_" @@ -219,8 +231,11 @@ var sampleConfig = ` ## by default, since they can add a considerable amount of tags to the resulting metrics. To ## enable, simply set custom_attribute_exlude to [] (empty set) and use custom_attribute_include ## to select the attributes you want to include. + ## By default, since they can add a considerable amount of tags to the resulting metrics. To + ## enable, simply set custom_attribute_exlude to [] (empty set) and use custom_attribute_include + ## to select the attributes you want to include. # custom_attribute_include = [] - # custom_attribute_exclude = ["*"] + # custom_attribute_exclude = ["*"] ## Optional SSL Config # ssl_ca = "/path/to/cafile"