Merge pull request #829 from njh/cpu_state
[collectd.git] / src / collectd-tg.pod
1 =encoding UTF-8
2
3 =head1 NAME
4
5 collectd-tg - Traffic generator for collectd.
6
7 =head1 SYNOPSIS
8
9 collectd-tg B<-n> I<num_vl> B<-H> I<num_hosts> B<-p> I<num_plugins> B<-i> I<interval> B<-d> I<dest> B<-D> I<dport>
10
11 =head1 DESCRIPTION
12
13 B<collectd-tg> generates bogus I<collectd> network traffic. While host, plugin
14 and values are generated randomly, the generated traffic tries to mimic "real"
15 traffic as closely as possible.
16
17 =head1 ARGUMENTS AND OPTIONS
18
19 The following options are understood by I<collectd-tg>. The order of the
20 arguments generally doesn't matter, as long as no argument is passed more than
21 once.
22
23 =over 4
24
25 =item B<-n> I<num_vl>
26
27 Sets the number of unique I<value lists> (VL) to generate. Defaults to 10000.
28
29 =item B<-H> I<num_hosts>
30
31 Sets the number of unique hosts to simulate. Defaults to 1000.
32
33 =item B<-p> I<num_plugins>
34
35 Sets the number of unique plugins to simulate. Defaults to 20.
36
37 =item B<-i> I<interval>
38
39 Sets the interval in which each I<value list> is dispatched. Defaults to 10.0
40 seconds.
41
42 =item B<-d> I<dest>
43
44 Sets the destination to which to send the generated network traffic. Defaults
45 to the IPv6 multicast address, C<ff18::efc0:4a42>.
46
47 =item B<-D> I<dport>
48
49 Sets the destination port or service to which to send the generated network
50 traffic. Defaults to I<collectd's> default port, C<25826>.
51
52 =item B<-h>
53
54 Print usage summary.
55
56 =back
57
58 =head1 SEE ALSO
59
60 L<collectd(1)>,
61 L<collectd.conf(5)>
62
63 =head1 AUTHOR
64
65 Florian Forster E<lt>octoE<nbsp>atE<nbsp>collectd.orgE<gt>
66
67 =cut