---
title: Nfsstat
description: nfsstat gets nfsiostat-sysstat metrics.
breadcrumbs: Docs > Integrations > Nfsstat
---

# Nfsstat
Supported OS Integration version3.5.0
## Overview{% #overview %}

The NFS integration collects metrics about mount points on the NFS client as it uses the `nfsiostat` tool that displays NFS client per-mount [statistics](http://man7.org/linux/man-pages/man8/nfsiostat.8.html).

**Minimum Agent version:** 6.6.0

## Setup{% #setup %}

Follow the instructions below to install and configure this check for an Agent running on a host.

### Installation{% #installation %}

The NFSstat check is included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package, so you don't need to install anything else on your servers.

### Configuration{% #configuration %}

Edit the `nfsstat.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files.md#agent-configuration-directory). Point to your nfsiostat binary script, or use the one included with the binary installer. See the [sample nfsstat.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/nfsstat/datadog_checks/nfsstat/data/conf.yaml.example) for all available configuration options.

### Log collection{% #log-collection %}

1. Collecting logs is disabled by default in the Datadog Agent, so to enable it in `datadog.yaml`, update this setting:

   ```yaml
   logs_enabled: true
   ```

1. Add this configuration block to your `nfsstat.d/conf.yaml` file to start collecting your NFSstat Logs:

   ```yaml
   logs:
     - type: file
       path: /var/log/messages
       source: nfsstat
   ```

Change the `path` parameter value and configure it for your environment. See the [sample nfsstat.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/nfsstat/datadog_checks/nfsstat/data/conf.yaml.example) for all available configuration options.

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md?tab=agentv6v7#start-stop-and-restart-the-agent).

### Validation{% #validation %}

[Run the Agent's `status` subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information) and look for `nfsstat` under the Checks section.

## Data Collected{% #data-collected %}

### Metrics{% #metrics %}

|  |
|  |
| **system.nfs.ops**(gauge)               | operations per second*Shown as operation*                                                                 |
| **system.nfs.read.exe**(gauge)          | this is the time between making a read rpc request and the request being completed*Shown as millisecond*  |
| **system.nfs.read.ops**(gauge)          | this is the number of read operations per second*Shown as operation*                                      |
| **system.nfs.read.retrans**(gauge)      | this is the number of retransmissions in read operations*Shown as operation*                              |
| **system.nfs.read.retrans.pct**(gauge)  | this is the percent of retransmissions in read operations*Shown as percent*                               |
| **system.nfs.read.rtt**(gauge)          | read operation round trip time*Shown as millisecond*                                                      |
| **system.nfs.read\_per\_op**(gauge)     | this is the number of kibibytes read per operation*Shown as kibibyte*                                     |
| **system.nfs.read\_per\_s**(gauge)      | this is the number of kibibytes read per second*Shown as kibibyte*                                        |
| **system.nfs.rpc\_bklog**(gauge)        | length of the backlog queue*Shown as item*                                                                |
| **system.nfs.write.exe**(gauge)         | this is the time between making a write rpc request and the request being completed*Shown as millisecond* |
| **system.nfs.write.ops**(gauge)         | this is the number of write operations per second*Shown as operation*                                     |
| **system.nfs.write.retrans**(gauge)     | this is the number of retransmissions in write operations*Shown as operation*                             |
| **system.nfs.write.retrans.pct**(gauge) | this is the percent of retransmissions in write operations*Shown as percent*                              |
| **system.nfs.write.rtt**(gauge)         | write operation round trip time*Shown as millisecond*                                                     |
| **system.nfs.write\_per\_op**(gauge)    | this is the number of kibibytes written per operation*Shown as kibibyte*                                  |
| **system.nfs.write\_per\_s**(gauge)     | this is the number of kibibytes written per second*Shown as kibibyte*                                     |

### Events{% #events %}

The Nfsstat check does not include any events.

### Service Checks{% #service-checks %}

The Nfsstat check does not include any service checks.

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).