218 lines
5.4 KiB
Markdown
218 lines
5.4 KiB
Markdown
---
|
|
description: "Telegraf plugin for collecting metrics from Lustre"
|
|
menu:
|
|
telegraf_v1_ref:
|
|
parent: input_plugins_reference
|
|
name: Lustre
|
|
identifier: input-lustre2
|
|
tags: [Lustre, "input-plugins", "configuration"]
|
|
related:
|
|
- /telegraf/v1/configure_plugins/
|
|
---
|
|
|
|
# Lustre Input Plugin
|
|
|
|
The [Lustre](http://lustre.org/)® file system is an open-source, parallel file system that
|
|
supports many requirements of leadership class HPC simulation environments.
|
|
|
|
This plugin monitors the Lustre file system using its entries in the proc
|
|
filesystem.
|
|
|
|
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
|
|
|
|
In addition to the plugin-specific configuration settings, plugins support
|
|
additional global and plugin configuration settings. These settings are used to
|
|
modify metrics, tags, and field or create aliases and configure ordering, etc.
|
|
See the [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.
|
|
|
|
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
|
|
|
|
## Configuration
|
|
|
|
```toml @sample.conf
|
|
# 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
|
|
- cache_miss
|
|
- cache_access
|
|
|
|
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
|
|
|
|
## Troubleshooting
|
|
|
|
Check for the default or custom procfiles in the proc filesystem, and reference
|
|
the [Lustre Monitoring and Statistics Guide](http://wiki.lustre.org/Lustre_Monitoring_and_Statistics_Guide). This plugin does not
|
|
report all information from these files, only a limited set of items
|
|
corresponding to the above metric fields.
|
|
|
|
## 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
|
|
```
|
|
|
|
[lustre]: http://lustre.org/
|
|
[guide]: http://wiki.lustre.org/Lustre_Monitoring_and_Statistics_Guide
|