File: templates

package info (click to toggle)
trafstats 0.4.20-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 296 kB
  • ctags: 110
  • sloc: cpp: 1,036; sh: 475; perl: 173; makefile: 98
file content (215 lines) | stat: -rw-r--r-- 8,150 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
Template: trafstats/user
Type: string
Default: accountant
Description: Placeholder for changed config variable
 This variable has been renamed to "dbwriter" -- If you still encounter
 this question while configuring, report it as a bug. 

Template: trafstats/startonboot
Type: boolean
Default: true
Description: Start trafstats on boot?
 If for example the connection you wish to monitor by default is not always 
 up (for example, a dial-up connection), starting trafstats on boot is not 
 viable. You will have to start it manually.

Template: trafstats/castrate
Type: boolean
Default: false
Description: Run in limited mode?
 Large networks with a lot of traffic may experience database size problems 
 due to high numbers of separate sessions. In order to partially stem this
 I can ignore port numbers when storing data.
 This can reduce the amount of entries by a large factor, in favorable 
 circumstances, but will also reduce the detail level visible on your system.

Template: trafstats/interface
Type: select
Choices: ${devices}
Description: Search traffic statistics on what interface?
 Due to its programming, trafstats will operate on only one interface at 
 a time, or 'any' for all interfaces. Multiple (but not all) interfaces is
 less trivial than the author feels like implementing right now.

Template: trafstats/nosuchinterface
Type: note
Description: Specified interface not found.
 The interface you specified during configuration does not exist. Please 
 enter a valid interface.

Template: trafstats/storage-delay
Type: string
Default: 3600
Description: Database update interval in seconds?
 In order to reduce database workload, gathered statistics are only stored
 periodically. Especially on larger networks a too short delay can result in
 overburdening the database, bogging down query response times.
 .
 Please note that a longer delay does NOT mean less granularity; this is 
 handled by the timestamp delay.

Template: trafstats/timestamp-delay
Type: string
Default: 900
Description: Timestamp update interval in seconds?
 Trafstats stores all data keyed to a timestamp. Specify the time between 
 updates to it here.
 .
 NOTE: You may not set the storage interval shorter than the timestamp 
 interval.

Template: trafstats/timestore-warn
Type: note
Description: Storage interval smaller than timestamp
 The desired storage delay (${sdelay} seconds) is less than the specified
 timestamp interval (${tdelay} seconds). For various sanity reasons, this is
 not supported and will result in the storage delay being increased to
 match the timestamp interval. 

Template: trafstats/dbname
Type: string
Default: trafstats
Description: What database does trafstats need to connect to?

Template: trafstats/writer
Type: string
Default: accountant
Description: What username does trafstats contact the database under?
 trafstats stores its gathered accounting data into a database. For security
 reasons, the userID that has permission to store the data is not the same as
 the one that has the permission to read it.
 .
 This is the username under which trafstats will store the information.
 .
 It's currently not possible to automatically create the required users, so
 you'll have to run the following postgreSQL command as the superuser in the 
 database after creating a user:
 .
 GRANT SELECT ON rawtraffic TO foo
 .
 where "foo" is the name of the user you create.
 Also note that you have to edit /etc/postgresql/pg_hba.conf and 
 /etc/postgresql/pg_ident.conf to allow root to log into ${tsdbname}
 as that user.
 This is done with the following line in pg_ident.conf:
 trafstats         root    foo 
 and in pg_hba.conf:
 local           ${tsdbname}                         peer trafstats 

Template: trafstats/reader
Type: string
Default: accountreader
Description: What userID will have read access to the traffic database?
 trafstats stores its gathered accounting data into a database. For security
 reasons, the userID that has permission to store the data is not the same as
 the one that has the permission to read it.
 .
 This is the username which you will be able to use to retrieve the traffic
 data. It does not need -- and for security reasons should not have -- write 
 access to the database. 
 .
 It's currently not possible to automatically create the required users, so
 you'll have to run the following postgreSQL command as the superuser in the 
 database after creating a user:
 .
 GRANT SELECT ON rawtraffic TO foo
 .
 where "foo" is the name of the user you create.
 Also note that you have to edit /etc/postgresql/pg_hba.conf and 
 /etc/postgresql/pg_ident.conf to allow root to log into ${tsdbname}
 as that user.
 This is done with the following line in pg_ident.conf:
 trafstats         root    foo 
 and in pg_hba.conf:
 local           ${tsdbname}                         peer trafstats 


Template: trafstats/createdatabase
Type: boolean
Default: false
Description: create trafstats database if 
 If ${database} is not found on your system, shall I create it 
 and the required tables automatically?
 .
 NOTE: This will also automatically add the required permissions to the
 specified users (SELECT for ${dbreader} and INSERT for ${dbwriter}.
 .
 NOTE #2: This doesn't work yet.

Template: trafstats/verbosity
Type: select
Choices: none, critical, warnings, notices, info, debugging, insane
Default: notices
Description: Log how much data:
 Specify the lowest priority information you want trafstats to log
 to syslogd. The lower, the more verbose. 
 .
 WARNING: anything more verbose than 'info' is not recommended for production.
 Anything more verbose than 'debug' is not recommended for anything other than
 extreme debugging purposes. Ignoring critical messages means you won't be 
 informed if the program exits. 

Template: trafstats/overwrite
Type: boolean
Default: true
Description: Overwrite /etc/trafstats/trafstats.conf?
 Normally, trafstats regenerates /etc/trafstats/trafstats.conf from scratch 
 each time the package is upgraded. If you want to modify it further by hand,
 you should say "no" here.

Template: trafstats/erasedb
Type: boolean
Default: true
Description: Erase traffic statistics database when purging?
 If you select "Yes" here, the databases created by trafstats as well
 as all data contained therein will be erased when the package is 
 purged.
 .
 Or you can select "No" here and do it manually later on.

Template: trafstats/eraseusers
Type: boolean
Default: true
Description: Delete users associated with trafstats?
 Selecting "Yes" here will delete the user records associated with 
 ${dbwriter} and ${dbreader}

Template: trafstats/areyoucrazy
Type: note
Description: ARE YOU CRAZY???
 You have selected 'insane' amounts of logging. Anyone can now kill this 
 system with a simple ping -f unless you don't log daemon.debug syslog output 
 to anywhere -- which would defeat the point of enabling this option in the 
 first place.
 .
 I really, REALLY hope you know what you're doing, but on your head be it.
 .
 If you come to your senses at any time, edit /etc/trafstats.conf and 
 change VERBOSITY to something below 10.

Template: trafstats/recipients
Type: string
Default: 
Description: Who need to receive a daily report of bandwidth usage?
 trafstats comes with a report script that generates statistics over a 
 specified month. It also provides cron scripts to do this automagically 
 on a daily basis and mail the reports to a given set of adresses. 
 .
 If you don't want this to happen, leave this blank. This won't break 
 anything, but you'll have to generate and read those reports manually.

Template: trafstats/createuser
Type: boolean
Default: false
Description: Create user ${user} if not found?
 Because of circumstances, trafstats can not at this point be certain whether 
 or not ${user} already exists in the database. Would you like it to be 
 created if it turns out not to be?

Template: trafstats/nodaemon
Type: boolean
Default: false
Description: Force trafstats into foreground?
 In some situations it may be preferable to not run trafstats in the 
 background. Say 'yes' here to make --nodaemon default behavior.