rrul

Documentation

Overview

Package rrul implements RRUL(Real-Time Response Under Load) networking performance test based on netperf utilities

Index

• func PingProbe(target string, resCh chan []DataPoint, quitCh chan struct{})
• type Config
• type DataPoint
  • func MarshalOutput(output []byte) ([]DataPoint, float64, error)
• type Result
  • func Launch(conf Config) (Result, error)

Functions

func PingProbe

func PingProbe(target string, resCh chan []DataPoint, quitCh chan struct{})

PingProbe sends ICMP packets and probing round trip latency

Types

type Config

type Config struct {
	Host    string
	Port    uint
	Seconds uint
}

Config defines netserver related configurations

type DataPoint

type DataPoint struct {
	Time  float64
	Value float64
	Unit  string
}

DataPoint defines a time-series data point

func MarshalOutput

func MarshalOutput(output []byte) ([]DataPoint, float64, error)

MarshalOutput marshals a command line output from netperf command and turns into []DataPoint e.g.

NETPERF_INTERIM_RESULT[0]=0.35
NETPERF_UNITS[0]=10^6bits/s
NETPERF_INTERVAL[0]=0.200
NETPERF_ENDING[0]=1528545723.525

type Result

type Result struct {
	TCPUpload             []DataPoint
	TCPDownload           []DataPoint
	UDPRR                 []DataPoint
	ICMPRR                []DataPoint
	TCPUploadThroughput   float64
	TCPDownloadThroughput float64
	UDPRRThroughput       float64
	ICMPRRThroughput      float64
}

Result defines time-series data returned by RRUL test

func Launch

func Launch(conf Config) (Result, error)

Launch is the entry point of running RRUL test