Support to set some attributes for latency, reorder, corrupt,etc...

Author: sweet.yangyz

api/http/server.go

@@ -124,7 +124,11 @@ func apiHandler(w http.ResponseWriter, r *http.Request) {
 				v.Device = config.Device
 				v.Latency = config.Latency
 				v.LatencyJitter = config.LatencyJitter
-				v.LatencyDistributionNormal = config.LatencyDistributionNormal
+				v.LatencyCorrelation = config.LatencyCorrelation
+				v.LatencyDistribution = config.LatencyDistribution
+				v.LatencyReorder = config.LatencyReorder
+				v.LatencyDuplicate = config.LatencyDuplicate
+				v.LatencyCorrupt = config.LatencyCorrupt
 				v.PacketLoss = config.PacketLoss
 				v.TargetBandwidth = config.TargetBandwidth
 				v.TargetPorts = config.TargetPorts
@@ -139,7 +143,11 @@ func apiHandler(w http.ResponseWriter, r *http.Request) {
 				v.Config.Device = config.Device
 				v.Config.Latency = config.Latency
 				v.Config.LatencyJitter = config.LatencyJitter
-				v.Config.LatencyDistributionNormal = config.LatencyDistributionNormal
+				v.Config.LatencyCorrelation = config.LatencyCorrelation
+				v.Config.LatencyDistribution = config.LatencyDistribution
+				v.Config.LatencyReorder = config.LatencyReorder
+				v.Config.LatencyDuplicate = config.LatencyDuplicate
+				v.Config.LatencyCorrupt = config.LatencyCorrupt
 				v.Config.PacketLoss = config.PacketLoss
 				v.Config.TargetBandwidth = config.TargetBandwidth
 				v.Config.TargetPorts = config.TargetPorts

examples/wonton/ubuntu/init.yml

@@ -19,9 +19,11 @@ middleware:
  #            
   - name: network_shape
     config:
+      device:      "ens33"
       latency:     0        # Latency to add in ms
       latency_jitter: 0
-      latency_distribution_normal: false
+      latency_correlation: 0
+      latency_distribution: "normal" # uniform, normal, pareto, paretonormal
       latency_reorder: 0
       latency_duplicate: 0
       latency_corrupt: 0

examples/wonton/ubuntu/middleware.yml

@@ -19,7 +19,7 @@ middleware:
  #            
   - name: network_shape
     config:
-      device:      ens33
+      device:      "ens33"
       latency:     800        # Latency to add in ms
       target_bw:   3         # Bandwidth in kbits/s
       packet_loss: 30         # Packet loss, as a %

symptom/network_shape.go

@@ -17,23 +17,24 @@ import (
 // NetworkShaperSymptom allows you to modify the network speed on a host
 // e.g. shape bandwidth to mobile, slower speeds
 type NetworkShaperSymptom struct {
-	Config                    throttler.Config
-	Device                    string
-	Latency                   int      `default:"-1"`
-	TargetBandwidth           int      `mapstructure:"target_bw" default:"-1"`
-	DefaultBandwidth          int      `mapstructure:"default_bw" default:"-1"`
-	PacketLoss                float64  `mapstructure:"packet_loss"`
-	LatencyJitter             float64  `mapstructure:"latency_jitter"`
-	LatencyDistributionNormal bool     `mapstructure:"latency_distribution_normal"`
-	LatencyReorder            float64  `mapstructure:"latency_reorder"`
-	LatencyDuplicate          float64  `mapstructure:"latency_duplicate"`
-	LatencyCorrupt            float64  `mapstructure:"latency_corrupt"`
-	TargetIps                 []string `mapstructure:"target_ips"`
-	TargetIps6                []string `mapstructure:"target_ips6"`
-	TargetPorts               []string `mapstructure:"target_ports"`
-	TargetProtos              []string `mapstructure:"target_protos" required:"true" default:"tcp,icmp,udp"`
-	out                       io.Writer
-	err                       io.Writer
+	Config              throttler.Config
+	Device              string
+	Latency             int      `default:"-1"`
+	TargetBandwidth     int      `mapstructure:"target_bw" default:"-1"`
+	DefaultBandwidth    int      `mapstructure:"default_bw" default:"-1"`
+	PacketLoss          float64  `mapstructure:"packet_loss"`
+	LatencyJitter       float64  `mapstructure:"latency_jitter"`
+	LatencyCorrelation  float64  `mapstructure:"latency_correlation"`
+	LatencyDistribution string   `mapstructure:"latency_distribution"`
+	LatencyReorder      float64  `mapstructure:"latency_reorder"`
+	LatencyDuplicate    float64  `mapstructure:"latency_duplicate"`
+	LatencyCorrupt      float64  `mapstructure:"latency_corrupt"`
+	TargetIps           []string `mapstructure:"target_ips"`
+	TargetIps6          []string `mapstructure:"target_ips6"`
+	TargetPorts         []string `mapstructure:"target_ports"`
+	TargetProtos        []string `mapstructure:"target_protos" required:"true" default:"tcp,icmp,udp"`
+	out                 io.Writer
+	err                 io.Writer
 }
 
 func init() {
@@ -53,21 +54,22 @@ func (s *NetworkShaperSymptom) Setup() {
 	log.Debug("NetworkShaperSymptom - \tIPv4 %s \tIPv6 %s")
 
 	s.Config = throttler.Config{
-		Device:                    s.Device,
-		Latency:                   s.Latency,
-		TargetBandwidth:           s.TargetBandwidth,
-		DefaultBandwidth:          s.DefaultBandwidth,
-		PacketLoss:                s.PacketLoss,
-		LatencyJitter:             s.LatencyJitter,
-		LatencyDistributionNormal: s.LatencyDistributionNormal,
-		LatencyReorder:            s.LatencyReorder,
-		LatencyDuplicate:          s.LatencyDuplicate,
-		LatencyCorrupt:            s.LatencyCorrupt,
-		TargetIps:                 targetIPv4,
-		TargetIps6:                targetIPv6,
-		TargetPorts:               ports,
-		TargetProtos:              s.TargetProtos,
-		DryRun:                    false,
+		Device:              s.Device,
+		Latency:             s.Latency,
+		TargetBandwidth:     s.TargetBandwidth,
+		DefaultBandwidth:    s.DefaultBandwidth,
+		PacketLoss:          s.PacketLoss,
+		LatencyJitter:       s.LatencyJitter,
+		LatencyCorrelation:  s.LatencyCorrelation,
+		LatencyDistribution: s.LatencyDistribution,
+		LatencyReorder:      s.LatencyReorder,
+		LatencyDuplicate:    s.LatencyDuplicate,
+		LatencyCorrupt:      s.LatencyCorrupt,
+		TargetIps:           targetIPv4,
+		TargetIps6:          targetIPv6,
+		TargetPorts:         ports,
+		TargetProtos:        s.TargetProtos,
+		DryRun:              false,
 	}
 
 	executeThrottler(&s.Config)

throttler/tc.go

@@ -10,39 +10,40 @@ import (
 )
 
 const (
-	tcRootQDisc               = `dev %s handle 10: root`
-	tcRootExtra               = `default 1`
-	tcDefaultClass            = `dev %s parent 10: classid 10:1`
-	tcTargetClass             = `dev %s parent 10: classid 10:10`
-	tcNetemRule               = `dev %s parent 10:10 handle 100:`
-	tcRate                    = `rate %vkbit`
-	tcDelay                   = `delay %vms`
-	tcLDelayistributionNormal = `distribution normal`
-	tcLDelayJitter            = `%vms`
-	tcLoss                    = `loss %v%%`
-	tcReorder                 = `reorder %f`
-	tcDuplicate               = `duplicate %f`
-	tcCorrupt                 = `corrupt %f`
-	tcAddClass                = `sudo tc class add`
-	tcDelClass                = `sudo tc class del`
-	tcAddQDisc                = `sudo tc qdisc add`
-	tcDelQDisc                = `sudo tc qdisc del`
-	iptAddTarget              = `sudo %s -A POSTROUTING -t mangle -j CLASSIFY --set-class 10:10`
-	iptDelTarget              = `sudo %s -D POSTROUTING -t mangle -j CLASSIFY --set-class 10:10`
-	iptDestIP                 = `-d %s`
-	iptProto                  = `-p %s`
-	iptDestPorts              = `--match multiport --dports %s`
-	iptDestPort               = `--dport %s`
-	iptSrcPorts               = `--match multiport --sports %s`
-	iptSrcPort                = `--sport %s`
-	iptDelSearch              = `class 0010:0010`
-	TcList                    = `sudo tc qdisc show`
-	IptList                   = `sudo %s -S -t mangle`
-	Ip4Tables                 = `iptables`
-	Ip6Tables                 = `ip6tables`
-	iptDel                    = `sudo %s -t mangle -D`
-	tcExists                  = `sudo tc qdisc show | grep "netem"`
-	tcCheck                   = `sudo tc -s qdisc`
+	tcRootQDisc        = `dev %s handle 10: root`
+	tcRootExtra        = `default 1`
+	tcDefaultClass     = `dev %s parent 10: classid 10:1`
+	tcTargetClass      = `dev %s parent 10: classid 10:10`
+	tcNetemRule        = `dev %s parent 10:10 handle 100:`
+	tcRate             = `rate %vkbit`
+	tcDelay            = `delay %vms`
+	tcDelayistribution = `distribution %s`
+	tcDelayJitter      = `%vms`
+	tcDelayCorrelation = `%v%%`
+	tcLoss             = `loss %v%% 25%%`
+	tcReorder          = `reorder %v%% gap 3`
+	tcDuplicate        = `duplicate %v%%`
+	tcCorrupt          = `corrupt %v%%`
+	tcAddClass         = `sudo tc class add`
+	tcDelClass         = `sudo tc class del`
+	tcAddQDisc         = `sudo tc qdisc add`
+	tcDelQDisc         = `sudo tc qdisc del`
+	iptAddTarget       = `sudo %s -A POSTROUTING -t mangle -j CLASSIFY --set-class 10:10`
+	iptDelTarget       = `sudo %s -D POSTROUTING -t mangle -j CLASSIFY --set-class 10:10`
+	iptDestIP          = `-d %s`
+	iptProto           = `-p %s`
+	iptDestPorts       = `--match multiport --dports %s`
+	iptDestPort        = `--dport %s`
+	iptSrcPorts        = `--match multiport --sports %s`
+	iptSrcPort         = `--sport %s`
+	iptDelSearch       = `class 0010:0010`
+	TcList             = `sudo tc qdisc show`
+	IptList            = `sudo %s -S -t mangle`
+	Ip4Tables          = `iptables`
+	Ip6Tables          = `ip6tables`
+	iptDel             = `sudo %s -t mangle -D`
+	tcExists           = `sudo tc qdisc show | grep "netem"`
+	tcCheck            = `sudo tc -s qdisc`
 
 	//tcCbq                     = `cbq avpkt 1000 bandwidth %vkbit`
 )
@@ -193,16 +194,31 @@ func addNetemRule(cfg *Config, c commander) error {
 		strs = append(strs, fmt.Sprintf(tcDelay, cfg.Latency))
 
 		if cfg.LatencyJitter > 0 {
-			strs = append(strs, fmt.Sprintf(tcLDelayJitter, cfg.LatencyJitter))
+			strs = append(strs, fmt.Sprintf(tcDelayJitter, cfg.LatencyJitter))
 
-			if cfg.LatencyDistributionNormal {
-				strs = append(strs, tcLDelayistributionNormal)
+			if cfg.LatencyCorrelation > 0 {
+				strs = append(strs, fmt.Sprintf(tcDelayCorrelation, cfg.LatencyCorrelation))
+			}
+
+			if len(cfg.LatencyDistribution) > 0 {
+				strs = append(strs, fmt.Sprintf(tcDelayistribution, cfg.LatencyDistribution))
 			}
 		}
-	}
 
-	log.Debug("TargetBandwidth: %d", cfg.TargetBandwidth)
+		if cfg.LatencyReorder > 0 {
+			strs = append(strs, fmt.Sprintf(tcReorder, strconv.FormatFloat(cfg.LatencyReorder, 'f', 2, 64))) //"reorder 50% gap 3"
+		}
+
+		if cfg.LatencyDuplicate > 0 {
+			strs = append(strs, fmt.Sprintf(tcDuplicate, strconv.FormatFloat(cfg.LatencyDuplicate, 'f', 2, 64))) //"duplicate 50%"
+		}
 
+		if cfg.LatencyCorrupt > 0 {
+			strs = append(strs, fmt.Sprintf(tcCorrupt, strconv.FormatFloat(cfg.LatencyCorrupt, 'f', 2, 64))) //"corrupt 2%"
+		}
+	}
+
+	log.Debug("TargetBandwidth: %d, but if you used 'rate' in a netem command, you will received an error.", cfg.TargetBandwidth)
 	if cfg.TargetBandwidth > -1 {
 		// If you used 'rate' in netem, it will has an error.
 		//strs = append(strs, fmt.Sprintf(tcRate, cfg.TargetBandwidth))
@@ -215,7 +231,7 @@ func addNetemRule(cfg *Config, c commander) error {
 	cmd := strings.Join(strs, " ")
 
 	log.Debug("Adding a netem rule :")
-
+	log.Debug("%s", cmd)
 	return c.execute(cmd)
 }
 

throttler/throttler.go

@@ -22,22 +22,23 @@ const (
 
 // Config specifies options for configuring packet filter rules.
 type Config struct {
-	Device                    string
-	Stop                      bool
-	Latency                   int
-	TargetBandwidth           int
-	DefaultBandwidth          int
-	PacketLoss                float64
-	LatencyJitter             float64
-	LatencyDistributionNormal bool
-	LatencyReorder            float64
-	LatencyDuplicate          float64
-	LatencyCorrupt            float64
-	TargetIps                 []string
-	TargetIps6                []string
-	TargetPorts               []string
-	TargetProtos              []string
-	DryRun                    bool
+	Device              string
+	Stop                bool
+	Latency             int
+	TargetBandwidth     int
+	DefaultBandwidth    int
+	PacketLoss          float64
+	LatencyJitter       float64
+	LatencyCorrelation  float64
+	LatencyDistribution string
+	LatencyReorder      float64
+	LatencyDuplicate    float64
+	LatencyCorrupt      float64
+	TargetIps           []string
+	TargetIps6          []string
+	TargetPorts         []string
+	TargetProtos        []string
+	DryRun              bool
 }
 
 type throttler interface {