~ubuntu-branches/ubuntu/dapper/flow-tools/dapper

« back to all changes in this revision

Viewing changes to docs/flow-log2rrd.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Radu Spineanu
  • Date: 2005-06-02 20:12:57 UTC
  • mfrom: (1.1.1 upstream) (2.1.1 sarge)
  • Revision ID: james.westby@ubuntu.com-20050602201257-jv0qdk3hjhpdf04b
Tags: 1:0.68-2
Fixed a bashism in init script (closes: #311568)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
 
2
<refentry>
 
3
 
 
4
<refmeta>
 
5
<refentrytitle>
 
6
<application>flow-log2rrd</application>
 
7
</refentrytitle>
 
8
<manvolnum>1</manvolnum>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>
 
13
<application>flow-log2rrd</application>
 
14
</refname>
 
15
<refpurpose>
 
16
Process the STAT: lines from <application>flow-capture</application> and
 
17
<application>flow-fanout</application> to RRD files.
 
18
</refpurpose>
 
19
</refnamediv>
 
20
 
 
21
<refsynopsisdiv>
 
22
<cmdsynopsis>
 
23
<command>flow-log2rrd</command>
 
24
<arg>-p<replaceable> rrd_path</replaceable></arg>
 
25
</cmdsynopsis>
 
26
</refsynopsisdiv>
 
27
 
 
28
<refsect1>
 
29
<title>DESCRIPTION</title>
 
30
<para>
 
31
The <command>flow-log2rrd</command> utility processes the STAT lines
 
32
generated by <application>flow-capture</application> and <application>
 
33
flow-fanout</application> and converts them into RRD files.  RRD's
 
34
are stored as rrd_path/capture|fanout.hostname.srcip.dstip.port.rrd.
 
35
The Datastores are flows,pkts,lost representing flows, packets, and lost
 
36
flows respectively.  Flow-fanout generates an additional DS nobufs
 
37
indicating the number of times a write() failed with ENOBUFS.
 
38
</para>
 
39
</refsect1>
 
40
 
 
41
<refsect1>
 
42
<title>OPTIONS</title>
 
43
<variablelist>
 
44
 
 
45
<varlistentry>
 
46
<term>-p<replaceable> rrd_path</replaceable></term>
 
47
<listitem>
 
48
<para>
 
49
Path to store files.
 
50
</para>
 
51
</listitem>
 
52
</varlistentry>
 
53
 
 
54
</variablelist>
 
55
</refsect1>
 
56
 
 
57
<refsect1>
 
58
<title>EXAMPLES</title>
 
59
<informalexample>
 
60
<para>
 
61
Convert flow-capture STAT lines in /var/log/netflow to RRD's in /flows/rrd/.
 
62
</para>
 
63
<para>
 
64
    <command>cat /var/log/netflow | flow-rpt2rrd -p /flows/rrd</command>
 
65
</para>
 
66
</informalexample>
 
67
 
 
68
</refsect1>
 
69
 
 
70
 
 
71
<refsect1>
 
72
<title>BUGS</title>
 
73
<para>
 
74
Expects STAT lines every 5 minutes.  Hard coded to 7 days of 5 minute
 
75
averages and 365 days of 1 day averages.
 
76
</para>
 
77
</refsect1>
 
78
 
 
79
<refsect1>
 
80
<title>AUTHOR</title>
 
81
<para>
 
82
<author>
 
83
<firstname>Mark</firstname>
 
84
<surname>Fullmer</surname>
 
85
</author>
 
86
<email>maf@splintered.net</email>
 
87
</para>
 
88
</refsect1>
 
89
 
 
90
<refsect1>
 
91
<title>SEE ALSO</title>
 
92
<para>
 
93
<application>flow-tools</application>(1)
 
94
</para>
 
95
</refsect1>
 
96
 
 
97
</refentry>