Skip to content

Latest commit

 

History

History
75 lines (55 loc) · 2.86 KB

README.md

File metadata and controls

75 lines (55 loc) · 2.86 KB
Raw

OTGen: Open Traffic Generator CLI Tool

CI

How to use

The idea behind otgen is to leverage shell pipe capabilities to break OTG API interaction into multiple stages with output of one feeding to the next. This way, each individual stage can be:

  • easily parameterized,
  • individually re-used,
  • when needed, substituted by a custom implementation

The pipe workflow on otgen looks the following:

otgen create tcp -s 1.1.1.1 -d 2.2.2.2 -p 80 --rate 1000pps | otgen run --metrics flow | otgen transform --metrics flow --counters frames | otgen display --mode table

Command reference

run

Request an OTG API endpoint to run OTG model.

otgen run 
  [--api https://otg-api-endpoint]    # OTG server API endpoint (default is https://localhost)
  [--insecure]                        # Ignore X.509 certificate validation
  [--file otg.yml | --file otg.json]  # OTG model file. If not provided, will use stdin
  [--yaml | --json]                   # Format of OTG input
  [--metrics port|flow]               # Metrics type to report: "port" for PortMetrics, "flow" for FlowMetrics
  [--interval 0.5s]                   # Interval to pull OTG metrics. Valid time units are 'ms', 's', 'm', 'h'. Example: 1s (default 0.5s)
  [--xeta 2]                          # How long to wait before forcing traffic to stop. In multiples of ETA. Example: 1.5 (default 2)

transform

Transform raw OTG metrics into a format suitable for further processing. If no parameters is provided, transform validates input for a match with OTG MetricsResponse data structure, and if matched, outputs it as is.

otgen transform 
  [--metrics port|flow]               # Metrics type to transform: 
                                      #   "port" for PortMetrics
                                      #   "flow" for FlowMetrics
  [--counters frames|bytes|pps|tput]  # Metric counters to transform:
                                      #   "frames" for frame count (default),
                                      #   "bytes" for byte count,
                                      #   "pps" for frame rate, in packets per second
                                      #   "tput" for throughput, in bytes per second (PortMetrics only)
  [--file template.tmpl]              # Go template file. If not provided, built-in templates will be used based on provided parameters

display

Displays metrics of a running test as charts or a table.

otgen display
  [--mode chart|table]               # Display type to show metrics as
  [--type line]                      # Type of the chart displayed. Currently, only line charts are supported.

help

For built-in help, use

otgen run --help

version

To check otgen version you have, use

otgen version