Changeset d6dc0f6 for tools/traceends


Ignore:
Timestamp:
09/09/11 11:35:01 (9 years ago)
Author:
Shane Alcock <salcock@…>
Branches:
4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, getfragoff, help, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes
Children:
fc01bee
Parents:
c29a0e0
Message:
  • Updated traceends and tracetopends manpages to be about them instead of tracesplit
  • Updated all other manpages to include new tools in their "See also" lists
  • Changed -a argument for traceends to -A to be consistent with tracetopends
Location:
tools/traceends
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • tools/traceends/traceends.1

    rc29a0e0 rd6dc0f6  
    1 .TH TRACESPLIT "1" "January 2011" "tracesplit (libtrace)" "User Commands"
     1.TH TRACEENDS "1" "September 2011" "traceends (libtrace)" "User Commands"
    22.SH NAME
    3 tracesplit \- split traces
     3traceends \- summarise traffic done by every endpoint observed in a trace
    44.SH SYNOPSIS
    5 .B tracesplit
     5.B tracetopends
    66[ \fB-f \fRbpf | \fB--filter=\fRbpf]
    7 [ \fB-c \fRcount | \fB--count=\fRcount]
    8 [ \fB-b \fRbytes | \fB--bytes=\fRbytes]
    9 [ \fB-i \fRseconds | \fB--seconds=\fRseconds]
    10 [ \fB-s \fRunixtime | \fB--starttime=\fRunixtime]
    11 [ \fB-e \fRunixtime | \fB--endtime=\fRunixtime]
    12 [ \fB-m \fRmaxfiles | \fB--maxfiles=\fRmaxfiles]
    13 [ \fB-S \fRsnaplen | \fB--snaplen=\fRsnaplen]
    14 [ \fB-z \fRlevel | \fB--compress-level=\fRlevel]
    15 [ \fB-Z \fRmethod | \fB--compress-type=\fRmethod]
    16 inputuri [inputuri ...] outputuri
     7[ \fB-a \fRaddrtype | \fB--address=\fRaddrtype]
     8[ \fB-H | \fB--help]
     9
     10inputuri [inputuri ...]
    1711.SH DESCRIPTION
    18 tracesplit splits the given input traces into multiple tracefiles
     12traceends reports the number of bytes and packets sent and received by each
     13endpoint observed in the input trace(s). Usually, you don't want to run this
     14program directly \-\- see \fBtracetopends\fR instead.
     15
    1916.TP
    2017\fB\-f\fR bpf filter
     
    2219
    2320.TP
    24 \fB\-c\fR count
    25 output count packets per output file.  The output file will be named after
    26 the basename given in the outputuri with the packet number of the first packet
    27 in this file.
     21\fB\-A\fR address type
     22Specifies how an endpoint should be defined. Suitable options are "mac", "v4"
     23and "v6" which will report endpoint stats for each observed MAC address, IPv4
     24address and IPv6 address respectively.
    2825
    29 .TP
    30 \fB\-b\fR bytes
    31 output bytes bytes per file
     26.SH OUTPUT
     27Output is written to stdout in columns separated by blank space.
    3228
    33 .TP
    34 \fB\-i\fR seconds
    35 start a new tracefile after "seconds" seconds
    36 
    37 .TP
    38 \fB\-s\fR unixtime
    39 don't output any packets before unixtime
    40 
    41 .TP
    42 \fB\-e\fR unixtime
    43 don't output any packets after unixtime
    44 
    45 .TP
    46 \fB\-m\fR maxfiles
    47 do not create more than "maxfiles" trace files
    48 
    49 .TP
    50 \fB\-S\fR snaplen
    51 Truncate packets to "snaplen" bytes long.  The default is collect the entire
    52 packet.
    53 
    54 .TP
    55 \fB\-z\fR level
    56 Compress the data using the specified compression level, ranging from 0 to 9.
    57 Higher compression levels tend to result in better compression but require
    58 more processing power to compress.
    59 
    60 .TP
    61 \fB-Z\fR compression-method
    62 Compress the data using the specified compression algorithm. Accepted methods
    63 are "gzip", "bzip2", "lzo" or "none". Default value is none unless a
    64 compression level is specified, in which case gzip will be used.
     29The columns are (in order):
     30 * Endpoint address
     31 * Time last observed
     32 * Packets originating from the endpoint
     33 * Bytes originating from the endpoint (IP header onwards)
     34 * Payload originating from the endpoint (post transport header)
     35 * Packets sent to the endpoint
     36 * Bytes sent to the endpoint (IP header onwards)
     37 * Payload sent to the endpoint (post transport header)
    6538
    6639.SH EXAMPLES
    67 create a 1MB erf trace of port 80 traffic.
     40Get stats for each individual MAC address in a trace:
    6841.nf
    69 tracesplit \-z 1 -Z gzip \-f 'port 80' \-b $[ 1024 * 1024 ]
    70 erf:/traces/bigtrace.gz erf:/traces/port80.gz
     42traceends -a mac erf:trace.erf.gz
    7143.fi
    7244
    7345.SH LINKS
    74 More details about tracesplit (and libtrace) can be found at
     46More details about traceends (and libtrace) can be found at
    7547http://www.wand.net.nz/trac/libtrace/wiki/UserDocumentation
    7648
     
    7850libtrace(3), tracemerge(1), tracefilter(1), traceconvert(1), tracesplit_dir(1),
    7951tracereport(1), tracertstats(1), tracestats(1), tracepktdump(1), traceanon(1),
    80 tracesummary(1), tracereplay(1), tracediff(1)
     52tracesummary(1), tracereplay(1), tracediff(1), tracetopends(1)
    8153
    8254.SH AUTHORS
    83 Perry Lorier <perry@cs.waikato.ac.nz>
     55Shane Alcock <salcock@cs.waikato.ac.nz>
  • tools/traceends/traceends.cc

    rc29a0e0 rd6dc0f6  
    6969        "%s flags inputuri [inputuri ... ] \n"
    7070        "-f --filter=bpf        Only output packets that match filter\n"
    71         "-H --libtrace-help     Print libtrace runtime documentation\n"
    72         "-a --address           Specifies which address type to match (mac, v4, v6)\n"
     71        "-H --help              Print this message\n"
     72        "-A --address           Specifies which address type to match (mac, v4, v6)\n"
    7373        ,argv0);
    7474        exit(1);
     
    360360                struct option long_options[] = {
    361361                        { "filter",        1, 0, 'f' },
    362                         { "libtrace-help", 0, 0, 'H' },
    363                         { "addresses",     1, 0, 'a' },
     362                        { "help",          0, 0, 'H' },
     363                        { "addresses",     1, 0, 'A' },
    364364                        { NULL,            0, 0, 0   },
    365365                };
    366366
    367                 int c=getopt_long(argc, argv, "a:f:H",
     367                int c=getopt_long(argc, argv, "A:f:H",
    368368                                long_options, &option_index);
    369369
     
    371371                        break;
    372372                switch (c) {
    373                         case 'a':
     373                        case 'A':
    374374                                if (strncmp(optarg, "mac", 3) == 0)
    375375                                        mode = MODE_MAC;
    376                                 if (strncmp(optarg, "v4", 2) == 0)
     376                                else if (strncmp(optarg, "v4", 2) == 0)
    377377                                        mode = MODE_IPV4;
    378                                 if (strncmp(optarg, "v6", 2) == 0)
     378                                else if (strncmp(optarg, "v6", 2) == 0)
    379379                                        mode = MODE_IPV6;
     380                                else {
     381                                        fprintf(stderr, "Invalid address type, must be either mac, v4 or v6\n");
     382                                        return 1;
     383                                }
    380384                                break;
    381385
  • tools/traceends/tracetopends

    rc29a0e0 rd6dc0f6  
    113113
    114114if [ "$filter" = "" ]; then
    115         traceends -a $addr $@ | { trap '' int; sort -n -k $sort_index -r -s; } | { trap '' int; head -n $top_count; }
     115        traceends -A $addr $@ | { trap '' int; sort -n -k $sort_index -r -s; } | { trap '' int; head -n $top_count; }
    116116else
    117         traceends -a $addr -f "$filter" $@  | { trap '' int; sort -n -k $sort_index -r -s; } | { trap '' int; head -n $top_count; }
     117        traceends -A $addr -f "$filter" $@  | { trap '' int; sort -n -k $sort_index -r -s; } | { trap '' int; head -n $top_count; }
    118118fi
    119119
  • tools/traceends/tracetopends.1

    rc29a0e0 rd6dc0f6  
    1 .TH TRACESPLIT "1" "January 2011" "tracesplit (libtrace)" "User Commands"
     1.TH TRACETOPENDS "1" "September 2011" "tracetopends (libtrace)" "User Commands"
    22.SH NAME
    3 tracesplit \- split traces
     3tracetopends \- reports the endpoints that are responsible for the most traffic
     4in a trace
    45.SH SYNOPSIS
    5 .B tracesplit
    6 [ \fB-f \fRbpf | \fB--filter=\fRbpf]
    7 [ \fB-c \fRcount | \fB--count=\fRcount]
    8 [ \fB-b \fRbytes | \fB--bytes=\fRbytes]
    9 [ \fB-i \fRseconds | \fB--seconds=\fRseconds]
    10 [ \fB-s \fRunixtime | \fB--starttime=\fRunixtime]
    11 [ \fB-e \fRunixtime | \fB--endtime=\fRunixtime]
    12 [ \fB-m \fRmaxfiles | \fB--maxfiles=\fRmaxfiles]
    13 [ \fB-S \fRsnaplen | \fB--snaplen=\fRsnaplen]
    14 [ \fB-z \fRlevel | \fB--compress-level=\fRlevel]
    15 [ \fB-Z \fRmethod | \fB--compress-type=\fRmethod]
    16 inputuri [inputuri ...] outputuri
     6.B tracetopends
     7[ \fB-f \fRbpf ]
     8[ \fB-A \fRaddrtype ]
     9[ \fB-s ]
     10[ \fB-d ]
     11[ \fB-b ]
     12[ \fB-a ]
     13[ \fB-p ]
     14[ \fB-n \fRtopcount ]
     15inputuri [inputuri ...]
    1716.SH DESCRIPTION
    18 tracesplit splits the given input traces into multiple tracefiles
     17tracetopends reports the number of bytes and packets sent and received by the
     18busiest endpoints observed in the input trace(s).
     19
    1920.TP
    2021\fB\-f\fR bpf filter
    21 output only packets that match tcpdump style bpf filter
     22Output only packets that match tcpdump style bpf filter.
    2223
    2324.TP
    24 \fB\-c\fR count
    25 output count packets per output file.  The output file will be named after
    26 the basename given in the outputuri with the packet number of the first packet
    27 in this file.
     25\fB\-n\fR top count
     26Report the top N endpoints (defaults to 10).
    2827
    2928.TP
    30 \fB\-b\fR bytes
    31 output bytes bytes per file
     29\fB\-A\fR address type
     30Specifies how an endpoint should be defined. Suitable options are "mac", "v4"
     31and "v6" which will report endpoint stats for each observed MAC address, IPv4
     32address and IPv6 address respectively.
    3233
    3334.TP
    34 \fB\-i\fR seconds
    35 start a new tracefile after "seconds" seconds
     35\fB\-s
     36Sort endpoints based on the amount of outgoing traffic (will cancel any
     37previous \-d option. This is on by default.
    3638
    3739.TP
    38 \fB\-s\fR unixtime
    39 don't output any packets before unixtime
     40\fB\-d
     41Sort endpoints based on the amount of incoming traffic (will cancel any
     42previous \-s option.
    4043
    4144.TP
    42 \fB\-e\fR unixtime
    43 don't output any packets after unixtime
     45\fB\-b
     46Sort endpoints based on the amount of IP traffic (will cancel any previous
     47\-a or \-p options. This is on by default.
    4448
    4549.TP
    46 \fB\-m\fR maxfiles
    47 do not create more than "maxfiles" trace files
     50\fB\-a
     51Sort endpoints based on the amount of application layer traffic (will cancel
     52any previous \-b or \-p options.
    4853
    4954.TP
    50 \fB\-S\fR snaplen
    51 Truncate packets to "snaplen" bytes long.  The default is collect the entire
    52 packet.
     55\fB\-p
     56Sort endpoints based on the amount of packets (will cancel any previous
     57\-b or \-a options.
    5358
    54 .TP
    55 \fB\-z\fR level
    56 Compress the data using the specified compression level, ranging from 0 to 9.
    57 Higher compression levels tend to result in better compression but require
    58 more processing power to compress.
     59.SH OUTPUT
     60Output is written to stdout in columns separated by blank space.
    5961
    60 .TP
    61 \fB-Z\fR compression-method
    62 Compress the data using the specified compression algorithm. Accepted methods
    63 are "gzip", "bzip2", "lzo" or "none". Default value is none unless a
    64 compression level is specified, in which case gzip will be used.
     62The columns are (in order):
     63 * Endpoint address
     64 * Time last observed
     65 * Packets originating from the endpoint
     66 * Bytes originating from the endpoint (IP header onwards)
     67 * Payload originating from the endpoint (post transport header)
     68 * Packets sent to the endpoint
     69 * Bytes sent to the endpoint (IP header onwards)
     70 * Payload sent to the endpoint (post transport header)
    6571
    6672.SH EXAMPLES
    67 create a 1MB erf trace of port 80 traffic.
     73Find the IPv4 addresses that are sending the most traffic.
    6874.nf
    69 tracesplit \-z 1 -Z gzip \-f 'port 80' \-b $[ 1024 * 1024 ]
    70 erf:/traces/bigtrace.gz erf:/traces/port80.gz
     75tracetopends -A v4 -b -s erf:trace.erf.gz
    7176.fi
    7277
    7378.SH LINKS
    74 More details about tracesplit (and libtrace) can be found at
     79More details about tracetopends (and libtrace) can be found at
    7580http://www.wand.net.nz/trac/libtrace/wiki/UserDocumentation
    7681
     
    7883libtrace(3), tracemerge(1), tracefilter(1), traceconvert(1), tracesplit_dir(1),
    7984tracereport(1), tracertstats(1), tracestats(1), tracepktdump(1), traceanon(1),
    80 tracesummary(1), tracereplay(1), tracediff(1)
     85tracesummary(1), tracereplay(1), tracediff(1), traceends(1)
    8186
    8287.SH AUTHORS
    83 Perry Lorier <perry@cs.waikato.ac.nz>
     88Shane Alcock <salcock@cs.waikato.ac.nz>
Note: See TracChangeset for help on using the changeset viewer.