File: README.html

package info (click to toggle)
flowscan 1.006-13.2
links: PTS
area: main
in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
size: 732 kB
ctags: 185
sloc: sh: 1,670; perl: 1,518; makefile: 148
file content (425 lines) | stat: -rw-r--r-- 10,249 bytes
parent folder | download | duplicates (5)
    <HTML> 
	<HEAD> 
	    <TITLE>README - information about C<FlowScan>

</TITLE> 
	</HEAD>

	<BODY>

<!-- INDEX BEGIN -->

<UL>

	<LI><A HREF="#NAME">NAME</A>
	<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
	<LI><A HREF="#Announcement">Announcement</A>
	<LI><A HREF="#Changes_in_FlowScan_1_006_since">Changes in FlowScan-1.006 (since FlowScan-1.005)</A>
	<LI><A HREF="#Availability">Availability</A>
	<LI><A HREF="#Mailing_Lists">Mailing Lists</A>
	<LI><A HREF="#FlowScan_Resources">FlowScan Resources</A>
	<LI><A HREF="#Contributors">Contributors</A>
	<LI><A HREF="#Thanks">Thanks</A>
	<LI><A HREF="#Copyright_and_Disclaimer">Copyright and Disclaimer</A>
</UL>
<!-- INDEX END -->

<HR>
<P>
<H1><A NAME="NAME">NAME

</A></H1>
README - information about <CODE>FlowScan</CODE>




<P>

<P>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION

</A></H1>
<CODE>FlowScan</CODE> is a network analysis and reporting tool. It processes IP flows recorded <CODE>cflowd</CODE>-format raw flow files and reports on what it finds.


<P>

This document is the <CODE>FlowScan</CODE>  <CODE>README</CODE> $Revision: 1.10 $, $Date: 2001/02/28 21:50:17 $.


<P>

<P>
<HR>
<H1><A NAME="Announcement">Announcement

</A></H1>
I'm pleased to announce the release of <CODE>FlowScan-1.006</CODE>.  <CODE>FlowScan</CODE>
is a tool to monitor and graph flow information from Cisco and Riverstone
routers in near real-time.


<P>

Amonst many other things, <CODE>FlowScan</CODE> can measure and graph traffic for applications such as Napster. A sample of
what FlowScan can do is at:


<P>

<PRE>   <A HREF="http://wwwstats.net.wisc.edu">http://wwwstats.net.wisc.edu</A>
</PRE>

<P>

<P>
<HR>
<H1><A NAME="Changes_in_FlowScan_1_006_since">Changes in FlowScan-1.006 (since FlowScan-1.005)

</A></H1>
<UL>
<LI><STRONG></STRONG>
The CampusIO and SubNetIO reports were enhanced with a new optional
configuration directive: <CODE>TopN</CODE>. When defined, this directive causes ``Top Talker'' reports to be
produced. These HTML reports contain the most active (i.e. ``top'') source
and destination addresses.


<P>

<LI><STRONG></STRONG>
The CampusIO and SubNetIO reports were enhanced to record the number of
local IP addresses that where active for each network and subnet into the
RRD files. This enables users to estimate the number of active hosts hosts
over time, detect ``scans'' which systematically sweep across network
address space, and to calculate the average bytes, packets, and flows per
host.


<P>

<LI><STRONG></STRONG>
The template Makefile used to produce the graphs was enhanced to allow the
inclusion of ``events'' in the graphs, similarly to what can be done with
Cricket. This allows you to label events such as configuration changes and
outages to discover correlations with traffic measurement.


<P>

<LI><STRONG></STRONG>
Two new utilities suitable for stand-alone use, are included. &lt;kbd&gt;ip2hostname&lt;/kbd&gt; converts IP addresses to their respective hostnames. &lt;kbd&gt;event2vrule&lt;/kbd&gt; adds ``events'' to <CODE>rrdtool</CODE> graphs.


<P>

