telegraf/plugins/inputs/ping/ping_windows.go

//go:build windows

package ping

import (
	"errors"
	"fmt"
	"regexp"
	"strconv"
	"strings"

	"github.com/influxdata/telegraf"
)

type roundTripTimeStats struct {
	min int
	avg int
	max int
}

type statistics struct {
	packetsTransmitted int
	replyReceived      int
	packetsReceived    int
	roundTripTimeStats
}

func (p *Ping) pingToURL(host string, acc telegraf.Accumulator) {
	tags := map[string]string{"url": host}
	fields := map[string]interface{}{"result_code": 0}

	args := p.args(host)
	totalTimeout := 60.0
	if len(p.Arguments) == 0 {
		totalTimeout = p.timeout() * float64(p.Count)
	}

	out, err := p.pingHost(p.Binary, totalTimeout, args...)
	// ping host return exitcode != 0 also when there was no response from host but command was executed successfully
	var pendingError error
	if err != nil {
		// Combine go err + stderr output
		pendingError = errors.New(strings.TrimSpace(out) + ", " + err.Error())
	}
	stats, err := processPingOutput(out)
	if err != nil {
		// fatal error
		if pendingError != nil {
			acc.AddError(fmt.Errorf("%s: %w", host, pendingError))
		} else {
			acc.AddError(fmt.Errorf("%s: %w", host, err))
		}

		fields["result_code"] = 2
		fields["errors"] = 100.0
		acc.AddFields("ping", fields, tags)
		return
	}
	// Calculate packet loss percentage
	lossReply := float64(stats.packetsTransmitted-stats.replyReceived) / float64(stats.packetsTransmitted) * 100.0
	lossPackets := float64(stats.packetsTransmitted-stats.packetsReceived) / float64(stats.packetsTransmitted) * 100.0

	fields["packets_transmitted"] = stats.packetsTransmitted
	fields["reply_received"] = stats.replyReceived
	fields["packets_received"] = stats.packetsReceived
	fields["percent_packet_loss"] = lossPackets
	fields["percent_reply_loss"] = lossReply
	if stats.avg >= 0 {
		fields["average_response_ms"] = float64(stats.avg)
	}
	if stats.min >= 0 {
		fields["minimum_response_ms"] = float64(stats.min)
	}
	if stats.max >= 0 {
		fields["maximum_response_ms"] = float64(stats.max)
	}
	acc.AddFields("ping", fields, tags)
}

// args returns the arguments for the 'ping' executable
func (p *Ping) args(url string) []string {
	if len(p.Arguments) > 0 {
		return p.Arguments
	}

	args := []string{"-n", strconv.Itoa(p.Count)}

	if p.Timeout > 0 {
		args = append(args, "-w", strconv.FormatFloat(p.Timeout*1000, 'f', 0, 64))
	}

	args = append(args, url)

	return args
}

// processPingOutput takes in a string output from the ping command
// based on linux implementation but using regex (multi-language support)
// It returns (<transmitted packets>, <received reply>, <received packet>, <average response>, <min response>, <max response>)
func processPingOutput(out string) (statistics, error) {
	// So find a line contain 3 numbers except reply lines
	var statsLine, approxs []string = nil, nil
	err := errors.New("fatal error processing ping output")
	stat := regexp.MustCompile(`=\W*(\d+)\D*=\W*(\d+)\D*=\W*(\d+)`)
	approx := regexp.MustCompile(`=\W*(\d+)\D*ms\D*=\W*(\d+)\D*ms\D*=\W*(\d+)\D*ms`)
	tttLine := regexp.MustCompile(`TTL=\d+`)
	lines := strings.Split(out, "\n")
	var replyReceived = 0
	for _, line := range lines {
		if tttLine.MatchString(line) {
			replyReceived++
		} else {
			if statsLine == nil {
				statsLine = stat.FindStringSubmatch(line)
			}
			if statsLine != nil && approxs == nil {
				approxs = approx.FindStringSubmatch(line)
			}
		}
	}

	stats := statistics{
		packetsTransmitted: 0,
		replyReceived:      0,
		packetsReceived:    0,
		roundTripTimeStats: roundTripTimeStats{
			min: -1,
			avg: -1,
			max: -1,
		},
	}

	// statsLine data should contain 4 members: entireExpression + ( Send, Receive, Lost )
	if len(statsLine) != 4 {
		return stats, err
	}
	packetsTransmitted, err := strconv.Atoi(statsLine[1])
	if err != nil {
		return stats, err
	}
	packetsReceived, err := strconv.Atoi(statsLine[2])
	if err != nil {
		return stats, err
	}

	stats.packetsTransmitted = packetsTransmitted
	stats.replyReceived = replyReceived
	stats.packetsReceived = packetsReceived

	// approxs data should contain 4 members: entireExpression + ( min, max, avg )
	if len(approxs) != 4 {
		return stats, err
	}
	low, err := strconv.Atoi(approxs[1])
	if err != nil {
		return stats, err
	}
	high, err := strconv.Atoi(approxs[2])
	if err != nil {
		return stats, err
	}
	avg, err := strconv.Atoi(approxs[3])
	if err != nil {
		return statistics{}, err
	}

	stats.avg = avg
	stats.min = low
	stats.max = high

	return stats, err
}

func (p *Ping) timeout() float64 {
	// According to MSDN, default ping timeout for windows is 4 second
	// Add also one second interval

	if p.Timeout > 0 {
		return p.Timeout + 1
	}
	return 4 + 1
}