For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/integrations/nfsstat.md. A documentation index is available at /llms.txt.

Nfsstat

Supported OS Linux

Integration version3.5.0

To find out if this integration is available in your organization, see your Datadog Integrations page or ask your organization administrator.

To initiate an exception request to enable this integration for your organization, email support@ddog-gov.com.

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.

Minimum Agent version: 6.6.0

Setup

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

Installation

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

Configuration

Edit the nfsstat.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory. Point to your nfsiostat binary script, or use the one included with the binary installer. See the sample nfsstat.d/conf.yaml for all available configuration options.

Log collection

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

    logs_enabled: true

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

    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 for all available configuration options.

  3. Restart the Agent.

Validation

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

Data Collected

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

The Nfsstat check does not include any events.

Service Checks

The Nfsstat check does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.