<LI><STRONG></STRONG>
Added support for LFAP (Lightweight Flow Accouting Protocol) used by
Riverstone and Enterasys (formerly Cabletron) routers. This currently
requires <CODE>slate</CODE> (from <CODE>http://www.nmops.org</CODE>) and <CODE>lfapd</CODE> by Steven Premeau &lt;<A HREF="MAILTO:premeau@uwp.edu>.">premeau@uwp.edu>.</A>  <CODE>lfapd</CODE> produces time-stamped raw flow files in the same cflowd-defined format that
is processed by FlowScan.


<P>

<LI><STRONG></STRONG>
Added the ability for the <CODE>CampusIO</CODE> report to identify outbound flows based solely on the flow's destination IP
address. While this is less trustworthy than using <CODE>NextHops</CODE> or <CODE>OutputIfIndexes</CODE>, it is now the default and will be useful for environments where the flow
nexthop or output ifIndex values are not meaningful.


<P>

<LI><STRONG></STRONG>
The <CODE>CampusIO</CODE> report contains a new <STRONG>experimental</STRONG> feature which reads a BGP routing table, and therefore can determine which
Autonomous systems source, transit, or sink most of your institution's
traffic. The <CODE>CampusIO</CODE> report was enhanced with new optional configuration directives:  <CODE>BGPDumpFile</CODE>, <CODE>TopN</CODE>, <CODE>ReportPrefixFormat</CODE>. When properly defined, these directives cause <CODE>CampusIO</CODE> to create tabular HTML reports named <CODE>{origin|path}_{in|out}.html</CODE> under <CODE>OutputDir</CODE>
after analyzing each raw flow file. These reports show the ``top''
Autonomous Systems with which your site exchanges traffic.


<P>

<LI><STRONG></STRONG>
A <CODE>WebProxyIfIndex</CODE> directive was added to the <CODE>CampusIO</CODE> report. This allows one to specify the index of the interface to which HTTP
traffic is being transparently redirected. This enables <CODE>FlowScan</CODE> to properly count HTTP flows even though NetFlow v5 does not accurately
report the nexthop value for flows which are transparently redirected via a
Cisco route-map.


<P>

<LI><STRONG></STRONG>
<CODE>CampusIO</CODE> now contains a fix for a bug introduced in
<CODE>FlowScan-1.005</CODE> which would sometimes cause perl to abort with this message:


<P>

<PRE>   patricia.c:645: patricia_lookup: Assertion `prefix' failed.
</PRE>

<P>

This would happen if the <CODE>NextHops</CODE> or <CODE>LocalNextHops</CODE> were specified by name rather than IP address. It also would happen if the
boulder
<CODE>SUBNET</CODE> values were specified incorrectly.


<P>

</UL>
<P>
<HR>
<H1><A NAME="Availability">Availability

</A></H1>
FlowScan is licensed under the GNU General Public License, and is available
to you at:


<P>

<PRE>   <A HREF="http://net.doit.wisc.edu/~plonka/FlowScan/">http://net.doit.wisc.edu/~plonka/FlowScan/</A>
</PRE>

<P>

<P>
<HR>
<H1><A NAME="Mailing_Lists">Mailing Lists

</A></H1>
There are two mailing lists having to do with FlowScan:


<P>

<UL>
<LI><STRONG><A NAME="item_flowscan">flowscan

</A></STRONG>
a general mailing list for FlowScan users.


<P>

<LI><STRONG><A NAME="item_flowscan">flowscan-announce

</A></STRONG>
a <STRONG>low-volume</STRONG>, restricted post mailing list to keep FlowScan users informed of news
regarding FlowScan. 


<P>

</UL>
The lists' respective archives are available at:


<P>

<PRE>   <A HREF="http://net.doit.wisc.edu/~plonka/list/flowscan">http://net.doit.wisc.edu/~plonka/list/flowscan</A>
</PRE>

<P>

and:


<P>

<PRE>   <A HREF="http://net.doit.wisc.edu/~plonka/list/flowscan-announce">http://net.doit.wisc.edu/~plonka/list/flowscan-announce</A>
</PRE>

<P>

Announcements will be ``cross-posted'' to both lists, so there's no need to
join both.


<P>

These lists are hosted by the Division of Information Technology's Network
Engineering Technology group at the University of Wisconsin - Madison. To
subscribe to either of them, send email to:


<P>

<PRE>   majordomo@net.doit.wisc.edu
</PRE>

<P>

containing either:


<P>

<PRE>   subscribe flowscan
</PRE>

<P>

<EM>or</EM>:


<P>

<PRE>   subscribe flowscan-announce
</PRE>

<P>

You should receive an automatic response that will request that you verify
your request to become a member of the list, to which you must reply with
the authentication information there-in. Then, in response to your reply,
you should receive a welcome message. If you have any questions about the
administrative policies of this list's manager, please contact:


<P>

<PRE>   owner-flowscan@net.doit.wisc.edu
</PRE>

<P>

<EM>or</EM>:


<P>

<PRE>   owner-flowscan-announce@net.doit.wisc.edu
</PRE>

<P>

<P>
<HR>
<H1><A NAME="FlowScan_Resources">FlowScan Resources

</A></H1>
Overview:


<P>

<PRE>   <A HREF="http://www.caida.org/tools/utilities/flowscan/">http://www.caida.org/tools/utilities/flowscan/</A>
</PRE>

<P>

Paper - ``FlowScan: A Network Traffic Flow Reporting and Visualization
Tool'':


<P>

<PRE>   HTML:       <A HREF="http://net.doit.wisc.edu/~plonka/lisa/FlowScan/">http://net.doit.wisc.edu/~plonka/lisa/FlowScan/</A>
   PostScript: <A HREF="http://net.doit.wisc.edu/~plonka/lisa/FlowScan/out.ps.gz">http://net.doit.wisc.edu/~plonka/lisa/FlowScan/out.ps.gz</A>
</PRE>

<P>

<PRE>   <A HREF="http://www.caida.org/tools/utilities/flowscan/">http://www.caida.org/tools/utilities/flowscan/</A>
</PRE>

<P>

LISA XIV (New Orleans, Dec. 2000) Presentation:


<P>

<PRE>   <A HREF="http://net.doit.wisc.edu/~plonka/lisa/FlowScan/presentation/">http://net.doit.wisc.edu/~plonka/lisa/FlowScan/presentation/</A>
</PRE>

<P>

NANOG 21 (Atlanta, Feb. 2001) Presentation:


<P>

<PRE>   <A HREF="http://www.nanog.org/mtg-0102/plonka.html">http://www.nanog.org/mtg-0102/plonka.html</A>
   <A HREF="http://net.doit.wisc.edu/~plonka/nanog/">http://net.doit.wisc.edu/~plonka/nanog/</A>
</PRE>

<P>

Other:


<P>

<PRE>   <A HREF="http://wwwstats.net.wisc.edu">http://wwwstats.net.wisc.edu</A>
   <A HREF="http://net.doit.wisc.edu/data/Napster/">http://net.doit.wisc.edu/data/Napster/</A>
   <A HREF="http://net.doit.wisc.edu/data/flow/size/">http://net.doit.wisc.edu/data/flow/size/</A>
</PRE>

<P>

<P>
<HR>
<H1><A NAME="Contributors">Contributors

</A></H1>
<PRE>   Alexander Kunz &lt;Alexander.Kunz@nextra.de&gt;
   Kevin Gannon &lt;kevin@gannons.net&gt;
   John Payne &lt;john@sackheads.org&gt;
   Michael Hare &lt;Michael.Hare@doit.wisc.edu&gt;
   Steven Premeau &lt;premeau@uwp.edu&gt;
</PRE>

<P>

<P>
<HR>
<H1><A NAME="Thanks">Thanks

</A></H1>
I'd like to thank the participants in the FlowScan mailing list for their
efforts and feedback.


<P>

Also, thanks to Daniel McRobb, Tobi Oetiker, and CAIDA for providing the
main tools upon which FlowScan is built, namely ``cflowd'' and ``RRDTOOL''.


<P>

<P>
<HR>
<H1><A NAME="Copyright_and_Disclaimer">Copyright and Disclaimer

</A></H1>
Note that this document is provided `as is'. The information in it is not
warranted to be correct. Use it at your own risk.


<P>

<PRE>   Copyright (c) 2000-2001 Dave Plonka &lt;plonka@doit.wisc.edu&gt;.
   All rights reserved.
</PRE>

<P>

This document may be reproduced and distributed in its entirety (including
this authorship, copyright, and permission notice), provided that no charge
is made for the document itself.


<P>


</DL>
    </BODY>

    </HTML>