---
title: Telegraf Documentation
description: Telegraf plugin for collecting metrics from Lustre
url: https://docs.influxdata.com/telegraf/v1/input-plugins/lustre2/
estimated_tokens: 2180
product: Telegraf
version: v1
---

-   Telegraf v0.1.5+

# Lustre Input Plugin

This plugin gathers metrics for the [Lustre® file system](http://lustre.org/) using its entries in the `proc` filesystem. Reference the [Lustre Monitoring and Statistics Guide](http://wiki.lustre.org/Lustre_Monitoring_and_Statistics_Guide) for the reported information.

limited set of items. Check the metrics section.

**Introduced in:** Telegraf v0.1.5 **Tags:** system **OS support:** linux

## Global configuration options

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.

## Configuration

```toml
# Read metrics from local Lustre service on OST, MDS
# This plugin ONLY supports Linux
[[inputs.lustre2]]
  ## An array of /proc globs to search for Lustre stats
  ## If not specified, the default will work on Lustre 2.12.x
  ##
  # mgs_procfiles = [
  #   "/sys/fs/lustre/mgs/*/eviction_count",
  # ]
  # ost_procfiles = [
  #   "/proc/fs/lustre/obdfilter/*/stats",
  #   "/proc/fs/lustre/osd-ldiskfs/*/stats",
  #   "/proc/fs/lustre/obdfilter/*/job_stats",
  #   "/proc/fs/lustre/obdfilter/*/exports/*/stats",
  #   "/proc/fs/lustre/osd-ldiskfs/*/brw_stats",
  #   "/proc/fs/lustre/osd-zfs/*/brw_stats",
  #   "/sys/fs/lustre/odbfilter/*/eviction_count",
  # ]
  # mds_procfiles = [
  #   "/proc/fs/lustre/mdt/*/md_stats",
  #   "/proc/fs/lustre/mdt/*/job_stats",
  #   "/proc/fs/lustre/mdt/*/exports/*/stats",
  #   "/proc/fs/lustre/osd-ldiskfs/*/brw_stats",
  #   "/proc/fs/lustre/osd-zfs/*/brw_stats",
  #   "/sys/fs/lustre/mdt/*/eviction_count",
  # ]
```

## Metrics

From `/sys/fs/lustre/health_check`:

-   lustre2
    -   tags:
    -   fields:
        -   health

From `/proc/fs/lustre/obdfilter/*/stats` and `/proc/fs/lustre/osd-ldiskfs/*/stats`:

-   lustre2
    -   tags:
        -   name
    -   fields:
        -   write\_bytes
        -   write\_calls
        -   read\_bytes
        -   read\_calls
        -   cache\_hit (samples, retained for backward compatibility)
        -   cache\_hit\_samples
        -   cache\_hit\_pages
        -   cache\_miss (samples, retained for backward compatibility)
        -   cache\_miss\_samples
        -   cache\_miss\_pages
        -   cache\_access (samples, retained for backward compatibility)
        -   cache\_access\_samples
        -   cache\_access\_pages

From `/proc/fs/lustre/obdfilter/*/exports/*/stats`:

-   lustre2
    -   tags:
        -   name
        -   client
    -   fields:
        -   write\_bytes
        -   write\_calls
        -   read\_bytes
        -   read\_calls

From `/proc/fs/lustre/obdfilter/*/job_stats`:

-   lustre2
    -   tags:
        -   name
        -   jobid
    -   fields:
        -   jobstats\_ost\_getattr
        -   jobstats\_ost\_setattr
        -   jobstats\_ost\_sync
        -   jobstats\_punch
        -   jobstats\_destroy
        -   jobstats\_create
        -   jobstats\_ost\_statfs
        -   jobstats\_get\_info
        -   jobstats\_set\_info
        -   jobstats\_quotactl
        -   jobstats\_read\_bytes
        -   jobstats\_read\_calls
        -   jobstats\_read\_max\_size
        -   jobstats\_read\_min\_size
        -   jobstats\_write\_bytes
        -   jobstats\_write\_calls
        -   jobstats\_write\_max\_size
        -   jobstats\_write\_min\_size

From `/proc/fs/lustre/mdt/*/md_stats`:

-   lustre2
    -   tags:
        -   name
    -   fields:
        -   open
        -   close
        -   mknod
        -   link
        -   unlink
        -   mkdir
        -   rmdir
        -   rename
        -   getattr
        -   setattr
        -   getxattr
        -   setxattr
        -   statfs
        -   sync
        -   samedir\_rename
        -   crossdir\_rename

From `/proc/fs/lustre/mdt/*/exports/*/stats`:

-   lustre2
    -   tags:
        -   name
        -   client
    -   fields:
        -   open
        -   close
        -   mknod
        -   link
        -   unlink
        -   mkdir
        -   rmdir
        -   rename
        -   getattr
        -   setattr
        -   getxattr
        -   setxattr
        -   statfs
        -   sync
        -   samedir\_rename
        -   crossdir\_rename

From `/proc/fs/lustre/mdt/*/job_stats`:

-   lustre2
    -   tags:
        -   name
        -   jobid
    -   fields:
        -   jobstats\_close
        -   jobstats\_crossdir\_rename
        -   jobstats\_getattr
        -   jobstats\_getxattr
        -   jobstats\_link
        -   jobstats\_mkdir
        -   jobstats\_mknod
        -   jobstats\_open
        -   jobstats\_rename
        -   jobstats\_rmdir
        -   jobstats\_samedir\_rename
        -   jobstats\_setattr
        -   jobstats\_setxattr
        -   jobstats\_statfs
        -   jobstats\_sync
        -   jobstats\_unlink

From `/proc/fs/lustre/*/*/eviction_count`:

-   lustre2
    -   tags:
        -   name
    -   fields:
        -   evictions

## Example Output

```text
lustre2,host=oss2,jobid=42990218,name=wrk-OST0041 jobstats_ost_setattr=0i,jobstats_ost_sync=0i,jobstats_punch=0i,jobstats_read_bytes=4096i,jobstats_read_calls=1i,jobstats_read_max_size=4096i,jobstats_read_min_size=4096i,jobstats_write_bytes=310206488i,jobstats_write_calls=7423i,jobstats_write_max_size=53048i,jobstats_write_min_size=8820i 1556525847000000000
lustre2,host=mds1,jobid=42992017,name=wrk-MDT0000 jobstats_close=31798i,jobstats_crossdir_rename=0i,jobstats_getattr=34146i,jobstats_getxattr=15i,jobstats_link=0i,jobstats_mkdir=658i,jobstats_mknod=0i,jobstats_open=31797i,jobstats_rename=0i,jobstats_rmdir=0i,jobstats_samedir_rename=0i,jobstats_setattr=1788i,jobstats_setxattr=0i,jobstats_statfs=0i,jobstats_sync=0i,jobstats_unlink=0i 1556525828000000000
```

#### Related

-   [Configure plugins](/telegraf/v1/configure_plugins/)
-   [Lustre Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/lustre2/README.md)