> ## Documentation Index
> Fetch the complete documentation index at: https://otel.fyi/llms.txt
> Use this file to discover all available pages before exploring further.

# Nsxt

> OpenTelemetry receiver for Nsxt

# Nsxt Receiver

![Status](https://img.shields.io/badge/status-alpha-red)

**Available in:** `contrib`

**Maintainers:** [@dashpole](https://github.com/dashpole), [@schmikei](https://github.com/schmikei)

**Source:** [opentelemetry-collector-contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/nsxtreceiver)

## Supported Telemetry

![Metrics](https://img.shields.io/badge/metrics-alpha-green)

## Overview

> :construction: This receiver is in **ALPHA**. Configuration fields and metric data model are subject to change.

## Purpose

The purpose of this receiver is to allow users to monitor metrics from NSX-T environments.

## Prerequisites

Needs at least an “Auditor” user for NSX Manager Resources in the vSphere Client (can be created via Web UI or CLI)

The collector must be able to reach the NSX Manager with port 443 open.

This receiver supports NSX-T Datacenter versions:

* 3.2.0
* 3.1.2

## Configuration

* `endpoint`: Endpoint of the NSX Manager. Must be formatted as `{scheme}://{host}:{port}`. Schemes supported are `http` and `https`

* `username`: Username of the `Auditor` user

* `password`: Password of the `Auditor` user

* `collection_interval`: (default = `1m`): This receiver collects metrics on an interval. This value must be a string readable by Golang's [time.ParseDuration](https://pkg.go.dev/time#ParseDuration). Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.

* `initial_delay` (default = `1s`): defines how long this receiver waits before starting.

* `timeout`: (default = `1m`) The timeout of running commands against the NSX REST API.

* `metrics` (default: see DefaultMetricsSettings \[here])(./internal/metadata/generated\_metrics.go): Allows enabling and disabling specific metrics from being collected in this receiver.

### Example Configuration

```yaml theme={null}
receivers:
  nsxt:
    endpoint: https://nsx-manager
    username: admin
    password: password
    timeout: 60s
    metrics:
      nsxt.node.cpu.utilization:
        enabled: false

exporters:
  file:
    path: "./content.json"

service:
  pipelines:
    metrics:
      receivers: [nsxt]
      exporters: [file]
```

The full list of settings exposed for this receiver are documented in [config.go](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/nsxtreceiver/config.go) with detailed sample configurations in [testdata/config.yaml](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/nsxtreceiver/testdata/config.yaml).

## Metrics

Details about the metrics produced by this receiver can be found in [metadata.yaml](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/nsxtreceiver/metadata.yaml)

## Metrics

| Metric Name                          | Description                                                                        | Unit       | Type          | Attributes             |
| ------------------------------------ | ---------------------------------------------------------------------------------- | ---------- | ------------- | ---------------------- |
| ✅ `nsxt.node.cpu.utilization`        | The average amount of CPU being used by the node.                                  | %          | Gauge         | class                  |
| ✅ `nsxt.node.filesystem.usage`       | The amount of storage space used by the node.                                      | By         | UpDownCounter | disk\_state            |
| ✅ `nsxt.node.filesystem.utilization` | The percentage of storage space utilized.                                          | %          | Gauge         |                        |
| ✅ `nsxt.node.memory.cache.usage`     | The size of the node's memory cache.                                               | KBy        | UpDownCounter |                        |
| ✅ `nsxt.node.memory.usage`           | The memory usage of the node.                                                      | KBy        | UpDownCounter |                        |
| ✅ `nsxt.node.network.io`             | The number of bytes which have flowed through the network interface.               | By         | Counter       | direction              |
| ✅ `nsxt.node.network.packet.count`   | The number of packets which have flowed through the network interface on the node. | \{packets} | Counter       | direction, packet.type |

## Attributes

| Attribute Name | Description                                                                                              | Type   | Values                          |
| -------------- | -------------------------------------------------------------------------------------------------------- | ------ | ------------------------------- |
| `class`        | The CPU usage of the architecture allocated for either DPDK (datapath) or non-DPDK (services) processes. | string | `datapath`, `services`          |
| `direction`    | The direction of network flow.                                                                           | string | `received`, `transmitted`       |
| `state`        | The state of storage space.                                                                              | string | `used`, `available`             |
| `type`         | The type of packet counter.                                                                              | string | `dropped`, `errored`, `success` |

## Resource Attributes

| Attribute Name   | Description                        | Type   | Enabled |
| ---------------- | ---------------------------------- | ------ | ------- |
| `device.id`      | The name of the network interface. | string | ✅       |
| `nsxt.node.id`   | The ID of the NSX Node.            | string | ✅       |
| `nsxt.node.name` | The name of the NSX Node.          | string | ✅       |
| `nsxt.node.type` | The type of NSX Node.              | string | ✅       |

## Configuration

### Example Configuration

```yaml theme={null}
nsxt:
  collection_interval: 1m
  endpoint: https://nsx-manager-endpoint
  username: admin
  password: ${env:NSXT_PASSWORD}
  tls:
    insecure: true
```

***

*Last generated: 2026-07-06*