Prometheus exporter for use with the Lustre parallel filesystem
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
proc
sources
sys/fs/lustre
systemd
vendor
.gitignore
.promu.yml
.travis.yml
CHANGELOG.md
Gopkg.lock
Gopkg.toml
LICENSE
Makefile
README.md
VERSION
lustre_exporter.go
lustre_exporter_test.go Fix all metrics with known problems on lustre 2.10.1 Dec 4, 2017

README.md

Lustre Metrics Exporter

Go Report Card Build Status

Prometheus exporter for Lustre metrics.

Getting

go get github.com/HewlettPackard/lustre_exporter

Building

cd $GOPATH/src/github.com/HewlettPackard/lustre_exporter
make

Running

./lustre_exporter <flags>

Flags

  • collector.ost=disabled/core/extended
  • collector.mdt=disabled/core/extended
  • collector.mgs=disabled/core/extended
  • collector.mds=disabled/core/extended
  • collector.client=disabled/core/extended
  • collector.generic=disabled/core/extended
  • collector.lnet=disabled/core/extended
  • collector.health=disabled/core/extended

All above flags default to the value "extended" when no argument is submitted by the user.

Example: ./lustre_exporter --collector.ost=disabled --collector.mdt=core --collector.mgs=extended

The above example will result in a running instance of the Lustre Exporter with the following statuses:

  • collector.ost=disabled
  • collector.mdt=core
  • collector.mgs=extended
  • collector.mds=extended
  • collector.client=extended
  • collector.generic=extended
  • collector.lnet=extended
  • collector.health=extended

Flag Option Detailed Description

  • disabled - Completely disable all metrics for this portion of a source.
  • core - Enable this source, but only for metrics considered to be particularly useful.
  • extended - Enable this source and include all metrics that the Lustre Exporter is aware of within it.

What's exported?

All Lustre procfs and procsys data from all nodes running the Lustre Exporter that we perceive as valuable data is exported or can be added to be exported (we don't have any known major gaps that anyone cares about, so if you see something missing, please file an issue!).

See the issues tab for all known issues. This project is actively maintained by HPE, so you should see a reasonably quick response if you identify a gap.

Troubleshooting

In the event that you encounter issues with specific metrics (especially on versions of Lustre older than 2.7), please try disabling those specific troublesome metrics using the documented collector flags in the 'disabled' or 'core' state. Users have encountered bugs within Lustre where specific sysfs and procfs files miscommunicate their sizes, causing read calls to fail.

Contributing

To contribute to this HPE project, you'll need to fill out a CLA (Contributor License Agreement). If you would like to contribute anything more than a bug fix (feature, architectural change, etc), please file an issue and we'll get in touch with you to have you fill out the CLA.