aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYun-Chih Chen <yunchih@csie.ntu.edu.tw>2018-04-21 16:14:38 +0800
committerYunchih Chen <yunchih.cat@gmail.com>2019-03-07 15:02:17 +0800
commitaf48bcec8be1f4b0cc55ce47bd6eb7c7d977f4d1 (patch)
treec513ea284684cb824ff385fea2f92c122d820e52
parentf7074d5b66ab1872f3735eda1736e65c5cf40bc3 (diff)
downloadnfcollect-af48bcec8be1f4b0cc55ce47bd6eb7c7d977f4d1.tar
nfcollect-af48bcec8be1f4b0cc55ce47bd6eb7c7d977f4d1.tar.gz
nfcollect-af48bcec8be1f4b0cc55ce47bd6eb7c7d977f4d1.tar.bz2
nfcollect-af48bcec8be1f4b0cc55ce47bd6eb7c7d977f4d1.tar.lz
nfcollect-af48bcec8be1f4b0cc55ce47bd6eb7c7d977f4d1.tar.xz
nfcollect-af48bcec8be1f4b0cc55ce47bd6eb7c7d977f4d1.tar.zst
nfcollect-af48bcec8be1f4b0cc55ce47bd6eb7c7d977f4d1.zip
Update README.md
Elaborate on usage of storage_size flag
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7b73d31..cdd2376 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,13 @@ A full *trunk* will be committed to disk by configurable means (currently `zstd`
compression and no compression is implemented). Trunks will be stored in a
specific directory, which will be scanned by `nfextract` to extract all trunks.
-Due to communication with the kernel, **this program requires root privilege**.
+* Due to communication with the kernel, **this program requires root privilege**.
+* The maximum size of raw collection is configured by `storage_size`. When we
+ received that many packets, further packets will overwrite starting from the
+ begining, mimicing a rotation-based storage. Unfortunately, if compression is
+ enabled, the reduced size will not be reflected because currently we calculate
+ size only in term of raw size. Thus, user has to manually scale `storage_size` by
+ compression ratio of their workload.
## Dependencies Installation