Skip to content

Commit

Permalink
[Docs] vSphere Autodiscovery (#5168)
Browse files Browse the repository at this point in the history 
* [Docs] vSphere Autodiscovery

* Update vsphere/README.md

Co-Authored-By: sarina-dd <57639676+sarina-dd@users.noreply.github.com>

* update for comments

* update mainfest

Co-authored-by: sarina-dd <57639676+sarina-dd@users.noreply.github.com>
  • Loading branch information
@ruthnaebeck @sarina-dd
ruthnaebeck and sarina-dd authored Dec 23, 2019
1 parent 57f67fa commit bb6d0ed
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions vsphere/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@
This check collects resource usage metrics from your vSphere cluster-CPU, disk, memory, and network usage. It also watches your vCenter server for events and emits them to Datadog.

## Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates][11] for guidance on applying these instructions.

### Installation

The vSphere check is included in the [Datadog Agent][2] package, so you don't need to install anything else on your vCenter server.
Expand Down Expand Up @@ -50,16 +47,16 @@ The following scenarios are possible when using the vSphere integration:

#### Configuration Options

| Options | Required | Description |
|---------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `ssl_verify` | No | Set to false to disable SSL verification, when connecting to vCenter. |
| `ssl_capath` | No | Set to the absolute file path of a directory containing CA certificates in PEM format. |
| `host_include_only_regex` | No | Use a regex like this if you want the check to only fetch metrics for these ESXi hosts and the VMs running on it. |
| `vm_include_only_regex` | No | Use a regex to include only the VMs that are matching this pattern. |
| `include_only_marked` | No | Set to true if you'd like to only collect metrics on vSphere VMs which are marked by a custom field with the value 'DatadogMonitored'. To set this custom field, you can use the UI to apply a tag or through the CLI with [PowerCLI][6] An example working on VSphere 5.1 is: `Get-VM VM | Set-CustomField -Name "DatadogMonitored" -Value "DatadogMonitored"`.|
| `collection_level` | No | A number between 1 and 4 to specify how many metrics are sent, 1 meaning only important monitoring metrics and 4 meaning every metric available. |
| `all_metrics` | No | (Deprecated) When set to true, this collects EVERY metric from vCenter, which means a LOT of metrics. When set to false, this collects a subset of metrics we selected that are interesting to monitor |
| `event_config` | No | Event config is a dictionary. For now the only switch you can flip is `collect_vcenter_alarms` which sends the alarms set in vCenter as events. |
| Options | Required | Description |
|---------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `ssl_verify` | No | Set to false to disable SSL verification, when connecting to vCenter. |
| `ssl_capath` | No | Set to the absolute file path of a directory containing CA certificates in PEM format. |
| `host_include_only_regex` | No | Use a regex like this if you want the check to only fetch metrics for these ESXi hosts and the VMs running on it. |
| `vm_include_only_regex` | No | Use a regex to include only the VMs that are matching this pattern. |
| `include_only_marked` | No | Set to true if you'd like to only collect metrics on vSphere VMs which are marked by a custom field with the value 'DatadogMonitored'. To set this custom field, you can use the UI to apply a tag or through the CLI with [PowerCLI][6] An example working on VSphere 5.1 is: `Get-VM VM | Set-CustomField -Name "DatadogMonitored" -Value "DatadogMonitored"`. |
| `collection_level` | No | A number between 1 and 4 to specify how many metrics are sent, 1 meaning only important monitoring metrics and 4 meaning every metric available. |
| `all_metrics` | No | (Deprecated) When set to true, this collects EVERY metric from vCenter, which means a LOT of metrics. When set to false, this collects a subset of metrics we selected that are interesting to monitor |
| `event_config` | No | Event config is a dictionary. For now the only switch you can flip is `collect_vcenter_alarms` which sends the alarms set in vCenter as events. |

### Validation

Expand Down Expand Up @@ -93,7 +90,7 @@ This check watches vCenter's Event Manager for events and emits them to Datadog.

### Service Checks

`vcenter.can_connect`:
**vcenter.can_connect**:<br>
Returns CRITICAL if the Agent cannot connect to vCenter to collect metrics, otherwise OK.

## Troubleshooting
Expand All @@ -114,4 +111,3 @@ See our [blog post][10] on monitoring vSphere environments with Datadog.
[8]: https://github.com/DataDog/integrations-core/blob/master/vsphere/metadata.csv
[9]: https://docs.datadoghq.com/integrations/faq/can-i-limit-the-number-of-vms-that-are-pulled-in-via-the-vmware-integration
[10]: https://www.datadoghq.com/blog/unified-vsphere-app-monitoring-datadog/#auto-discovery-across-vm-and-app-layers
[11]: https://docs.datadoghq.com/agent/autodiscovery/integrations

0 comments on commit bb6d0ed

Please sign in to comment.