/* Lustre 2.x telegraf plugin Lustre (http://lustre.org/) is an open-source, parallel file system for HPC environments. It stores statistics about its activity in /proc */ package lustre2 import ( "path/filepath" "strconv" "strings" "github.com/influxdata/telegraf" "github.com/influxdata/telegraf/internal" "github.com/influxdata/telegraf/registry/inputs" ) // Lustre proc files can change between versions, so we want to future-proof // by letting people choose what to look at. type Lustre2 struct { Ost_procfiles []string Mds_procfiles []string // allFields maps and OST name to the metric fields associated with that OST allFields map[string]map[string]interface{} } var sampleConfig = ` ## An array of /proc globs to search for Lustre stats ## If not specified, the default will work on Lustre 2.5.x ## # ost_procfiles = [ # "/proc/fs/lustre/obdfilter/*/stats", # "/proc/fs/lustre/osd-ldiskfs/*/stats", # "/proc/fs/lustre/obdfilter/*/job_stats", # ] # mds_procfiles = [ # "/proc/fs/lustre/mdt/*/md_stats", # "/proc/fs/lustre/mdt/*/job_stats", # ] ` /* The wanted fields would be a []string if not for the lines that start with read_bytes/write_bytes and contain both the byte count and the function call count */ type mapping struct { inProc string // What to look for at the start of a line in /proc/fs/lustre/* field uint32 // which field to extract from that line reportAs string // What measurement name to use tag string // Additional tag to add for this metric } var wanted_ost_fields = []*mapping{ { inProc: "write_bytes", field: 6, reportAs: "write_bytes", }, { // line starts with 'write_bytes', but value write_calls is in second column inProc: "write_bytes", field: 1, reportAs: "write_calls", }, { inProc: "read_bytes", field: 6, reportAs: "read_bytes", }, { // line starts with 'read_bytes', but value read_calls is in second column inProc: "read_bytes", field: 1, reportAs: "read_calls", }, { inProc: "cache_hit", }, { inProc: "cache_miss", }, { inProc: "cache_access", }, } var wanted_ost_jobstats_fields = []*mapping{ { // The read line has several fields, so we need to differentiate what they are inProc: "read", field: 3, reportAs: "jobstats_read_calls", }, { inProc: "read", field: 7, reportAs: "jobstats_read_min_size", }, { inProc: "read", field: 9, reportAs: "jobstats_read_max_size", }, { inProc: "read", field: 11, reportAs: "jobstats_read_bytes", }, { // Different inProc for newer versions inProc: "read_bytes", field: 3, reportAs: "jobstats_read_calls", }, { inProc: "read_bytes", field: 7, reportAs: "jobstats_read_min_size", }, { inProc: "read_bytes", field: 9, reportAs: "jobstats_read_max_size", }, { inProc: "read_bytes", field: 11, reportAs: "jobstats_read_bytes", }, { // We need to do the same for the write fields inProc: "write", field: 3, reportAs: "jobstats_write_calls", }, { inProc: "write", field: 7, reportAs: "jobstats_write_min_size", }, { inProc: "write", field: 9, reportAs: "jobstats_write_max_size", }, { inProc: "write", field: 11, reportAs: "jobstats_write_bytes", }, { // Different inProc for newer versions inProc: "write_bytes", field: 3, reportAs: "jobstats_write_calls", }, { inProc: "write_bytes", field: 7, reportAs: "jobstats_write_min_size", }, { inProc: "write_bytes", field: 9, reportAs: "jobstats_write_max_size", }, { inProc: "write_bytes", field: 11, reportAs: "jobstats_write_bytes", }, { inProc: "getattr", field: 3, reportAs: "jobstats_ost_getattr", }, { inProc: "setattr", field: 3, reportAs: "jobstats_ost_setattr", }, { inProc: "punch", field: 3, reportAs: "jobstats_punch", }, { inProc: "sync", field: 3, reportAs: "jobstats_ost_sync", }, { inProc: "destroy", field: 3, reportAs: "jobstats_destroy", }, { inProc: "create", field: 3, reportAs: "jobstats_create", }, { inProc: "statfs", field: 3, reportAs: "jobstats_ost_statfs", }, { inProc: "get_info", field: 3, reportAs: "jobstats_get_info", }, { inProc: "set_info", field: 3, reportAs: "jobstats_set_info", }, { inProc: "quotactl", field: 3, reportAs: "jobstats_quotactl", }, } var wanted_mds_fields = []*mapping{ { inProc: "open", }, { inProc: "close", }, { inProc: "mknod", }, { inProc: "link", }, { inProc: "unlink", }, { inProc: "mkdir", }, { inProc: "rmdir", }, { inProc: "rename", }, { inProc: "getattr", }, { inProc: "setattr", }, { inProc: "getxattr", }, { inProc: "setxattr", }, { inProc: "statfs", }, { inProc: "sync", }, { inProc: "samedir_rename", }, { inProc: "crossdir_rename", }, } var wanted_mdt_jobstats_fields = []*mapping{ { inProc: "open", field: 3, reportAs: "jobstats_open", }, { inProc: "close", field: 3, reportAs: "jobstats_close", }, { inProc: "mknod", field: 3, reportAs: "jobstats_mknod", }, { inProc: "link", field: 3, reportAs: "jobstats_link", }, { inProc: "unlink", field: 3, reportAs: "jobstats_unlink", }, { inProc: "mkdir", field: 3, reportAs: "jobstats_mkdir", }, { inProc: "rmdir", field: 3, reportAs: "jobstats_rmdir", }, { inProc: "rename", field: 3, reportAs: "jobstats_rename", }, { inProc: "getattr", field: 3, reportAs: "jobstats_getattr", }, { inProc: "setattr", field: 3, reportAs: "jobstats_setattr", }, { inProc: "getxattr", field: 3, reportAs: "jobstats_getxattr", }, { inProc: "setxattr", field: 3, reportAs: "jobstats_setxattr", }, { inProc: "statfs", field: 3, reportAs: "jobstats_statfs", }, { inProc: "sync", field: 3, reportAs: "jobstats_sync", }, { inProc: "samedir_rename", field: 3, reportAs: "jobstats_samedir_rename", }, { inProc: "crossdir_rename", field: 3, reportAs: "jobstats_crossdir_rename", }, } func (l *Lustre2) GetLustreProcStats(fileglob string, wanted_fields []*mapping, acc telegraf.Accumulator) error { files, err := filepath.Glob(fileglob) if err != nil { return err } for _, file := range files { /* Turn /proc/fs/lustre/obdfilter//stats and similar * into just the object store target name * Assumpion: the target name is always second to last, * which is true in Lustre 2.1->2.8 */ path := strings.Split(file, "/") name := path[len(path)-2] var fields map[string]interface{} fields, ok := l.allFields[name] if !ok { fields = make(map[string]interface{}) l.allFields[name] = fields } lines, err := internal.ReadLines(file) if err != nil { return err } for _, line := range lines { parts := strings.Fields(line) if strings.HasPrefix(line, "- job_id:") { // Set the job_id explicitly if present fields["jobid"] = parts[2] } for _, wanted := range wanted_fields { var data uint64 if strings.TrimSuffix(parts[0], ":") == wanted.inProc { wanted_field := wanted.field // if not set, assume field[1]. Shouldn't be field[0], as // that's a string if wanted_field == 0 { wanted_field = 1 } data, err = strconv.ParseUint(strings.TrimSuffix((parts[wanted_field]), ","), 10, 64) if err != nil { return err } report_name := wanted.inProc if wanted.reportAs != "" { report_name = wanted.reportAs } fields[report_name] = data } } } } return nil } // SampleConfig returns sample configuration message func (l *Lustre2) SampleConfig() string { return sampleConfig } // Description returns description of Lustre2 plugin func (l *Lustre2) Description() string { return "Read metrics from local Lustre service on OST, MDS" } // Gather reads stats from all lustre targets func (l *Lustre2) Gather(acc telegraf.Accumulator) error { l.allFields = make(map[string]map[string]interface{}) if len(l.Ost_procfiles) == 0 { // read/write bytes are in obdfilter//stats err := l.GetLustreProcStats("/proc/fs/lustre/obdfilter/*/stats", wanted_ost_fields, acc) if err != nil { return err } // cache counters are in osd-ldiskfs//stats err = l.GetLustreProcStats("/proc/fs/lustre/osd-ldiskfs/*/stats", wanted_ost_fields, acc) if err != nil { return err } // per job statistics are in obdfilter//job_stats err = l.GetLustreProcStats("/proc/fs/lustre/obdfilter/*/job_stats", wanted_ost_jobstats_fields, acc) if err != nil { return err } } if len(l.Mds_procfiles) == 0 { // Metadata server stats err := l.GetLustreProcStats("/proc/fs/lustre/mdt/*/md_stats", wanted_mds_fields, acc) if err != nil { return err } // Metadata target job stats err = l.GetLustreProcStats("/proc/fs/lustre/mdt/*/job_stats", wanted_mdt_jobstats_fields, acc) if err != nil { return err } } for _, procfile := range l.Ost_procfiles { ost_fields := wanted_ost_fields if strings.HasSuffix(procfile, "job_stats") { ost_fields = wanted_ost_jobstats_fields } err := l.GetLustreProcStats(procfile, ost_fields, acc) if err != nil { return err } } for _, procfile := range l.Mds_procfiles { mdt_fields := wanted_mds_fields if strings.HasSuffix(procfile, "job_stats") { mdt_fields = wanted_mdt_jobstats_fields } err := l.GetLustreProcStats(procfile, mdt_fields, acc) if err != nil { return err } } for name, fields := range l.allFields { tags := map[string]string{ "name": name, } if _, ok := fields["jobid"]; ok { if jobid, ok := fields["jobid"].(string); ok { tags["jobid"] = jobid } delete(fields, "jobid") } acc.AddFields("lustre2", fields, tags) } return nil } func init() { inputs.Add("lustre2", func() telegraf.Input { return &Lustre2{} }) }