-
Notifications
You must be signed in to change notification settings - Fork 37
/
Copy pathipfixcol-fastbit-output.dbk
452 lines (445 loc) · 13.1 KB
/
ipfixcol-fastbit-output.dbk
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
<?xml version="1.0" encoding="utf-8"?>
<refentry
xmlns:db="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.w3.org/1999/xlink http://docbook.org/xml/5.0/xsd/xlink.xsd
http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
version="5.0" xml:lang="en">
<info>
<copyright>
<year>2008-2015</year>
<holder>CESNET, z.s.p.o.</holder>
</copyright>
<date>13 April 2012</date>
<authorgroup>
<author>
<personname>
<firstname>Petr</firstname>
<surname>Kramolis</surname>
</personname>
<email>[email protected]</email>
<contrib>developer</contrib>
</author>
</authorgroup>
<orgname>The Liberouter Project</orgname>
</info>
<refmeta>
<refentrytitle>ipfixcol-fastbit-output</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo otherclass="manual" class="manual">FastBit output plugin for IPFIXcol.</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ipfixcol-fastbit-output</refname>
<refpurpose>FastBit output plugin for IPFIXcol.</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<simpara>
The <command>ipfixcol-fastbit-output.so</command> is output plugin for ipfixcol (ipfix collector).
The plugin uses FastBit library to store and index data.
</simpara>
</refsect1>
<refsect1>
<title>Configuration</title>
<simpara>The collector must be configured to use fastbit output plugin in startup.xml configuration (<filename>/etc/ipfixcol/startup.xml</filename>).
The configuration specifies which plugins (destinations) are used by the collector to store data and provides configuration for the plugins themselves.
</simpara>
<simpara><filename>startup.xml</filename> fastbit example</simpara>
<programlisting>
<![CDATA[
<destination>
<name>store data records in FastBit database</name>
<fileWriter>
<fileFormat>fastbit</fileFormat>
<path>storagePath/%o/%Y/%m/%d/</path>
<dumpInterval>
<timeWindow>300</timeWindow>
<timeAlignment>yes</timeAlignment>
<recordLimit>no</recordLimit>
<bufferSize>50000</bufferSize>
</dumpInterval>
<namingStrategy>
<type>time</type>
<prefix>ic</prefix>
</namingStrategy>
<onTheFlyIndexes>yes</onTheFlyIndexes>
<createSpFiles>no</createSpFiles>
<reorder>no</reorder>
<indexes>
<element enterprise = "0" id = "12"/>
<element enterprise = "0" id = "8"/>
<element id = "4"/>
</indexes>
</fileWriter>
</destination>
]]>
</programlisting>
<para>
<variablelist>
<varlistentry>
<term>
<command>path</command>
</term>
<listitem>
<simpara>the path element specifies storage directory for data
collected by fastbit plugin. Path can contain
format tokens for day, month, obervation ID etc. This allows you to
create directory hierarchy basedon format tokens.
</simpara>
<variablelist>
<varlistentry>
<term>
<command>%a</command>
</term>
<listitem>
<simpara>Abbreviated weekday name (local-depended). Example: Thu
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%A</command>
</term>
<listitem>
<simpara>Full weekday name (local-depended). Example: Thursday
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%b</command>
</term>
<listitem>
<simpara>Abbreviated month name (local-depended). Example: Aug
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%B</command>
</term>
<listitem>
<simpara>Full month name (local-depended). Example: August
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%c</command>
</term>
<listitem>
<simpara>Date and time representation (local-depended). Example:
Thu Aug 23 14:55:02 2001</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%d</command>
</term>
<listitem>
<simpara>Day of the month (01-31). Example: 23</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%e</command>
</term>
<listitem>
<simpara>Day of the month, space-padded. Example: 1</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%E</command>
</term>
<listitem>
<simpara>Exporter IP address (IPv6), in non-canonical form. Example: 00000000000000000000ffffc0a80064</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%H</command>
</term>
<listitem>
<simpara>Hour in 24h format (00-23). Example: 14</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%I</command>
</term>
<listitem>
<simpara>Hour in 12h format (01-12). Example: 02</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%j</command>
</term>
<listitem>
<simpara>Day of the year (001-366). Example: 235</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%m</command>
</term>
<listitem>
<simpara>Month as a decimal number (01-12). Example: 08
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%M</command>
</term>
<listitem>
<simpara>Minute (00-59). Example: 55</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%o</command>
</term>
<listitem>
<simpara>Observation Domain ID. Example: 1</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%p</command>
</term>
<listitem>
<simpara>AM or PM designation. Example: PM</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%S</command>
</term>
<listitem>
<simpara>Second (00-61). Example: 02</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%U</command>
</term>
<listitem>
<simpara>Week number with the first Sunday as the first day of
week one (00-53). Example: 33</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%w</command>
</term>
<listitem>
<simpara>Weekday as a decimal number with Sunday as 0 (0-6).
Example: 4</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%W</command>
</term>
<listitem>
<simpara>Week number with the first Monday as the first day of
week one (00-53). Example: 34</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%x</command>
</term>
<listitem>
<simpara>Date representation (local-depended). Example: '08/23/01'. This creates 3 subdirectories.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%X</command>
</term>
<listitem>
<simpara>Time representation (local-depended). Example: 14:55:02</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%y</command>
</term>
<listitem>
<simpara>Year, last two digits (00-99). Example: 01</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%Y</command>
</term>
<listitem>
<simpara>Year. Example: 2001</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%Z</command>
</term>
<listitem>
<simpara>Timezone name or abbreviation. Example: CDT</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>%%</command>
</term>
<listitem>
<simpara>A % sign. Example: %</simpara>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>dumpInterval - timeWindow</command>
</term>
<listitem>
<simpara>timeWindow is interval for rotation of data storage
direcotry (seconds)</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>dumpInterval - timeAlignment</command>
</term>
<listitem>
<simpara>Align flush time according to timeWindow. For example when
is collector started at 12:43 with 5 min
timeWindow than next flush time is 12:48 but with alignment next flush time
is 12:45. (yes/no)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>dumpInterval - recordLimit</command>
</term>
<listitem>
<simpara>this preventing data storage direcotry to become too huge
when is fastbit plugin used for parsing offline data (yes/no)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>dumpInterval - bufferSize</command>
</term>
<listitem>
<simpara>Specifies how many elements can be stored in buffer per row.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>namingStrategy - type</command>
</term>
<listitem>
<simpara>Specifies how are asigned names to data dumps.
(time/incremental/prefix)</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>namingStrategy - prefix</command>
</term>
<listitem>
<simpara>Specifies prefix to data dumps names.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>onTheFlyIndexes</command>
</term>
<listitem>
<simpara>This tells plugin to create indexes for stored data
(yes/no). Elements for indexing can be specified so indexes are build only for those elements
(see example startup.xml in this manpage). If there are no specified elements and
<command>onTheFlyIndexes</command> is set to "yes" than indexes are built for ALL elements</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>createSpFiles (no)</command>
</term>
<listitem>
<simpara>If enabled, the plugin will create .sp files for TEXT columns. These columns are typically created on-the-fly when performing queries on TEXT columns. However, under certain circumstances, like read-only file systems, these files may not be created on-the-fly. If this setting is set to "yes", the required .sp files are created as soon as the data is stored.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>useTemplateFieldLengths (yes)</command>
</term>
<listitem>
<simpara>If enabled, the plugin will store the data in columns based on the field lengths indicated in IPFIX templates. Otherwise, the columns are based on field lengths implied by the IPFIX field specification in ipfix-elements.xml.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>reorder</command>
</term>
<listitem>
<simpara>This tells plugin to reorder for stored data (yes/no).
Reorder is based on cardinality so queries on reordered data should
be faster and data indexes smaller. </simpara>
<simpara>Warning: Reordering does not work on string and blob columns.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para></para>
<para>
<variablelist>
<varlistentry>
<term>
<citerefentry><refentrytitle>ipfixcol</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<citerefentry><refentrytitle>ipfixcol-filter-inter</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<citerefentry><refentrytitle>ipfixcol-joinflows-inter</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<citerefentry><refentrytitle>ipfixcol-forwarding-output</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</term>
<listitem>
<simpara>Man pages</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<link xlink:href="http://www.liberouter.org/technologies/ipfixcol/">http://www.liberouter.org/technologies/ipfixcol/</link>
</term>
<listitem>
<para>IPFIXcol Project Homepage</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<link xlink:href="http://www.liberouter.org">http://www.liberouter.org</link>
</term>
<listitem>
<para>Liberouter web page</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<email>[email protected]</email>
</term>
<listitem>
<para>Support mailing list</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>