statsd-tg(1): Add manpage.
[statsd-tg.git] / README
1  statsd-tg – StatsD traffig generator
2 ══════════════════════════════════════
3 http://octo.it/statsd-tg
4
5 About
6 ━━━━━
7
8   statsd-tg is a traffic generator for StatsD. It generates dummy traffic that
9   can be used to stress-test / benchmark StatsD implementations and possibly
10   perform profiling.
11
12
13 Operation
14 ━━━━━━━━━
15
16   statsd-tg generates a set of dummy counters, timers, gauges and sets. The
17   number of each type of event can be configured using command line switches.
18   It then randomly triggers these events using a PRNG which distributes these
19   events uniformly. This means that if you configure 50 counters, 30 timers,
20   15 gauges and 5 sets, counters should make up aproximately half of the
21   generated traffic, timers 30%, gauges 15% and sets 5%.
22
23
24 Licensing terms
25 ━━━━━━━━━━━━━━━
26
27   statsd-tg is licensed under the “GNU General Public License” (GPL),
28   version 2. The exact licensing terms can be found in the file
29   “COPYING” included in the source distribution of statsd-tg.
30
31
32 Author
33 ━━━━━━
34
35   Florian “octo” Forster <ff at octo.it>
36