Merge pull request #52 from CESNET/flowscatter-ng

Module flowscatter

Author: jaroslavpesek

flake.nix

@@ -28,6 +28,8 @@
             pkgs.fuse3
             pkgs.rpm
             pkgs.clang-tools
+            pkgs.editorconfig-checker
+            pkgs.doxygen
             pkgs.libmaxminddb
             netmonpkgs.packages.x86_64-linux.nemea-modules-meta
             netmonpkgs.packages.x86_64-linux.nemea-framework

modules/CMakeLists.txt

@@ -1,6 +1,7 @@
-# add_subdirectory(listDetector)
-# add_subdirectory(sampler)
-# add_subdirectory(telemetry)
-# add_subdirectory(deduplicator)
-# add_subdirectory(clickhouse)
+add_subdirectory(listDetector)
+add_subdirectory(sampler)
+add_subdirectory(telemetry)
+add_subdirectory(deduplicator)
+add_subdirectory(clickhouse)
+add_subdirectory(flowScatter)
 add_subdirectory(fieldClassifier)

modules/flowScatter/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(src)

modules/flowScatter/README.md

@@ -0,0 +1,31 @@
+# flowScatter module - README
+
+## Description
+The module performs distributing of 1 unirec interface data to `n` trap outputs
+
+## Interfaces
+- Input: 1
+- Output: `n`
+
+## Parameters
+### Common TRAP parameters
+- `-h [trap,1]`      Print help message for this module / for libtrap specific parameters.
+- `-i IFC_SPEC`      Specification of interface types and their parameters.
+- `-v`               Be verbose.
+- `-vv`              Be more verbose.
+- `-vvv`             Be even more verbose.
+
+### Module specific parameters
+- `-m, --appfs-mountpoint <path>` Path where the appFs directory will be mounted
+- `-r, --rule <string>` Decide, what fields are used to create a hash. Might be in form of rule.
+- `-c, --count <int>` Number of output interfaces.
+
+## Usage Examples
+```
+$ flowscatter -i u:trap_in,u:trap_out -r "SRC_IP,SRC_PORT" # according SRC_IP+SRC_PORT
+
+$ flowscatter -i u:trap_in,u:trap_out -r "TAG_SRC_IP:(SRC_IP)|TAG_DST_IP:(DST_IP)" # if TAG_SRC_IP is not 0, then SRC_IP else if TAG_DST_IP is no 0, then DST_IP
+
+$ flowscatter -i u:trap_in,u:trap_out -r "TAG_SRC_IP:(SRC_IP,SRC_PORT)|TAG_DST_IP:(DST_IP,DST_PORT)" # if TAG_SRC_IP is not 0, then SRC_IP+SRC_PORT, else if TAG_DST_IP is not 0, then DST_IP+DST_PORT
+
+```

modules/flowScatter/src/CMakeLists.txt

@@ -0,0 +1,17 @@
+add_executable(flowscatter
+	main.cpp
+	flowScatter.cpp
+)
+
+target_link_libraries(flowscatter PRIVATE
+	telemetry::telemetry
+	telemetry::appFs
+	common
+	unirec::unirec++
+	unirec::unirec
+	trap::trap
+	argparse
+	xxhash
+)
+
+install(TARGETS flowscatter DESTINATION ${INSTALL_DIR_BIN})