package openntpd import ( "bufio" "bytes" "fmt" "os/exec" "strconv" "strings" "time" "github.com/influxdata/telegraf" "github.com/influxdata/telegraf/filter" "github.com/influxdata/telegraf/internal" "github.com/influxdata/telegraf/plugins/inputs" ) // Mapping of ntpctl header names to tag keys var tagHeaders = map[string]string{ "st": "stratum", } // Mapping of the ntpctl tag key to the index in the command output var tagI = map[string]int{ "stratum": 2, } // Mapping of float metrics to their index in the command output var floatI = map[string]int{ "offset": 5, "delay": 6, "jitter": 7, } // Mapping of int metrics to their index in the command output var intI = map[string]int{ "wt": 0, "tl": 1, "next": 3, "poll": 4, } type runner func(cmdName string, Timeout internal.Duration, UseSudo bool) (*bytes.Buffer, error) // Openntpd is used to store configuration values type Openntpd struct { Binary string Timeout internal.Duration UseSudo bool filter filter.Filter run runner } var defaultBinary = "/usr/sbin/ntpctl" var defaultTimeout = internal.Duration{Duration: time.Second} func (n *Openntpd) Description() string { return "Get standard NTP query metrics from OpenNTPD." } func (n *Openntpd) SampleConfig() string { return ` ## If running as a restricted user you can prepend sudo for additional access: #use_sudo = false ## The default location of the ntpctl binary can be overridden with: binary = "/usr/sbin/ntpctl" ## The default timeout of 1000ms can be overriden with (in milliseconds): timeout = 1000 ` } // Shell out to ntpctl and return the output func openntpdRunner(cmdName string, Timeout internal.Duration, UseSudo bool) (*bytes.Buffer, error) { cmdArgs := []string{"-s", "peers"} cmd := exec.Command(cmdName, cmdArgs...) if UseSudo { cmdArgs = append([]string{cmdName}, cmdArgs...) cmd = exec.Command("sudo", cmdArgs...) } var out bytes.Buffer cmd.Stdout = &out err := internal.RunTimeout(cmd, Timeout.Duration) if err != nil { return &out, fmt.Errorf("error running ntpctl: %s", err) } return &out, nil } func (n *Openntpd) Gather(acc telegraf.Accumulator) error { out, err := n.run(n.Binary, n.Timeout, n.UseSudo) if err != nil { return fmt.Errorf("error gathering metrics: %s", err) } lineCounter := 0 scanner := bufio.NewScanner(out) for scanner.Scan() { // skip first (peer) and second (field list) line if lineCounter < 2 { lineCounter++ continue } line := scanner.Text() fields := strings.Fields(line) mFields := make(map[string]interface{}) tags := make(map[string]string) // Even line ---> ntp server info if lineCounter%2 == 0 { // DNS resolution error ---> keep DNS name as remote name if fields[0] != "not" { tags["remote"] = fields[0] } else { tags["remote"] = fields[len(fields)-1] } } // Read next line - Odd line ---> ntp server stats scanner.Scan() line = scanner.Text() lineCounter++ fields = strings.Fields(line) // if there is an ntpctl state prefix, remove it and make it it's own tag if strings.ContainsAny(string(fields[0]), "*") { tags["state_prefix"] = string(fields[0]) fields = append(fields[:0], fields[1:]...) } // Get tags from output for key, index := range tagI { if len(fields) < index { continue } tags[key] = fields[index] } // Get integer metrics from output for key, index := range intI { if index >= len(fields) { continue } if fields[index] == "-" { continue } if key == "next" || key == "poll" { m, err := strconv.ParseInt(strings.TrimSuffix(fields[index], "s"), 10, 64) if err != nil { acc.AddError(fmt.Errorf("integer value expected, got: %s", fields[index])) continue } mFields[key] = m } else { m, err := strconv.ParseInt(fields[index], 10, 64) if err != nil { acc.AddError(fmt.Errorf("integer value expected, got: %s", fields[index])) continue } mFields[key] = m } } // get float metrics from output for key, index := range floatI { if len(fields) <= index { continue } if fields[index] == "-" || fields[index] == "----" || fields[index] == "peer" || fields[index] == "not" || fields[index] == "valid" { continue } if key == "offset" || key == "delay" || key == "jitter" { m, err := strconv.ParseFloat(strings.TrimSuffix(fields[index], "ms"), 64) if err != nil { acc.AddError(fmt.Errorf("float value expected, got: %s", fields[index])) continue } mFields[key] = m } else { m, err := strconv.ParseFloat(fields[index], 64) if err != nil { acc.AddError(fmt.Errorf("float value expected, got: %s", fields[index])) continue } mFields[key] = m } } acc.AddFields("openntpd", mFields, tags) lineCounter++ } return nil } func init() { inputs.Add("openntpd", func() telegraf.Input { return &Openntpd{ run: openntpdRunner, Binary: defaultBinary, Timeout: defaultTimeout, UseSudo: false, } }) }