src/statsd-tg.pod

   1 =encoding UTF-8
   2
   3 =head1 NAME
   4
   5 statsd-tg - Traffic generator for StatsD.
   6
   7 =head1 SYNOPSIS
   8
   9 statsd-tg B<-c> I<counters_num> B<-t> I<timers_num> B<-g> I<gauges_num>
  10 B<-s> I<sets_num> B<-S> I<set_size> B<-d> I<dest> B<-D> I<dport> B<-T> I<threads_num>
  11
  12 =head1 DESCRIPTION
  13
  14 B<statsd-tg> generates dummy I<StatsD> network traffic. The names of the
  15 metrics are pseudo-random, i.e. they should look random but two invokations
  16 with the same arguments should produce the same set of metrics. The values of
  17 these metrics and the frequency with which each metric is sent is
  18 unpredictable, though.
  19
  20 You can use the B<-c>, B<-t>, B<-g> and B<-s> options to control the number of
  21 counters, timers, gauges and sets to closely match your real traffic.
  22
  23 =head1 ARGUMENTS AND OPTIONS
  24
  25 The following options are understood by I<statsd-tg>. The order of the
  26 arguments generally doesn't matter, as long as no argument is passed more than
  27 once.
  28
  29 =over 4
  30
  31 =item B<-c> I<counters_num>
  32
  33 The number of metrics with type I<counter> to simulate. Defaults to B<1000>.
  34
  35 =item B<-t> I<timers_num>
  36
  37 The number of metrics with type I<timer> to simulate. Defaults to B<1000>.
  38
  39 =item B<-g> I<gauges_num>
  40
  41 The number of metrics with type I<gauge> to simulate. Defaults to B<100>.
  42
  43 =item B<-s> I<sets_num>
  44
  45 The number of metrics with type I<set> to simulate. Defaults to B<100>.
  46
  47 =item B<-S> I<set_size>
  48
  49 The number of unique values in each metric of type I<set>. Defaults to B<128>.
  50
  51 =item B<-d> I<dest>
  52
  53 Sets the destination to which to send the generated network traffic. Defaults
  54 to B<localhost>.
  55
  56 =item B<-D> I<dport>
  57
  58 Sets the destination port or service to which to send the generated network
  59 traffic. Defaults to I<StatsD's> default port, C<8125>.
  60
  61 =item B<-T> I<threads_num>
  62
  63 Number of threads to start to generate dummy traffic. Defaults to the number of
  64 online CPUs on your system, if it can be read. Otherwise defaults to a single
  65 thread.
  66
  67 =item B<-h>
  68
  69 Print usage summary.
  70
  71 =back
  72
  73 =head1 SEE ALSO
  74
  75 L<https://github.com/etsy/statsd/>
  76
  77 =head1 AUTHOR
  78
  79 Florian Forster E<lt>ffE<nbsp>atE<nbsp>octo.itE<gt>
  80
  81 =cut