upd: updated docs for multidest and other options

circonus-labs · Jan 8, 2021 · 7149234 · 7149234
1 parent 1d31c48
commit 7149234
Showing 1 changed file with 25 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -2,55 +2,52 @@
 
 [![Go Report Card](https://goreportcard.com/badge/github.com/circonus-labs/gen-statsd)](https://goreportcard.com/report/github.com/circonus-labs/gen-statsd)
 
-gen-statsd is an experimental tool written in Go for load testing with StatsD metrics.
+gen-statsd is an experimental tool written in Go for load and signal testing with StatsD metrics.
 
 ## Configuration
 
 ### Command-line Flags
 
 ```
-  Usage of gen-statsd:
-  -agents int
-        max number of agents to run concurrently (default 10)
-  -counters int
-        number of counters for each agent to hold (default 50)
-  -flush-interval duration
-        how often to flush metrics (default 10s)
-  -gauges int
-        number of gauges for each agent to hold (default 30)
-  -prefix string
-        prefix for metrics (default "gen-statsd")
-  -protocol string
-        network protocol to use, tcp or udp (default "udp")
-  -spawn-drift int
-        spread new agent generation by 0-n seconds (default 10)
-  -statsd-host string
-        address of statsD host (default "localhost:8125")
-  -tag-format string
-        format of the tags to send. accepted values "datadog" or "influx"
-  -tags string
-        list of K:V comma separated tags. Example: key1:tag1,key2:tag2
-  -timers int
-        number of timers for each agent to hold (default 20)
-  -version
-        show version information
+Usage of gen-statsd:
+  -agents=10: max number of agents to run concurrently
+  -config="": path to config file
+  -counters=50: number of counters for each agent to hold
+  -flush-interval=10s: how often to flush metrics
+  -gauges=30: number of gauges for each agent to hold
+  -prefix="gen-statsd": prefix for metrics
+  -run-time=0s: how long to run, 0=forever
+  -sample-rate=0: sampling rate
+  -spawn-drift=10: spread new agent generation by 0-n seconds
+  -statsd-host="localhost:8125:udp": comma separated list of ip:port:proto for statsD host(s)
+  -tag-format="": format of the tags to send. accepted values "datadog" or "influx"
+  -tags="": list of K:V comma separated tags. Example: key1:tag1,key2:tag2
+  -timer-samples=10: number of timer samples per iteration
+  -timers=20: number of timers for each agent to hold
+  -value-max=100: maximum value
+  -value-min=0: minimum value
+  -version=false: show version information
 ```
 
 ### Environment Variables
 
   | Variable      |                       Description                               |
   |:-------------:|:----------------------------------------------------------------|
   |AGENTS         |max number of agents to run concurrently (default 10)            |
+  |CONFIG         |path to config file                                              |
   |COUNTERS       |number of counters for each agent to hold (default 50)           |
   |FLUSH_INTERVAL |how often to flush metrics (default 10s)                         |
   |GAUGES         |number of gauges for each agent to hold (default 30)             |
   |PREFIX         |prefix for metrics (default "gen-statsd")                        |
-  |PROTOCOL       |network protocol to use, tcp or udp (default "udp")              |
+  |RUN_TIME       |how long to run, 0=forever                                       |
+  |SAMPLE_RATE    |sampling rate (default 0)                                        |
   |SPAWN_DRIFT    |spread new agent generation by 0-n seconds (default 10)          |
-  |STATSD_HOST    |address of statsD host (default "localhost:8125")                |
+  |STATSD_HOST    |comma separated list of ip:port:proto for statsD host(s)         |
   |TAG_FORMAT     |format of the tags to send. accepted values "datadog" or "influx |
   |TAGS           |list of K:V comma separated tags. Example: key1:tag1,key2:tag2   |
   |TIMERS         |number of timers for each agent to hold (default 20)             |
+  |VALUE_MAX      |maximum value to send (default 100)                              |
+  |VALUE_MIN      |minimum value to send (default 0)                                |
   |VERSION        |show version information                                         |
 
 ## Releases