Overview

This check collects CPU, memory, storage, and I/O performance metrics from your Nutanix clusters, hosts, and VMs. It also collects operational activity data from Prism Central, including events, tasks, audits, and alerts.

Setup

Installation

The Nutanix check is included in the Datadog Agent package, so you don’t need to install anything else on your server.

Configuration

1. In Prism Central, create a user with the Prism Viewer role.
2. Edit the nutanix.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample nutanix.d/conf.yaml for all available configuration options.
3. Restart the Agent to start sending Nutanix metrics and activity data to Datadog.

A single Agent instance connected to Prism Central monitors all clusters, hosts, and VMs managed by that Prism Central.

Note: The default collection interval is 120 seconds. In practice, setting the interval to 60 seconds or higher results in more reliable and consistent metric collection.

Validation

Run the Agent’s status subcommand and look for nutanix under the Checks section.

Data Collected

Metrics

The integration collects metrics across three resource types, each prefixed with its resource name:

• Cluster (nutanix.cluster.*): Storage capacity and usage, CPU and memory allocation, I/O performance, health score, VM counts
• Host (nutanix.host.*): Per-host CPU, memory, storage, and controller I/O metrics
• VM (nutanix.vm.*): Per-VM CPU, memory, disk, network, and storage tier metrics

A nutanix.health.up metric reports Prism Central connectivity status (1 for reachable, 0 otherwise).

Collecting activity data

The integration collects operational activity data from Prism Central by default. Each activity type can be toggled independently in the nutanix.d/conf.yaml file:

• collect_events: Prism Central events (default: true)
• collect_alerts: Alerts with severity information (default: true)
• collect_tasks: Infrastructure tasks, parent tasks only (default: true)
  • collect_subtasks: Include subtasks alongside parent tasks (default: false)
• collect_audits: User audit logs (default: true)

Events

This check collects activity data from Prism Central and emits it as Datadog events. Each activity type is identified by the ntnx_type tag:

• ntnx_type:event: Prism Central events
• ntnx_type:alert: Prism Central alerts
• ntnx_type:task: Prism Central tasks
• ntnx_type:audit: Prism Central audits

Use the collect_events, collect_alerts, collect_tasks, and collect_audits parameters in the sample nutanix.d/conf.yaml to toggle each activity type.

Note: By default, only parent tasks are collected. Set collect_subtasks: true to include subtasks.

Service Checks

The integration does not emit any service checks.

Troubleshooting

VM collection

By default, the integration only collects VMs with powerState: ON. To collect VMs in other power states (OFF, PAUSED), add an explicit powerState VM filter in resource_filters:

resource_filters:
  - resource: vm
    property: powerState
    patterns:
      - '.*'

Other VM filters (e.g., by name) do not override this default. Only a powerState filter does.

Category tags

Nutanix categories are attached as tags to metrics. By default, the integration only collects USER category tags. To include SYSTEM or INTERNAL categories, add an explicit category filter in resource_filters.

To collect SYSTEM and INTERNAL categories alongside USER:

resource_filters:
  - resource: category
    property: type
    patterns:
      - '^SYSTEM$'
      - '^INTERNAL$'
      - '^USER$'

Category tags use the Nutanix category key as the tag name (e.g., Environment:Production). Set prefix_category_tags: true to prefix them with ntnx_ (e.g., ntnx_Environment:Production) to avoid collisions with existing Datadog tags.

Duplicate hostnames

The Nutanix API does not expose the real hostname of VMs. VM metrics use the VM name from Prism Central as the hostname. If the Datadog Agent is installed on a Nutanix VM, its auto-detected hostname may differ from the VM name, causing duplicate hosts in Datadog. To fix this, set hostname in datadog.yaml (or the DD_HOSTNAME environment variable) to match the VM name in Prism Central.

Filtering resources

Use the resource_filters option to control which resources are collected. Each filter requires a resource type, a property (the API field name to match against), and a list of regex patterns. Optionally, set type (include or exclude, default: include). Exclude filters take precedence over include filters.

Supported resource types: cluster, host, vm, event, task, alert, audit, category. Nested properties are supported using / as a separator (e.g., userReference/name). Note: Hosts use hostName as the API field for the host name, not name.

resource_filters:
  - resource: cluster
    property: name
    patterns:
      - '^prod-'
  - resource: host
    property: hostName
    type: exclude
    patterns:
      - '^standby-'
  - resource: alert
    property: severity
    patterns:
      - '^WARNING$'
      - '^CRITICAL$'

Need help? Contact Datadog support.